Symbol field and metadata handling in 5.1 #446

poeschlr · 2019-10-06T15:35:17Z

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.

Script updates found in KiCad/kicad-library-utils#312
fixes #442

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.

evanshultz · 2019-10-07T19:07:41Z

content/klc/S6.2.adoc

+. *Footprint* field contains footprint link for fully specified symbols, and is empty for generic symbols. It must be _invisible_
+. *Datasheet* entry [1] is filled out, and is _invisible_


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?

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)

It's not clear to me why this needs to be done this way instead of just being underneath the Datasheet section. But OK.

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.

evanshultz · 2019-10-07T19:08:02Z

content/klc/S6.2.adoc

Other bullets here would replace the . It must be with and is.

Changed this section to be more readable

…handling_to_v5.1

poeschlr · 2020-01-13T10:32:39Z

I fixed the merge conflict and fixed what needed fixing

evanshultz · 2020-01-13T16:51:51Z

Just two things:

I believe you need a colon after via.
None of the clauses end in a period. I checked S6.1 and those clauses end in periods. But S7.1 doesn't, and earlier symbol clauses are mixed. I assume you'd rather merge this and then do cleanup to all of KLC at once. But I'm noting it here so you're aware.

poeschlr · 2020-01-13T21:44:50Z

Harmonizing the use of periods at the end of KLC list entries would definitely be a separate pull request.

I am not sure what you mean with your other request.

evanshultz · 2020-01-14T00:02:01Z

content/klc/S6.2.adoc

+. The symbol contains no other custom fields
+
+Additional documentation is provided via


Please add a colon at the end of this line.

I see a comma, not a colon. I was shooting for path of least resistance before, but since this isn't closed I feel the wording is a bit awkward and would read better if two other fields: was added after via.

Remember you might need to be a bit clearer with what you mean when writing with non native speakers. For example you could have added the symbol you were expecting to your comment (as the symbol itself in addition to its english name)

You are right. I will try to be more clear in the future. There are a few things I could have done better.

I imagine it is hard to remember that not everyone here is a native speaker as our knowledge of english is well enough to hide this fact most of the time.

evanshultz · 2020-01-15T19:05:00Z

content/klc/S6.2.adoc

+---
+
+_[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 linkded to the dcm entry since version 5.1.x._


Typo of linked in the last sentence. Remove the first d in linkded.

evanshultz · 2020-01-17T16:34:24Z

Great. Thank you!

evanshultz · 2020-01-17T16:35:29Z

@nickoe @marekr
This PR is ready to be merged, assuming it's still OK to merge PRs from GH. Let us know if you are only merging MRs from Gl for the website.

nickoe · 2020-01-18T00:43:11Z

@evanshultz Ok, thanks for the mention, but it looks like there is a conflict so I can't make github rebase it automatically. I will try to remember to fix it tomorrow unless someone beats me to it. @marekr

poeschlr · 2020-01-18T09:15:47Z

Github does not show a conflict to me.

Edit: If the website already moved to gitlab then we might need to run the bot to get the updates over. (I continued to work here because i seem to remember i read somewhere that the website is still on github)

nickoe · 2020-01-18T11:53:46Z

We still use github for the website for now.
I resolved the conflict and squashed the fixes into 9c9cb33. Thank you.

poeschlr · 2020-01-18T12:08:17Z

@evanshultz could you in this case look at the script pull request? The script would otherwise point to the wrong KLC rule(s).

poeschlr · 2020-01-18T12:44:59Z

@nickoe are you sure you merged the correct commit range? The klc history page does not show the result of my merge.

nickoe · 2020-01-18T12:48:22Z

I see 3.0.25 in the changeset 9c9cb33#diff-87d0795c9f659b7ebd57e1b84e1c2435

poeschlr · 2020-01-18T12:52:18Z

The date should be 3.0.25 - 2020-01-13

nickoe · 2020-01-18T12:52:35Z

Yes, the date is already fixed.

poeschlr mentioned this pull request Oct 6, 2019

Update metadatacheck to fit v5.1 KiCad/kicad-library-utils#312

Open

Symbol field and metadata handling in 5.1

67fd70d

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.

poeschlr force-pushed the update_datasheet_handling_to_v5.1 branch from dc9e7a7 to 67fd70d Compare October 6, 2019 15:36

poeschlr added the libraries label Oct 6, 2019

evanshultz reviewed Oct 7, 2019

View reviewed changes

cpresser mentioned this pull request Nov 13, 2019

Add the TPD4E1B06{DRL,DCK} type low leakage, bidirectional quad TVS. KiCad/kicad-symbols#2256

Open

6 tasks

poeschlr added 2 commits January 13, 2020 11:31

Merge remote-tracking branch 'upstream/master' into update_datasheet_…

1a8d26f

…handling_to_v5.1

Changes as requested

1782b55

evanshultz reviewed Jan 14, 2020

View reviewed changes

poeschlr added 4 commits January 14, 2020 09:52

add colon as requested

c5947db

correcting misunderstanding of review

97eea00

Better highlighting of rule regarding aliases

c9f8c55

clarify footnote

84f03e9

evanshultz reviewed Jan 15, 2020

View reviewed changes

fix typo

8200548

nickoe closed this Jan 18, 2020

poeschlr deleted the update_datasheet_handling_to_v5.1 branch January 18, 2020 12:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Symbol field and metadata handling in 5.1 #446

Symbol field and metadata handling in 5.1 #446

poeschlr commented Oct 6, 2019 •

edited

Loading

evanshultz Oct 7, 2019

poeschlr Jan 13, 2020

evanshultz Jan 13, 2020

poeschlr Jan 15, 2020

evanshultz Oct 7, 2019

poeschlr Jan 13, 2020

poeschlr commented Jan 13, 2020

evanshultz commented Jan 13, 2020

poeschlr commented Jan 13, 2020

evanshultz Jan 14, 2020

poeschlr Jan 14, 2020

evanshultz Jan 14, 2020

poeschlr Jan 15, 2020

evanshultz Jan 15, 2020

poeschlr Jan 16, 2020

evanshultz Jan 15, 2020

poeschlr Jan 16, 2020

evanshultz commented Jan 17, 2020

evanshultz commented Jan 17, 2020

nickoe commented Jan 18, 2020

poeschlr commented Jan 18, 2020 •

edited

Loading

nickoe commented Jan 18, 2020 •

edited

Loading

poeschlr commented Jan 18, 2020

poeschlr commented Jan 18, 2020

nickoe commented Jan 18, 2020

poeschlr commented Jan 18, 2020

nickoe commented Jan 18, 2020

		. Footprint field contains footprint link for fully specified symbols, and is empty for generic symbols. It must be _invisible_
		. Datasheet entry [1] is filled out, and is _invisible_

		. The symbol contains no other custom fields

		Additional documentation is provided via

		---

		_[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 linkded to the dcm entry since version 5.1.x._

Symbol field and metadata handling in 5.1 #446

Symbol field and metadata handling in 5.1 #446

Conversation

poeschlr commented Oct 6, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

poeschlr commented Jan 13, 2020

evanshultz commented Jan 13, 2020

poeschlr commented Jan 13, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

evanshultz commented Jan 17, 2020

evanshultz commented Jan 17, 2020

nickoe commented Jan 18, 2020

poeschlr commented Jan 18, 2020 • edited Loading

nickoe commented Jan 18, 2020 • edited Loading

poeschlr commented Jan 18, 2020

poeschlr commented Jan 18, 2020

nickoe commented Jan 18, 2020

poeschlr commented Jan 18, 2020

nickoe commented Jan 18, 2020

poeschlr commented Oct 6, 2019 •

edited

Loading

poeschlr commented Jan 18, 2020 •

edited

Loading

nickoe commented Jan 18, 2020 •

edited

Loading