Options and How to Proceed for Model Documentation

Documentation Content

The actual documentation content is made up of intersections of documentation content selected and the configured documentation structure.

Model elements which were specified as content but do not appear in the configured documentation structure are not part of the documentation. Vice versa, configured documentation structures remain empty if no appropriate content was set.

You can select one of the following options as documentation content:

• The active document (diagram, table or specification)
• All of the workspace's open documents
• The current selection
• An individual section of the model (selection in the Documentation Creation Wizard dialog)
• The entire model

Documentation Structure

Documentation structure is set in the configuration editor using the documentation structure.

Documentation structure is assigned to a selection which also contains layout settings (e.g. title page). A documentation command accesses a selection and with it, a documentation structure.

A documentation command option is the output format (output type). All documentation commands with the Word for Windows Document, XML Document or Preview Window output formats can be selected in the Documentation Creation Wizard dialog.

Documentation Output Formats

You can create documentation in the following output formats:

• As Word Document

  Create a model documentation of type 'Microsoft Office Word 2007'. Use this output format if you want to print the documentation or send it as a single file.

  Generate a document in Word 2007 format (docx); you can specify the layout using a template document.

  You can specify the directory for the output files in the documentation command. The user's local temporary directory is set as standard.

• As XML/HTML

  Create a model documentation of type 'XML' and as web pages. Use this output format if you want to publish the documentation on a web server.

  Generate an XML document which you can change into HTML pages using XSL-T in a post-processing step.

  You can specify the directory for the output files in the documentation command. The user's local temporary directory is set as standard.

• Preview

  Create a preview window which is inserted into the Innovator window. You can use the window to perform searches, follow references and scale displays.

  Use Document Preview to get a quick overview of the documentation to be generated.

Basic Procedure when Creating a Model Documentation

There are many options available for content and output format when creating a model documentation:

1. If you do not want to document the whole model but want to specify what parts are to be documented, choose one of the alternatives:

   1. If you want to document a certain document (diagram, table or specification), activate it so that it is not in the background.
   2. If you want to document more than one document, open only these document windows.
   3. If you want to document specific model elements, select them. It is also possible to select the model elements in the Documentation Creation Wizard.

2. If you want to specify documentation output in advance, choose one of the alternatives:

   1. If you want to create a Word document, select Model>Create & Send Documentation>As Word Document
   2. If you want the documentation as an XML file and to output it as HTML pages, select Model>Create & Send Documentation>As XML/HTML.
   3. If you want to view the documentation in the preview window, select Model>Create & Send Documentation>Preview.
3. If you do not want to specify documentation output in advance, select Model>Create & Send Documentation>Use Documentation Creation Wizard.
4. If you want to document an individual section of the model, select this documentation's content in the Documentation Creation Wizard dialog.
5. If you want to use the documentation command last used to create documentation for the current selection, select Model>Create & Send Documentation>Redo Generation.