11.4 Using Your Style Template for Other Projects

To generate documentation for any project, you can use the default style provided with Designer or you can use your own customized styles.

11.4.1 Document a Section of the Style

Instead of generating a document for the entire project, you can generate a document for a selected section of a project.

  1. With the project’s .docgen file open in the Style Editor pane, right-click a section of the style.

  2. Select Generate Documentation for This Section.

    Generating Documentation for a Section

  3. In the Generate Documentation window, type a different project name in the Filename field (for example, DocHistoryofMerger), then click OK.

Specify which portion or portions of the project you want to include in the generated document.

You can document domains, Identity Vaults, driver sets, drivers, and applications using the Modeler view or the Outline view (use the Ctrl key to select multiple items). Document generation also ties in with schema notes, classes and attributes. You can find out more about this in Section 6.0, Managing the Schema.

For example:

  1. To document a specific driver in a project, right-click the driver in the Modeler or Outline view and select Document Selection.

    Documenting a Driver

  2. Select the .docgen style sheet for the document and click Next.

  3. Give the document a filename, such as the driver’s name, select the document’s format, and click Finish to generate the driver document.

By default, documenting an application includes the connected driver (and its related objects). Likewise, documenting a specific driver includes its connected application. However, you can change this behavior in the Documentation Generation’s Preferences page.

  1. Click Window > Preferences to bring up the Preferences window.

  2. Under Designer for IDM, select Document Generation.

    Preferences on Relationships

    Under the Modeler heading, the Document applications and drivers related to other selected items option is selected by default, which means that directly related items are included in the documentation. For example, by default, documenting a driver set includes the direct children (the applications) as well as some information of the direct parents (the Identity Vault and domain) to give context to the driver set. Deselecting this option excludes direct children of the selected item.

  3. Select or deselect the options you want, then click OK.

11.4.2 Document Multiple Sections of the Style

If necessary, you can generate only selected sections so that peers can help you with information in the selected sections.

  1. If you have not already done so, double-click the .docgen file to bring up the template in the Style Editor.

  2. Select or deselect section headings. Each section and child section has a check box entitled Include this section in the final document. By default the box is checked, as shown below.

    Configuration section check box

    To limit the sections you want to document, deselect the check boxes in the sections you don’t want to generate.

  3. Click the Generate Document icon Configuration section check box to the right of the Style Editor heading and generate your document.

    Give the document a unique name to reflect the type of information it includes.