This repository has been archived by the owner on Oct 26, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 115
Symbol field and metadata handling in 5.1 #446
Closed
Closed
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
67fd70d
Symbol field and metadata handling in 5.1
poeschlr 1a8d26f
Merge remote-tracking branch 'upstream/master' into update_datasheet_…
poeschlr 1782b55
Changes as requested
poeschlr c5947db
add colon as requested
poeschlr 97eea00
correcting misunderstanding of review
poeschlr c9f8c55
Better highlighting of rule regarding aliases
poeschlr 84f03e9
clarify footnote
poeschlr 8200548
fix typo
poeschlr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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._ |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This style of using a numbered reference in brackets is not used elsewhere in KLC that I can find. I see a a separate section below without any linking or sub-bullets. Do you want to introduce this new style?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a footnote for adding additional information. We do not have a footnote anywhere else in the KLC (it was not necessary to clarify things like that in other rules. As this is really one of the few places where we need to explain strange KiCad behaviour)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not clear to me why this needs to be done this way instead of just being underneath the
Datasheet
section. But OK.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wanted to keep this rule short so that users read it. What is below basically gives additional clarification for users who are still interested.
I learned with bad experiences that users turn their brain off after a few sentences so the most important info should be kept short. Adding additional stuff for the few users that are interested is still worth it. Especially if we ever get a discussion in a pull request because then we can point to this additional information.