◇◆
Introduction to Attributes
This section describes each attribute used in the Balisage Conference Paper Tag Set
and the XHTML-inspired table model. The attributes in this Tag Library are described
in alphabetical
order by their attribute names (i.e., attribute type names). The attribute name is
the machine-readable name used in tagged documents, XML vocabularies, and by software;
for example, the attribute name “@align” is used for the attribute
named “Alignment”.
Content of an Attribute Page
Each attribute is described by a single page, which displays:
- The attribute’s name followed by a longer descriptive name (all on one line), and
- Sections describing aspects of the attribute its usage, and the elements to which it can be attached. Not all attributes will show all sections.
The sections within the page always appear in the following order (if present):
Description (untitled)
|
Contains a narrative description of the attribute. This is not a formal
dictionary definition, but more an explanation of what the attribute means, what
type of information it provides, or how it can be used.
|
---|---|
Usage/Remarks
|
Discusses expected uses for the attribute, such as when or why it might be used
or how to determine its value. Also provides additional information about the attribute,
such as similar or
contrasting attributes, processing information, or material about the base element.
Best Practice notes are identified with a heading such as “Best Practice” or “Common
Practice” and have a colored background for emphasis.
Authoring Notes are usage instructions aimed at persons writing or editing conference
papers according to this Tag Set. These notes may identify distinctions between the
authoring model available to authors and the production model used during the editorial
process, or they may provide information about an element’s display in output, including
any generated text resulting from the use of an attribute or a specific attribute
value.
More complex “Usage/Remarks” sections may contain folded (collapsed) subsections.
Instructions on navigating in this document, including opening and closing collapsed
sections, appear in Navigation.
|
OPTIONAL on/REQUIRED on
|
These two sections list the elements that take this attribute as optional and those
that require this attribute. These sections perform three functions:
If the attribute can be used in more than one way, or with several slightly different
meanings on different elements, there will be more than one “OPTIONAL on” or “REQUIRED
on” section.
Value and Meaning — Inside each “OPTIONAL on” or “REQUIRED on” section is an Attribute Value Table
that lists the possible values of the attribute in that element context and explains
selected values.
This table typically contains two columns. Each row in the table describes one
value, where:
Restriction — The last row of the table contains either with the word “Restriction” or the words
“Default value”.
“Restriction” indicates whether the attribute must be
supplied when the relevant element is used or is optional and may be given on the element. “Default value” indicates the value of the attribute that
will be used (by systems that read the schema) when the document does not supply a
value.
|
Example
|
Provides an excerpt of a tagged XML document, showing use of the current attribute.
An attribute is shown in the context of one of its elements, with the current
attribute highlighted in bold.
|