Skip to content
This repository has been archived by the owner on Oct 26, 2021. It is now read-only.

Commit

Permalink
Symbol field and metadata handling in 5.1
Browse files Browse the repository at this point in the history
Version 5.1 introduced a new GUI that no longer closely resembles how
this information is stored in the files. This means the rules 6.2 and
6.3 no longer make sense to be separated. It also required updating of
screenshots.

Better highlighting of rule regarding aliases
  • Loading branch information
poeschlr authored and nickoe committed Jan 18, 2020
1 parent 9314102 commit 9c9cb33
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 18 deletions.
26 changes: 22 additions & 4 deletions content/klc/S6.2.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,27 @@
+++
brief = "Component fields must be filled appropriately"
brief = "Symbol and alias fields and metadata filled out as required"
+++

. *Reference* field is selected appropriately for the symbol and is _visible_
. *Value* field contains the name of the symbol and is _visible_
. *Footprint* field contains footprint link for atomic parts, and is empty for generic parts. It must be _invisible_
. *Datasheet* field is left empty, and is _invisible_
. The symbol contains no other custom fields
. *Footprint* field contains footprint link for fully specified symbols and must be _invisible_
.. The footprint field must be empty for generic symbols
. *Datasheet* entry [1] is filled out, and is _invisible_
. The symbol contains no other custom fields

Additional documentation is provided via two other fields:
[start=6]
. **Description** field contains comma-separated device information
.. For symbols with a default footprint, the simplified footprint name should be appended to the description e.g. `SOIC-8`
.. Part name should not be duplicated in the description field
. **Keywords** field contains space-separated keyword values. These values are used to assist in part searching and should not include filler words

{{< klcimg src="symbol_metadata" title="Symbol metadata example" >}}

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

{{< klcimg src="alias_metadata" title="Alias metadata example" >}}

---

_[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._
13 changes: 0 additions & 13 deletions content/klc/S6.3.adoc

This file was deleted.

2 changes: 1 addition & 1 deletion content/libraries/klc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ aliases = [ "/klc/" ]
toc::[]


**link:/libraries/klc/history/[Revision: 3.0.24]**
**link:/libraries/klc/history/[Revision: 3.0.25]**

---

Expand Down
3 changes: 3 additions & 0 deletions content/libraries/klc_history.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ url = "/libraries/klc/history/"
+++

---
== 3.0.25 - 2019-10-06
* Update section about symbol documentation to KiCad 5.1 GUI (combined S6.2 and S6.3)

== 3.0.24 - 2019-11-16
* Clarify rule for parts with toleranced dimensions
* Fab comes from the nominal component dimensions (F5.2)
Expand Down
Binary file added static/img/klc/alias_metadata.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/klc/symbol_metadata.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9c9cb33

Please sign in to comment.