16.4 Using Your Template Style 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.

For example, suppose you have created a Blanston2 style. You customize the Blanston2 style to fit your needs, and you save it in the Documentation folder as Blanston2.docgen as outlined in Section 16.1, Creating a Document Style. You can use this style to create documentation for the Blanston2 project or for other projects.

16.4.1 Start with the Style and Choose the Project

  1. With the Blanston2 project open in the Project view, right-click the Blanston2.docgen file in the Documentation folder.

  2. Click Generate Documentation for This Style.

  3. In the Generate Documentation window, click the Input Settings tab, then select the project you want to create documentation for with this style template (in this example, Blanston3).

    Selecting the Project to Document
  4. Select the Output Settings tab to open the Specify Output Criteria window, fill in the necessary information, then click OK.

    For information on using this style to generate documentation, see Generating a Document.

16.4.2 Start with the Project and Choose the Style

  1. With two projects open (for example, Blanston1 and Blanston2), go to the Project view and click Documentation > New > Documentation Generation Style (.docgen).

  2. Name the new .docgen file (this example is Blanston2.docgen), then click Next.

  3. Select a base style (for this example, Blanston.docgen), then click Finish.

    Selecting a Base Style

    The Blanston2.docgen file opens in the Style Editor. Because a style usually contains project-specific information, such as the company name, use the above information to see if the template transferred. If you often use the Blanston2.docgen style with the Blanston1 project, you might want to copy the Blanston2 style to the Blanston1 Documentation folder, or copy the .docgen file to the styles template library. For more information, see Section 16.6.5, Saving a Style File in the Styles Template Library.

  4. You can click the Generate Documentation icon in the Style Editor to generate a document. See Section 16.3, Generating a Document.

    NOTE:If you see an exclamation mark in the . docgen file icon, it means the file does not contain new features and needs to be updated. To do this, create a new . docgen file, copy any changes to the new file from the older . docgen file, then delete the older . docgen file.

16.4.3 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.

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

    Generating Documentation for a Section

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 11.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, give the document a filename, and 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.

16.4.4 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 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.