OpenMath Content Dictionary: meta

Canonical URL:
http://www.openmath.org/cd/meta.ocd
CD File:
meta.ocd
CD as XML Encoded OpenMath:
meta.omcd
Defines:
CD, CDComment, CDDate, CDDefinition, CDName, CDReviewDate, CDRevision, CDStatus, CDURL, CDUses, CDVersion, CMP, Description, Example, FMP, Name
Date:
2001-03-12
Version:
2
Review Date:
2003-04-01
Status:
official

This is a content dictionary to represent content dictionaries, so that they may be passed between OpenMath compliant application in a similar way to mathematical objects.

The information written here is taken from chapter 4 of the current draft of the "OpenMath Standard".


CD

The top level element for the Content Dictionary. It just acts as a container for the elements described below.

Signatures:
sts


[Next: CDDefinition] [Last: FMP] [Top]
For those that do not have access to the DTD, the elements
allowed in a Content Dictionary are the following
(in no particular order):


<CD>
<CDName> </CDName>
<Description> </Description>
<CDReviewDate> </CDReviewDate>
<CDDate> </CDDate>
<CDVersion> </CDVersion>
<CDRevision> </CDRevision>
<CDStatus> </CDStatus>
<CDURL>? </CDURL>
<CDUses>? <CDUses>
<CDDefinition>*
<Name> </Name>
<Description> </Description>
<Example>* </Example>
<FMP>* </FMP>
<CMP>* </CMP>
</CDDefinition>


where a question mark (?) denotes it can be repeated 0 or 1 times, and a star
(*) denotes 0 or more times. <CDComment> </CDComment>
 can also occur in most places - see the DTD for the precise rules.

CDDefinition

This symbol is used to represent the element which contains the definition of each symbol in a content dictionary. That is: it must contain a 'Name' element and a 'Description' element, and it may contain an arbitrary number of 'Example', 'FMP' or 'CMP' elements.

Signatures:
sts


[Next: CDName] [Previous: CD] [Top]

CDName

An element which contains the string corresponding to the name of the CD. The string must match the syntax for CD names given in the OpenMath Standard. Here and elsewhere white space occurring at the beginning or end of the string will be ignored.

Signatures:
sts


[Next: CDURL] [Previous: CDDefinition] [Top]

CDURL

An optional element. If it is used it contains a string representing the URL where the canonical reference copy of this CD is stored.

Signatures:
sts


[Next: Example] [Previous: CDName] [Top]

Example

An element which contains an arbitrary number of children, each of which is either a string or an OpenMath Object.

These children give examples in natural language, or in OpenMath, of the enclosing symbol definition.

Signatures:
sts


[Next: CDDate] [Previous: CDURL] [Top]

CDDate

An element which contains a date as a string in the ISO-8601 YYYY-MM-DD format. This gives the date at which the Content Dictionary was last edited.

Signatures:
sts


[Next: CDVersion] [Previous: Example] [Top]

CDVersion

An element which contains a version number for the CD. This should be a non negative integer. Any change to the CD that affects existing OpenMath applications that support this CD should result in an increase in the version number.

Signatures:
sts


[Next: CDRevision] [Previous: CDDate] [Top]

CDRevision

An element which contains a revision number (or minor version number) This should be a non-negative integer starting from zero for each new version. Additional examples would be typical changes to a CD requiring a new revision number.

Signatures:
sts


[Next: CDReviewDate] [Previous: CDVersion] [Top]

CDReviewDate

An element which contains a date as a string in the ISO-8601 YYYY-MM-DD format. This gives the date at which the Content Dictionary is next scheduled for review. It should be expected to be stable until at least this date.

Signatures:
sts


[Next: CDStatus] [Previous: CDRevision] [Top]

CDStatus

An element giving information on the status of the CD. The content of the element must be one of the following strings.

official (approved by the OpenMath Society),

experimental (currently being tested),

private (used by a private group of OpenMath users), or

obsolete (an obsolete CD kept only for archival purposes).

Signatures:
sts


[Next: CDComment] [Previous: CDReviewDate] [Top]

CDComment

This symbol is used to represent the element of a content dictionary which explains some aspect of that content dictionary. It should have one string argument which makes that explanation.

Signatures:
sts


[Next: CDUses] [Previous: CDStatus] [Top]

CDUses

An element which contains zero or more CDNames which correspond to the CDs that this CD depends on, i.e. uses in examples and FMPs. If the CD is dependent on any other CDs they must be present here.

Signatures:
sts


[Next: Description] [Previous: CDComment] [Top]

Description

An element which contains a string corresponding to the description of either the CD or the symbol (depending on which is the enclosing element).

Signatures:
sts


[Next: Name] [Previous: CDUses] [Top]

Name

An element containing the string corresponding to the name of the symbol being defined. This must match the syntax for symbol names given in the OpenMath Standard. Here and elsewhere white space occurring at the begining or end of the string will be ignored.

Signatures:
sts


[Next: CMP] [Previous: Description] [Top]

CMP

An optional element (which may be repeated many times) which contains a string corresponding to a property of the symbol being defined.

Signatures:
sts


[Next: FMP] [Previous: Name] [Top]

FMP

An optional element which contains an OpenMath Object. This corresponds to a property of the symbol being defined.

Signatures:
sts


[First: CD] [Previous: CMP] [Top]