Editing a Documentation Command's Properties

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; one graphic is displayed per page for the generated documentation. This means that a diagram may be split onto more than one page. 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.

• 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 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.

• Open Result File: 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.

  This option is not evaluated if a post-processing command is entered.

• 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.

• Show Active Smart Icons in Graphic: The active Smart icons are shown in diagrams.

• Documentation Selection: The documentation selection used.

• Owner: The profile where 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:

• 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.