Library Report Settings

Modified by Jason Howie on Aug 7, 2018
Contents
Other Related Resources
Libraries Panel

Parent page: IntegratedLibrary Dialogs

Two incarnations of the Library Report Settings dialog.

Summary

This dialog allows the designer to configure and generate a report containing all items in the library currently being browsed in the Libraries panel.

The core options available in the dialog will change in accordance with the type of library currently being browsed in the panel. There are therefore two incarnations of the dialog - one to accommodate a schematic library (or component view of an integrated library), and one to accommodate a PCB library (or footprint view of an integrated library).

Access

The dialog is accessed by right-clicking within the Components region of the Libraries panel, and choosing the Library Report command from the context menu.

Options/Controls

Output File Name

  • File Name - use this field to define where, and under what name, the report is to be generated. By default, the report will be named after the library being browsed, and will be created in the folder in which that library resides. Make changes to this as required, either directly in the field, or by clicking the  icon, to access a standard Save Report As dialog, with which to do so.
The extension for the report will change in accordance with the style of report chosen (either Document Style (*.doc), or Browser Style (*.html)).
  • Document Style - enable this option to generate a print-based Word document (*.doc).
  • Browser Style - enable this option to generate a browser-based HTML document (*.html)
The generated HTML report will consist of a main landing page, with links to child pages for each of the components in the library.
  • Open generated report - enable this option to have the report opened after it is generated. If the Document Style option is enabled, the generated report will be opened in Microsoft Word (if installed on the computer). If the Browser Style option is enabled, the generated report will be opened in your default external Web Browser.
  • Add generated report to current project - enable this option to have the generated report added to the project. A report generated in document format will appear in the Projects panel under the Generated\Text Documents sub-folder. A report generated in browser-based format will appear in the Projects panel under the Generated\Documents sub-folder.
This option is only available if the library is currently added to the project (appearing on the Project tab of the Available Libraries dialog).

Include in report

  • Component's Parameters - enable this option to include in the report a detailed section listing the component's parameters. For each parameter information is presented about its Name, Value, Type, and Visible state.
  • Component's Pins - enable this option to include in the report a detailed section listing the component's pins. For each pin, the following property information is presented: Designator, Name, X1, Y1, Orientation, Color, Type, Show, Show Name, Show Number, Width, Length, Inner Symbol, Outer Symbol, Inner Edge Symbol, Outer Edge Symbol.
  • Component's Models - enable this option to include in the report a detailed section listing the component's models. For a PCB 2D/3D Component model, the following property information is presented: Model Name, Model Type, Description, Height, Dimension, Number of Pads, Number of Primitives.

Draw previews for

  • Components - enable this option to include in the report preview images for the schematic symbols  (as seen in the Libraries panel).
  • Models - enable this option to include in the report preview images for the linked PCB 2D/3D Component models  (as seen in the Libraries panel).
When generating a report for a PCB library (or Footprint view of an integrated library), this section is simply replaced by a single option to Draw components' previews. This is essentially the same as the Models option described above.

Settings

  • Use Color - enable this option to have the preview images for the schematic symbols drawn in color. Disable to have them drawn in monochrome.
This option has no effect on preview images for models.
  • Write images as Metafiles - enable this option to have the images used for the symbol and model previews generated in Windows Meta File format (*.wmf). Disable this option to use JPEG format (*.jpg).
This option is only available when using the Browser Style.

Notes

  1. The report will be titled according to the type of library being browsed - Schematic Library Report, Integrated Library (Components) Report, PCB Library Report, or Integrated Library (Footprints) Report.
  2. The following top-level information is included in the report: Library File Name, Library File Date/Time (when the library was last modified), Library File Size (in bytes), and Number of Components (contained within the library).
  3. For a report featuring schematic components, the following summary information is included: Library Reference, Description, Kind, Aliases, Designator, Number of Parameters, Number of Pins, and Number of Models.

 

You are reporting an issue with the following selected text and/or image within the active document: