Chapter 2 Invoking DocumentIt
DocumentIt User Guide 2-2 ni.com
3. Select your options. The available options include:
Block Parameters Select the source of the %Var information:
%Vars from Xmath—uses the latest values
of the Xmath variables.
Block Defaults—uses the block’s default
values.
Typecheck If selected, the Analyzer checks for matching
data types for input and output signals.
AutoCode generates the appropriate data types
in the target language that correspond to the
SystemBuild data types. If not selected, input
and output signals and parameter data are
assumed to be FLOAT. In this case,
DocumentIt only generates the RT_FLOAT
data type for signals and data. Default = 0.
Template File Specify (or browse for) the DocumentIt
template .tpl or .dac file to be used to
format the documentation. The standard
ASCII template is used by default.
Config File An options configuration file that lists the
AUTOSTAR settings for both AutoCode and
DocumentIt. The default options file is
autostart.opt. By default, DocumentIt
first looks for a file of that name in the current
working directory; explicitly specified
DocumentIt keywords are evaluated later, and
override any options file settings.
MS Word Enable special processing for Microsoft Word
RTF file generation. This option is required if
you are using the Microsoft Word template as
described in Appendix E, Generating
Documents Using Microsoft Word.
4. Click OK and monitor the status of your document generation in the
Xmath Commands window log area.
DocumentIt displays the following message:
Documentation generation complete.
Document generated and saved in file:
block_name
.doc.
5. Open your generated document in the appropriate editor.