<desc>
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.
Module coreTDcrystalsCEdc
Attributes
Global and inherited attributes:
- @typecharacterizes the element in some sense, using any convenient classification scheme or typology.
- Status
- Optional
- Datatype
- teidata.enumerated
- Suggested values
deprecationInfo- (deprecation information) This element describes why or how its parent element is being deprecated, typically including recommendations for alternate encoding.
<dataSpec module="tei" ident="teidata.point" validUntil="2050-02-25"> <desc type="deprecationInfo" versionDate="2018-09-14" xml:lang="en">Several standards bodies, including NIST in the USA, strongly recommend against ending the representation of a number with a decimal point. So instead of<q>3.</q> use either <q>3</q> or<q>3.0</q>.</desc> <!-- ... --> </dataSpec>
Classes and content
- Member of
- May contain
core
dictionaries
figures
msdescription
namesdates
tagdocs
textstructure
Character data
- character data
- Contained by
cmc
core
dictionaries
header
msdescription
namesdates
nets
tagdocs
textstructure
verse
Note
When used in a specification element such as elementSpec, TEI convention requires that this be expressed as a finite clause, begining with an active verb.
Examples
Example of a desc element inside a documentation element.
<dataSpec module="tei" ident="teidata.point">
<desc versionDate="2010-10-17" xml:lang="en">defines the data type used to express a point in cartesian space.</desc>
<content>
<dataRef name="token" restriction="(-?[0-9]+(\.[0-9]+)?,-?[0-9]+(\.[0-9]+)?)"/>
</content>
<!-- ... -->
</dataSpec>
Example of a desc element in a non-documentation element.
<place xml:id="KERG2">
<placeName>Kerguelen Islands</placeName>
<!-- ... -->
<terrain>
<desc>antarctic tundra</desc>
</terrain>
<!-- ... -->
</place>
Schematron
<constraintSpec xmlns:sch="http://purl.oclc.org/dsdl/schematron" ident="deprecationInfo-only-in-deprecated" scheme="schematron" xml:lang="en">
<desc versionDate="2018-09-13" xml:lang="en">A <gi>desc</gi> with
a <att>type</att> of <val>deprecationInfo</val> should only occur
when its parent element is being deprecated. Furthermore, it
should always occur in an element that is being deprecated when
<gi>desc</gi> is a valid child of that element.</desc>
<constraint>
<sch:rule context="tei:desc[ @type eq 'deprecationInfo']">
<sch:assert test="../@validUntil">Information about a
deprecation should only be present in a specification element
that is being deprecated: that is, only an element that has a
@validUntil attribute should have a child <desc
type="deprecationInfo">.</sch:assert>
</sch:rule>
</constraint>
</constraintSpec>Content model
<content>
<macroRef key="macro.limitedContent"/>
</content>