Parameterizing MDA Modeler documentation generation
Defining MDA component parameters for MDA Modeler documentation generation
In order to generate MDA Modeler documentation, a number of parameters specifically related to documentation generation must be set. These parameters are grouped into seven separate categories within the “MDARuntime” MDAC, as shown in the figures below.
The “General” parameter set
Figure 191. The “General” parameter set
|
The ...
parameter |
is used
to ... |
|
XSLT command |
specify XSLT processor input parameters. The default value of this parameter is “%processor”. |
|
Generation directory |
specify the directory where documentation is generated. The default value of this parameter is “$(GenRoot)\doc\”. |
|
Format |
specify the format supported for generation (simple HTML, multiple HTML, RTF, RTF with round trip tags, PDF). |
The “Viewers” parameter set
Figure 192. The “Viewers” parameter set
|
The ...
parameter |
is used
to ... |
|
XML viewer |
indicate the path of the XML viewer. |
|
RTF viewer |
indicate the path of the RTF viewer. |
|
HTML viewer |
indicate the path of the HTML viewer. |
|
PDF viewer |
indicate the path of the PDF viewer. |
|
Let Windows start the viewer |
indicate if
the viewer start-up process is |
|
Open editor after generation |
indicate if the viewer will be launched after generation. By default, this parameter is active. |
The “Simple HTML options” parameter set
Figure 193. The “Simple HTML options” parameter set
|
The ...
parameter |
is used
to ... |
|
XSLT processor |
indicate the path of the XSLT processor used in simple HTML generation. By default, this is set to “$MODULE_DIR/bin/umlthtml.exe”. |
|
XSL file |
indicate the path of the XSL file used to parse the XML file. By default, this is set to “$MODULE_DIR/bin/docbook/xsl/htmlsimple/profile-docbook.xsl”. |
|
HTML stylesheet (“.css”) |
indicate the path of the HTML style sheet used to give a formatting style to the HTML document. By default, this is set to “$MODULE_DIR/bin/styles.css”. |
The “Multiple HTML options” parameter set
Figure 194. The “Multiple HTML options” parameter set
|
The ...
parameter |
is used
to ... |
|
XSLT processor |
indicate the path of the XSLT processor used in multiple HTML generation. By default, this is set to “$MODULE_DIR/bin/umlthtml.exe”. |
|
XSL file |
indicate the path of the XSL file used to parse the XML file. By default, this is set to “$MODULE_DIR/bin/docbook/xsl/htmlmulti/chunk-frames.xsl”. |
|
HTML stylesheet (“.css”) |
indicate the path of the HTML style sheet used to give a formatting style to the HTML document. By default, this is set to “$MODULE_DIR/bin/styles.css”. |
The “RTF options” parameter set
Figure 195. The “RTF options” parameter set
|
The ...
parameter |
is used
to ... |
|
XSLT processor |
indicate the path of the XSLT processor used in RTF generation. By default, this is set to “$MODULE_DIR/bin/umltf.exe”. |
|
XSL file |
indicate the path of the XSL file used to parse the XML file. By default, this is set to “$MODULE_DIR/bin/docbook/xsl/rtf/profile-docbook.xsl”. |
|
Word template (“.dot”) |
indicate the path of the Word template used to give a formatting style to the RTF document. By default, this is set to “$MODULE_DIR/bin/styles.dot”. |
The “RTF round trip options” parameter set
Figure 196. The “RTF round trip options” parameter set
|
The ...
parameter |
is used
to ... |
|
XSLT processor |
indicate the path of the XSLT processor used in RTF generation. By default, this is set to “$MODULE_DIR/bin/umltf.exe”. |
|
XSL file |
indicate the path of the XSL file used to parse the XML file. By default, this is set to “$MODULE_DIR/bin/docbook/xsl/rtf/profile-docbook.xsl”. |
|
Word template (“.dot”) |
indicate the path of the Word template used to give a formatting style to the RTF document. By default, this is set to “$MODULE_DIR/bin/styles.dot”. |
The "PDF options" parameter set
Figure 197. The “PDF options” parameter set
|
The ...
parameter |
is used
to ... |
|
XSLT processor |
indicate the path of the XSLT processor used in PDF generation. By default, this is set to “$MODULE_DIR/bin/umltf.exe”. |
|
XSL file |
indicate the path of the XSL file used to parse the XML file. By default, this is set to “$MODULE_DIR/bin/docbook/xsl/fo/profile-docbook.xsl”. |
|
Format file |
indicate the path of the XSL file used to give a formatting style to the PDF document. By default, this is set to “$MODULE_DIR/bin/docbook/xsl/fo/param.xsl”. |
Using your own files to customize documentation generation
To use your own files (XSL, CSS, dot, binary), you should simply change the corresponding parameter.
The binary files correspond to different XSLT, XSLFO processors which work with the provided XSL files. Therefore, there is no guarantee that you will obtain the same result with other processors. We advise you to modify the existing XSL files or to use your own, rather than changing the binary files.
Should you wish to change the .dot file, we advise you to modify the existing one.
Customizing XSL files
XSL files are used to obtain clear and attractive documentation. However, you may wish to change certain aspects. Rather than using your own XSL files or directly modifying every XSL file, we advise you to change only a limited number of them.
Some XSL files are “made” to be customized. This is the case for every XSL file whose name contains “chunk”. These files are mostly used in multiple HTML generation. Another kind of XSL file, "toc" files, can also be customized. These files are used in the generation of the table of contents.
To partially customize the look and feel of your documentation, you should simply change the parameters of the XSL files. These are defined in a file named “param.xsl” which is found in every generation directory (docbook/rtf, docbook/htmlmultiple …etc.). For example, the look and feel of PDF documents is entirely based on this file. The “pagesetup.xsl” file also contains data on document formatting.