12.1.27. <desc>

<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. [23.4.1. Description of Components]

Module core — Specification

Attributes

att.global
- @xml:id
- @n
- @xml:lang
- @xml:base
- att.global.analytic
  - @ana
- att.global.change
  - @change
- att.global.facs
  - @facs
- att.global.linking
  - @corresp
  - @synch
  - @sameAs
  - @copyOf
  - @next
  - @prev
  - @exclude
  - @select
- att.global.rendition
  - @rend
  - @style
  - @rendition
- att.global.responsibility
  - @cert
  - @resp
- att.global.source
  - @source
att.cmc
- @generatedBy
att.translatable
- @versionDate
att.typed
- type
- @subtype

type

characterizes the element in some sense, using any convenient classification scheme or typology.

Derived from	att.typed
Status	Optional
Datatype	teidata.enumerated
Suggested values include:	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>`

Member of

model.descLike model.labelLike model.languageProfile

Contained by

core: desc graphic head hi item list listBibl p

dictionaries: etym

figures: figDesc figure

gaiji: char charDecl glyph

header: category change language licence rendition tagUsage taxonomy

namesdates: occupation place state trait

textstructure: body div

May contain

core: abbr bibl biblStruct cit date desc email expan list listBibl name quote ref term title

dictionaries: lang

header: idno

namesdates: affiliation forename orgName persName persPronouns placeName state surname trait

tagdocs: ident

character data

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.

Example

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

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

A <desc> with a type of deprecationInfo should only occur when its parent element is being deprecated. Furthermore, it should always occur in an element that is being deprecated when <desc> is a valid child of that element.

<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>

Content model

<content>
 <macroRef key="macro.limitedContent"/>
</content>
    ⚓

Schema Declaration


element desc
{
   att.global.attributes,
   att.cmc.attributes,
   att.translatable.attributes,
   att.typed.attribute.subtype,
   attribute type { "deprecationInfo" }?,
   macro.limitedContent
}⚓