Chapter 2 Invoking DocumentIt
© National Instruments Corporation 2-5 DocumentIt User Guide
Selection Displays the complete path to the file selected in the Files
listing. Because this name is used for both the RTF file and
the documentation file, any extensions will be stripped
before creating the .rtf and source file names.
Template InformationAppendixB, Generating Documents Using FrameMaker, through
AppendixE, Generating Documents Using Micro soft Word, provide
examples of automatic documentation generation using DocumentIt
templates, as follows:
• AppendixB, Generating Documents Using FrameMaker, describes
how to generate a general purpose design document using DocumentIt
and FrameMaker templates.
• AppendixC, Generating 2167A Documents Using FrameMaker,
describes how to generate a sample design document conforming
closely with DOD-STD-2167A using DocumentIt and FrameMaker
templates.
• AppendixD, Generating 2167A Documents Using Interleaf, describes
how to generate a sample design document conforming closely with
DOD-STD-2167A using DocumentIt and Interleaf templates.
• AppendixE, Generating Documents Using Microsoft Word, describes
how to generate a sample design document using DocumentIt and
Microsoft Word templates.
• AppendixF, Generating ASCII Documents, describes how to generate
a sample design document in ASCII text file format using a
DocumentIt template.
Generating Documentation from XmathThe documentit command lets you process a model to generate design
documentation.
Two syntaxes are supported:
documentit, {model =
name1
, file =
name2
,
template=
name3
}
documentit model, {options}