12.5. Component documentation

12.5. Component documentation

To edit documentation information, it is necessary to call the main editing window of the component via the icon and to select the document folder.

Be sure to select the right alias, or the root component, because this documentation is the only characteristic which differs between aliases. The “Copy Doc” button allows you to copy the documentation information from the root component towards the currently edited alias.

12.5.1. Component keywords

Keywords allow you to search in a selective way for a component according to specific selection criteria (function, technological family, etc.)

The Eeschema research tool is not case sensitive. The most current key words used in the libraries are

• CMOS TTL for the logic families
• AND2 NOR3 XOR2 INV… for the gates (AND2 = 2 inputs AND gate, NOR3 = 3 inputs NOR gate).
• JKFF DFF… for JK or D flip-flop.
• ADC, DAC, MUX…
• OpenCol for the gates with open collector output. Thus if in the schematic capture software, you search the component: by keys words NAND2 OpenCol Eeschema will display the list of components having these 2 key words.

12.5.2. Component documentation (Doc)

The line of comment (and keywords) is displayed in various menus, particularly when you select a component in the displayed components list of a library and in the ViewLib menu.

If this Doc. file exists, it is also accessible in the schematic capture software, in the pop-up menu displayed by right-clicking on the component.

12.5.3. Associated documentation file (DocFileName)

Indicates an attached file (documentation, application schematic) available ( pdf file, schematic diagram, etc.).

12.5.4. Footprint filtering for CvPcb

You can enter a list of allowed footprints for the component. This list acts as a filter used by CvPcb to display only the allowed footprints. A void list does not filter anything.

Wild-card characters are allowed.

S014* allows CvPcb to show all the footprints with a name starting by SO14.

For a resistor, R? shows all the footprints with a 2 letters name starting by R.

Here are samples: with and without filtering

With filtering

Without filtering