TEIC / TEI

The Text Encoding Initiative Guidelines
https://www.tei-c.org
Other
276 stars 88 forks source link

Example of `<desc>` (as a child of non-documentation elements) is unclear #2425

Open agnasso opened 1 year ago

agnasso commented 1 year ago

the definition of <desc> in Appendix C of the guidelines is (description) contains a short description of the purpose, function, or use of its parent element, or when the parent is a documentation element, describes or defines the object being documented. (see https://tei-c.org/release/doc/tei-p5-doc/en/html/ref-desc.html)

Anyway, on the element page the "Example of a desc element in a non-documentation element" (the second example) is:

<place xml:id="KERG2">
  <placeName>Kerguelen Islands</placeName>
<!-- ... -->
  <terrain>
    <desc>antarctic tundra</desc>
  </terrain>
<!-- ... -->
</place>

This IMO does not seem to be consistent with the definition: in my view, this <desc> does not contain "a short description of the purpose, function, or use" of its <terrain> parent.

Compare the use of <desc> as a child of <gap> at https://tei-c.org/release/doc/tei-p5-doc/en/html/CO.html#index-egXML-d54e34303 (where it states the encoder's rationale for using the parent element in this specific occasion), which in my view would make a better example than the Kerguelen Islands one:

<gap reason="sampling" quantity="120"  unit="lines">
  <desc>irrelevant commentary</desc>
</gap>