Editing a Documentation Command's Properties

Modify the properties of a documentation command.

Context

You can modify the following properties for a documentation command:

Convert multi-page graphics to single-page: One graphic is created per page for multi-page diagrams, and in each case one graphic is shown per page for the documentation; this means that a diagram may be split over multiple pages. You can use this option to force generation of a single graphic onto one page (this will then of course be reduced in size accordingly).
Post-processing command: A command can be set for XML and Word formats. This is automatically carried out upon documentation creation; the $(INFILE) placeholder is replaced by the name of the output file in the call arguments. This enables e.g. Word or another application to be called for the generated output file.
Post-processing arguments: Call arguments for the post-processing command.
Java command: The Java command, which is called if the post-processing command is inojava.
Suppress all empty chapters: If this option is set, all empty model enumeration chapters are suppressed as model components upon documentation generation. Normally the heading and an entry can be seen at the very least in the table of contents and index of documentation for such chapters.
Convert chapter headings to dash lists: If this option is set to Never, model element enumeration chapters without subchapters are shown as headings.
If this option is set to Leaf Nodes within Structure Tree Only, model element enumeration chapters which did not have a subchapter set for them in the documentation structure are converted into dash lists. Headings are not displayed for these.
If this option is set to Dynamically, the previous option is performed and the same action is also carried out for the model element enumeration chapters which have subchapters in the documentation structure but do not have any in the resulting document due to the modeled information.
Note:
The Leaf Nodes within Structure Tree Only option is not supported in Innovator X Generation.
Open result file: Here you can set whether the result file should always be opened, never, or following a prompt.
Attention:
The result is always opened in preview mode.
If a post-processing command is specified, this option is not evaluated.
Use smallest common package as root: If the documentation structure uses the hierarchy tree or namespace tree, model components above the first common predecessor are not shown in the documentation structure.
Documentation selection: The documentation selection used.
Owner: The profile in which the documentation command is located.
XSL Stylesheet Processor: The command used in the generation of HTML documentation in Innovator X Generation mode.
Note:
The command is overwritten by the parameters for the XSL Stylesheet Processor, which is specified in the Options dialog in the Documentation tab as a user setting spanning all models.

The following properties are used to parameterize the documentation in MS Word format in Innovator X Generation or if the Innovator X Generation documentation generator is used in Innovator eXcellence:

MS Word field for index: The field used as the index field.
MS Word field for table of contents: The field used as the table of contents field.
MS Word field for table of figures: The field used as the table of figures field.
MS Word field for table of tables: The field used as the table of tables field.

Note:

The properties for parameterization of the documentation in MS Word format overwrite the MS Word fields set in the Options dialog in the Documentation tab as a user setting spanning all models.

The following properties can only be edited in Innovator eXcellence:

Execute as I4BA documentation: If this option is set, the Innovator X Generation documentation generator is used.
Start structure level: This is where a heading level can be specified for the chapter at the topmost level for a documentation in MS Word format (important for Innovator report).
Generate excerpt from model: If this option is set, a documentation excerpt is created.
Delete input repository if successful: If this option is set, the information files are deleted after successful documentation generation.
Do not create graphics output files: If this option is set, no graphics are generated.
No character check: If this option is set, the text is not checked for invalid characters.

How to proceed

Jump to the Documentation view in the configuration editor.
Select the documentation command you want to edit.
Select Edit>Properties.

The dialog of the same name appears.
Jump to the Properties tab.
Modify the desired properties.
Confirm your changes with Apply.

The documentation command is changed.