This functionality is only available for certain module packages. Info / Copyright

Documenting Symbol Libraries

Symbol library documentation can be generated either in the original project or in a separate project. In a separate project you are allowed, for example, to add plot frames or edit text information, but you can't edit the symbols!

Proceed as follows to generate a symbol overview, i.e. the index of symbols for a symbol library:

Preconditions:

  1. Utilities > Reports > Generate
  2. If the symbol overview is not listed in the Reports tab of the Reports - <Project name> dialog, click [New].
  3. In the Select report dialog select the "Symbol overview" report type.
  4. If necessary, change the Output format and Source project settings.
  5. Select the Manual selection check box if not all of the symbol libraries need to be documented.
  6. Click [OK].
  7. If you have selected the Manual selection check box, you have to specify which symbol libraries should be taken into consideration in the Manual selection dialog.
  8. Click [OK].
  9. Use the Settings - Symbol overview dialog to specify, if needed, the sorting, filter and page break schemes.
  10. Click [OK].
  11. In the Symbol overview dialog specify the settings for the pages to be generated.
  12. Click [OK].

    The symbol overview is generated but this process depends on the size of the selected symbol libraries and may take some time.

    The list of reports is extended with the Symbol overview tree structure level and, below that, with the list of documented symbol libraries.
  13. Close the Reports - <Project name> dialog.

    The generated report pages are inserted into the specified target project.

Note:

Using the Output only used symbols form property (ID 13114), you can limit the output of the symbol overview to the symbols used in the project.