search

kshawkin / Best-Practices-for-TEI-in-Libraries

Best Practices for TEI in Libraries: A guide for mass digitization, automated workflows, and promotion of interoperability with XML using the TEI
http://purl.oclc.org/NET/teiinlibraries
32 stars 8 forks source link

standardize how we express "required" and "optional" in element tables #84

Closed kshawkin closed 6 years ago

kshawkin commented 6 years ago

We have begun using "[required]" and "[optional]" at the beginning of the glosses for each element in some element tables. We should do this consistently throughout, rewording as necessary.

Best to do this before https://github.com/kshawkin/Best-Practices-for-TEI-in-Libraries/issues/44 .

kshawkin commented 6 years ago

Per the wording in the introduction to the BPTL:

As guidelines rather than a specification, these Best Practices use should or recommended instead of must to give recommendations in all cases except where a practice is required by P5. Optional practices are indicated by may or optional. However, to encourage conformance to these Best Practices, the ODD files will generate schemas that require use of recommended elements (those indicated by should or recommended).

... I will standardize on "[recommended]" and "[optional]" except when something is also required by P5, in which case I'll use "[required]".

But note that when the BPTL says to use something only a certain circumstance, I'll still mark that as "[recommended]" since the situation is essentially "recommended when applicable".