In addition to viewing resources, you might want to document the applications that you are building. WebSphere® Integration Developer provides a tool to generate documentation for the artifacts in your modules, mediation modules, and libraries.
Initiate the documentation generation by invoking a wizard. You can customize the contents of the documentation by selecting multiple resources from one or more modules and libraries so that all the information will be written to a single report, which is a PDF file. You can also specify the layout and fonts for the output. See "Generating documentation" in the related tasks for detailed instructions on how to create documentation.
The documentation generator produces the following information for these resources:
Other resources will not be documented by the documentation generator.
The documentation generator can also produce documentation for the selected resources and the resources that they reference. For example, in the Documentation Generation wizard, you can select the business process and the Include referenced files option. As a result, the generated PDF report will also have information for the resources (such as interfaces invoked by its activities) that the process references.
The generated PDF report has the following structure:
Has the report title, author name, and report date.
Lists the sections and page numbers in the report.
Lists the properties of the resources. Except for the module and library, all resources also have pictures of the resources opened in the Editor view.
Lists for each documented resource, which resource uses it (Providers list), and where it is used (Receiver list).
Lists the documentation generation settings that were specified in the Documentation Generation wizard and used for the PDF report.
The layout and the style of the generated PDF report can be customized with the Documentation Generation Wizard. If you change the layout and style settings, they are saved for all subsequent documentation generations, until they are changed again.
The following layout settings can be modified:
Defines the paper size of the generated documentation.
Default value: Letter
Defines the maximum level of topics to be listed in the table of contents of the report.
Default value: 7
Plain text
Chapter title
Source code text
Caption text
Definition text
Header text
Table of contents
A master file is a resource profile defining the contents (not the font styles) to be included in the generated documentation. When using the Documentation Generation wizard, create a master file to save your resource selections and the next time you use the wizard to update the same report, just select the existing master file.
The documentation generator provides three default fonts that can be used in the documentation. These fonts are Helvetica, Courier, and Times with the font styles: regular, italic, bold, and bold italic.
You can add a new font, which is either a true type font file (.ttf) or true type collection file (.ttc) by registering it. Font registration is done from the Documentation Generation wizard. Once a font is registered, it can be used for all reports until it is removed. Default fonts cannot be removed. See "Generating documentation" under related tasks for instructions on how to work with the Documentation Generation wizard.
The documentation generator can write documentation generation trace messages into a trace file. Do not turn on this tracing function unless there is a problem with the documentation generator, because tracing impacts system performance and can take up a lot of disk space. The trace is set in the Preferences window and output is written into a text file in the metadata directory (workspace-name\.metadata\.plugins\com.ibm.wbit.reporting.infrastructure\trace\). Log entries are appended and never erased.