Chapter 2 Invoking DocumentIt
DocumentIt User Guide 2-6 ni.com
where
name1
identifies the model to be processed for documentation
generation. The model can be either:
• A string in quotes (“”), which must be the name of a SuperBlock that
exists in the current SystemBuild Catalog. This SuperBlock is
analyzed and processed to generate documentation.
• A variable, not in quotes. Variables should be assigned to a string, the
string must be the name of a SuperBlock in the current catalog. It is
analyzed and processed to generate documentation.
Whenever a file name or other string is included in a command string, it
must be enclosed in quotes, but a variable name must not be in quotes.
name2
is the name for the generated output document file. This value must
be a string or string variable, as well. If the file =
name2
option is not
provided, documentation will be generated in the file mode1.doc.
name3
is the name of the template file used to tailor the document. This
value must be a string or string variable. If this opti on is not provided, the
template _documentit.tpl (in the directory $CASE/DIT/templates/
ascii) is used (%CASE% for Windows).
Refer to AppendixA, DocumentIt Options, for a complete list of
DocumentIt options used in the second command syntax.
Examples:
documentit "
topSB
"
The system generates a real-time file named
topSB
.rtf. It loads this file
and processes it to produce the document file. The output file name is
topSB
.doc.
documentit "
topSB
", {template="mytemplate"}
documentit, {model = "
topSB
", template = "mytemplate"}
Either syntax processes the SuperBlock
topSB
in the current catalog to
produce documentation, using the template file mytemplate. The output
file name is
topSB
.doc.