Documents are generated by calling a document command; this command contains information about the output format and the documentation's structure, as well as other layout elements.
The most important parts of documentation generation are documentation structures, selections and commands. A documentation structure can be used by various documentation selections which, in turn, can be used by various documentation commands. This dissociation enables documents which are practically identical to be created in different output formats or one documentation structure with an English and then with a German title page to be created.
The document's contents can be specified by making a selection in the model when documentation generation begins.
It is possible to create a document using a wizard.
Documentation Structures
You can use a documentation structure to specify which information should be shown where in the document.
You need to assign a documentation structure both a documentation selection and a documentation command to be able to use it.
Documentation Selection
Information about the document's layout can be found in the documentation selection. This concerns the following information in particular:
- Documentation structure used
- Documentation's title page
- Headers and footers
Documentation Commands
Documentation commands are the interface called by the user when generating a documentation. You can set output format, graphic format, name of the output file and various generation options, to name but a few, when configuring a documentation command.
Related Topics
