Library Conventions | KiCad EDA

Version 3.0.28

Library maintainer rules & guidelines

S6.2 Symbol and alias fields and metadata filled out as required

  1. Reference field is selected appropriately for the symbol and is visible

  2. Value field contains the name of the symbol and is visible

  3. Footprint field contains footprint link for fully specified symbols and must be invisible

    1. The footprint field must be empty for generic symbols

  4. Datasheet entry [1] is filled out, and is invisible

  5. The symbol contains no other custom fields

Additional documentation is provided via two other fields:

  1. Description field contains comma-separated device information

    1. For symbols with a default footprint, the simplified footprint name should be appended to the description e.g. SOIC-8

    2. Part name should not be duplicated in the description field

  2. Keywords field contains space-separated keyword values. These values are used to assist in part searching and should not include filler words

Aliases define their own values for the datasheet link, description and keyword entries.

[1]: KiCad 5.x and earlier have two places to store the datasheet link. It can be in the .lib file once per symbol or in the .dcm file allowing different datasheets per alias. Having different datasheets for aliases only works if the .lib entry is left empty. The datasheet entry in the main symbol metadata view is linked to the dcm entry since version 5.1.x.