Menu
▾
▴
#401 Most attributes lack good examples
open-accepted
1(low)
2014-05-28
2012-04-23
No
There is a noticeable paucity of examples of the use of attributes, particularly in the <classSpec>s or <elementSpec>s in which they're actually defined. Each attribute should have at least one example showing its usage directly in that file. I've created a table of attributes which need examples here:
http://wiki.tei-c.org/index.php/AttsWithoutEgs
Council members are invited to edit that page to sign themselves up for individual attributes, and to mark them as completed when they've added at least one example.
This makes me think it would be good to have pointers from http://www.tei-c.org/release/doc/tei-p5-doc/en/html/REF-ATTS.html to list of examples like we have for each element. Something like http://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-sameAs.html
This doesn't seem to have seen much activity since May,
This doesn't seem to have seen much activity since May,
Council decision (Oxford, 2012-09) was to make another concerted effort to provide examples, and then open it up to the community and request assistance at the following members meeting.
Council decided to have RW and BB categorize the table items into priorities of high, medium and low for insertion of examples.
Has any work been done on this since April?
Brett and Becky are working on prioritizing the list of attributes without examples on the wiki. Becky's overall sense is that, due to clear definitions and well-defined datatypes, a great many of these are "low priority" for coming up with examples. That is, adding an example doesn't significantly help the encoder envision how to use the attribute, because what you can do is so nicely constrained. However, there are a handful where an example would really help, and a few where refining the definition of the attribute is a higher priority than coming up with an example.
Reassigning to PFS to follow up