XLIST:
Attributes


BUILTIN

An important mechanism for specification of the generic ELEMENTs (XVAR, ARRAY, XLIST) is the BUILTIN attribute. Only certain values are given in the DTD (through *.ent files) and these are used to specify the type or use of the element. BUILTIN values can also be added by included DTDs. Postprocessing software must be able to interpret the values of BUILTINs - and there are about 100 such. Failing this, they should pass the values to the application program.

An example is BUILTIN="X2" for the 2-dimensional coordinates of an atomic array in the MOL.DTD DTD or BUILTIN="MATRIX" to require an ARRAY to be treated as a matrix. The mechanics of inclusion in the DTD is quite involved (hopefully hidden!), and the possible values of the attribute are provided in files (*-arr.ent, *-list.ent, *-var.ent) in the main DTD directory.

NOTE: The files referred to should always be taken as the primary enumeration of BUILTIN values; unfortunately due to limitations of SGML and the dtd2html software in this particular instance, they can't be automatically documented yet.

The potential values of BUILTIN will usually be described under the appropriate GI; often this contains an XVAR or similar subelement which has a builtin attribute. Thus the MATRIX example above will be documented under ARRAY, whilst X2 is under ATOMS.

Value(s)

Default Value

#IMPLIED

COLUMNS

Number of coumns in TABLE

Value(s)

NUMBER

Default Value

#IMPLIED

CONTENT

STRUCT, ARRAY, TABLE, GRAPH, NODE (see above)

Value(s)

Default Value

#IMPLIED

CONVENTION

Convention for reserved names. This will normally be the name of a glossary or of a standard. It is expected that all chemical/x-* can be identied through this attribute. If omitted its value is "" which is interpreted as "LOCAL" (i.e. no communal semantics are imposed, though collaborating partners may use this if appropriate.) It is likely that a standard list of conventions will become available.

In certain contexts the CONVENTION defaults to a TecML-specific value. Thus DICTNAME within TERMENTRY refers to ISO12620 by default, and within the UNITS glossary to that glossary. In general, however, authors cannot assume any default other than the reserved values "" or LOCAL.

Value(s)

CDATA

Default Value

#IMPLIED

DICTNAME

Reserved name (in a dictionary or glossary). XVAR, ARRAY and XLIST are made specific through the use of DICTNAME, which should be in a dictionary or glossary. These may be 'official' (e.g. from a standards body, learned society, etc.) and some may be specifically mentioned in CML (e.g. every chemical/x-* type should have its own glossary). The glossary/dictionary should be identified through the CONVENTION attribute.

Processing applications are under no obligation to process DICTNAME, but in that case should pass it to other applications.

Value(s)

CDATA

Default Value

#IMPLIED

DISPLAY

Hints to the rendering program on how to display the data. Possibilities might be GRAPH, SPREADSHEET, etc. This does NOT affect the data. The semantics are yet to be decided.

Value(s)

CDATA

Default Value

#IMPLIED

HREF

The HREF attribute is inherited from HTML2.0 and is used consistently throughout CML. It serves as the tail of a hyperlink, whose semantics are being developed by Murray Maloney and others of the HTML-WG as an Internet draft.

Here is some more information.

Value(s)

CDATA

Default Value

#IMPLIED

METHODS

Operations on destination (advisory) (HTML 2.0) (I don't understand or use this)

Value(s)

NAMES

Default Value

#IMPLIED

NAME

NAME specifies the target of a hyperlink and must be unique within a document. It is used in the same way as in HTML, but note that whereas the A element appears to refer to a point in a document, all CML elements are containers and their extent is clearly defined. Here is some more information.

Value(s)

CDATA

Default Value

#IMPLIED

REL

The REL attribute is inherited from HTML2.0 and is used consistently throughout CML. It describes the target of a hyperlink, whose semantics are being developed by Murray Maloney and others of the HTML-WG as an Internet draft.

The use of REL is under review (Jan 1997). At present it has not been used as the CML addressing mechanisms are more advanced.

Value(s)

NAMES

Default Value

#IMPLIED

REV

The REV attribute is inherited from HTML2.0 and is used consistently throughout CML. It describes the backwards relationship of a hyperlink, whose semantics are being developed by Murray Maloney and others of the HTML-WG as an Internet draft.

At present CML does not specify a use and it should evolve in parallel with what the WWW community decides.

Value(s)

NAMES

Default Value

#IMPLIED

ROWS

Number of rows in TABLE

Value(s)

NUMBER

Default Value

#IMPLIED

SIZE

Number of contained items (without XHTML)

Value(s)

NUMBER

Default Value

#IMPLIED

STRUCT

Name ('typedef') of STRUCT

Value(s)

CDATA

Default Value

#IMPLIED

TITLE

The TITLE attribute is inherited from HTML2.0 and is used consistently throughout CML. In HTML 2.0 it is advisory only, but you are encouraged to use it in CML since it is used to label many of the displays, tables, etc. Virtually all CML elements have this attribute.

The attribute value of TITLE is searchable, but may be better as contents of an XVAR in some cases.

Value(s)

CDATA

Default Value

#IMPLIED

TYPE

The type of the content (XVAR or ARRAY). Applications and postprocessors should interpret the TYPE and transform the content if necessary. All defaults and error actions are presently undefined. At present TYPE is chosen from:

DATE.
An ISO-6501 date (e.g. 1995-09-23) or time (or both).
FLOAT.
A real number (with or without decimal point). It is NOT related to the use of float in C, java or other languages and may hold any legal value.
ID.
An ID (of any sort). NOT an SGML ID.
INTEGER.
An integer. No limits to size.
STRING.
A string. If the string contains whitespace, it should be quoted with ' or ". If it has embedded quotes, use the other sort. STRING is the default value for TYPE.
URL.
A URL. Unlike the HREF mecahism, it is the content which represents the URL.
EMAIL.
An E-mail address.
SYMBOL.
A symbolic value (not yet implemented).
ADDRESS.
An address within the TecML/CML document. (Do NOT confuse with a postal or e-mail address!). This is normally the value of a NAME attribute (as in HTML) but with optional subaddresses in the addressed object. these subadresses can either be a single subobject, or a range. Examples (which define the notation) are:
<XVAR TYPE="ADDRESS">MOL1</XVAR> (a whole object)
<XVAR TYPE="ADDRESS">MOL1:3</XVAR> (the 3rd subobject)
<XVAR TYPE="ADDRESS">MOL1:3-5</XVAR> (the 3,4,5th subobjects)
<ARRAY TYPE="ADDRESS">MOL1:3-5 SPECTRUM:19</ARRAY> as above, with the 19th subobject of another object

The definitive list of ARRAY types is kept in the file x-type.ent. These types are available to the elements, ARRAY, XLIST and XVAR. If TYPE is not given a value, it defaults to "", which is interpreted as STRING.

It's up to the application how TYPE is treated.

Value(s)

CDATA

Default Value

#IMPLIED

URN

Permanent address of destination (HTML 2.0) (I don't use this)

Value(s)

CDATA

Default Value

#IMPLIED
Back to XLIST


cml DTD