Appendices¶

Appendix A: Key index¶

Keys, in alphabetical order, with the chapter that defines each.

Key	Defined in
`acronym`	Controlled Term Field
`action`	Controlled Term Field
`actions`	Controlled Term Field
`altLabels`	Fields: Core Structure
`annotations`	Annotations
`children`	Templates: Core Structure, Elements: Core Structure, Instances: Core Structure
`configuration`	Fields: Core Structure
`content`	Static Fields
`continuePreviousLine`	Fields: Core Structure
`createdBy`	Provenance
`createdOn`	Provenance
`datatype`	Numeric Field, Temporal Field, Instances: Core Structure
`decimalPlaces`	Numeric Field
`default`	Field Types, Controlled Term Field
`derivedFrom`	Versioning and Status
`description`	Core Artifact Structure
`footer`	Templates: Core Structure
`granularity`	Temporal Field
`header`	Templates: Core Structure
`height`	Fields: Core Structure, Static Fields
`hidden`	Fields: Core Structure
`id`	Core Artifact Structure, Instances: Core Structure
`identifier`	Core Artifact Structure
`inputTimeFormat`	Temporal Field
`inputTimeZone`	Temporal Field
`instanceType`	Templates: Core Structure, Elements: Core Structure
`iri`	Controlled Term Field
`isBasedOn`	Instances: Core Structure
`key`	Templates: Core Structure, Fields: Core Structure
`label`	Radio Field, Controlled Term Field, Instances: Core Structure
`language`	Core Artifact Structure, Instances: Core Structure
`maxDepth`	Controlled Term Field
`maxItems`	Fields: Core Structure, Elements: Core Structure
`maxLength`	Text Field
`maxValue`	Numeric Field
`minItems`	Fields: Core Structure, Elements: Core Structure
`minLength`	Text Field
`minValue`	Numeric Field
`modelVersion`	Versioning and Status
`modifiedBy`	Provenance
`modifiedOn`	Provenance
`multiple`	Fields: Core Structure, Elements: Core Structure
`name`	Core Artifact Structure
`notation`	Instances: Core Structure
`numTerms`	Controlled Term Field
`ontologyName`	Controlled Term Field
`overrideDescription`	Fields: Core Structure, Elements: Core Structure
`overrideLabel`	Fields: Core Structure, Elements: Core Structure
`prefLabel`	Fields: Core Structure, Instances: Core Structure
`previousVersion`	Versioning and Status
`propertyIri`	Fields: Core Structure, Elements: Core Structure
`recommended`	Fields: Core Structure
`regex`	Text Field
`required`	Fields: Core Structure
`sourceAcronym`	Controlled Term Field
`sourceIri`	Controlled Term Field
`status`	Versioning and Status
`termLabel`	Controlled Term Field
`termType`	Controlled Term Field
`termIri`	Controlled Term Field
`to`	Controlled Term Field
`type`	Core Artifact Structure
`unit`	Numeric Field
`value`	Controlled Term Field, Instances: Core Structure, Annotations
`valueSetName`	Controlled Term Field
`values`	Field Types, Controlled Term Field
`version`	Versioning and Status
`width`	Fields: Core Structure, Static Fields

Appendix B: Controlled vocabularies¶

Artifact and instance type: template, element, instance, element-instance, and the 25 field-type tokens.

Field-type tokens: text-field, text-area-field, numeric-field, temporal-field, controlled-term-field, radio-field, checkbox-field, single-select-list-field, multi-select-list-field, link-field, ext-ror-field, ext-orcid-field, ext-doi-field, ext-rrid-field, ext-pfas-field, ext-pubmed-field, ext-nih-grant-id-field, phone-number-field, email-field, attribute-value-field, static-rich-text, static-image, static-youtube-video, static-section-break, static-page-break.

status: draft, published.

Numeric datatype: xsd:decimal, xsd:int, xsd:long, xsd:short, xsd:byte, xsd:float, xsd:double.

Temporal datatype: xsd:date, xsd:time, xsd:dateTime.

granularity: year, month, day, hour, minute, second, decimalSecond.

inputTimeFormat: 12h, 24h.

Value-specification type: ontology, branch, class, valueSet.

termType: class, value.

action: delete, move.

Appendix C: Datatypes¶

CEDAR uses XSD datatypes, written with the xsd: prefix, to type numeric and temporal values.

Token	Datatype
`xsd:decimal`	Arbitrary-precision decimal number.
`xsd:int`	32-bit integer.
`xsd:long`	64-bit integer.
`xsd:short`	16-bit integer.
`xsd:byte`	8-bit integer.
`xsd:float`	Single-precision floating point.
`xsd:double`	Double-precision floating point.
`xsd:date`	Calendar date.
`xsd:time`	Time of day.
`xsd:dateTime`	Date and time.

The token iri is used where a value is an IRI rather than a typed literal.

Appendix D: Glossary¶

Artifact — a CEDAR template, element, field, or instance.

Schema artifact — an artifact that describes the shape of metadata: a template, element, or field.

Instance artifact — an artifact that holds metadata: a template instance or element instance.

Template — a complete metadata specification, built from elements and fields.

Element — a reusable, nestable group of elements and fields.

Field — an atomic unit that collects one value or a list of values.

Instance — filled-in metadata conforming to a template.

Controlled term — a value drawn from a controlled vocabulary, identified by an IRI.

Value constraint — a declaration of the terms a controlled-term field may take.

Attribute-value field — a field whose instance author supplies both the attribute names and their values.

Provenance — the record of who created and modified an artifact, and when.

Key — for a nested child, the name identifying it within its parent and binding its value in an instance.