dtsdldtd(other)

NAME
dtsdldtd — Semantic Delivery Language (SDL) format and semantics

DESCRIPTION

Semantic Delivery Language (SDL) is defined by a Standard Generalized Markup Language (SGML) document type description (DTD). The language uses generalized presentation-oriented markup and excludes typical SGML features that may prevent performance-oriented, on-line delivery systems from using the language.

  Dependencies

None.

  Issues

None.

TOP LEVEL ELEMENTS

SDLDOC

  Purpose

The top of the document hierarchy.

SYNOPSIS
&<!ELEMENT sdldocT{
- - (vstruct, head*, snb?, virpage+)
>
T}
__
&<!ATTLIST sdldoc
pub-idCDATA#REQUIRED
doc-idCDATA#REQUIRED
timestmpCDATA#REQUIRED
first-pageIDREF#IMPLIED
productCDATA#IMPLIED
prodpnCDATA#IMPLIED
prodverCDATA#IMPLIED
licenseCDATA#IMPLIED
languageCDATA#IMPLIED
charsetCDATA#IMPLIED
authorCDATA#IMPLIED
versionCDATA#IMPLIED
sdldtdCDATA#REQUIRED
srcdtdCDATA#IMPLIED >
tgroup dispwid="5.39in"

DESCRIPTION

The document element, sdldoc, is the top of the document hierarchy. There are several attributes used in identifying the applicability of this document. Version and language attributes list options available for qualifying selected sections of the document.

The attributes of sdldoc are:
pub-idCDATARequiredT{
The public identifier is used to represent
a document. It is analogous to a part number.
T}
doc-idCDATARequiredT{
The document identifier is specific to this
version (instance) of a document. It is analogous to a manufacturing part
number.
T}
timestmpCDATARequiredT{
The time stamp distinguishes documents that
have not changed enough to warrant a new doc-id, but might need some bookmark/annotation
cleanup or repair.
T}
first-pageIDREFOptionalT{
If specified, the first-page
attribute identifies the virtual page to display upon first entering the
document.
T}
productCDATAOptionalT{
A description of the product this document
describes.
T}
prodpnCDATAOptionalT{
The part number of the product this document
describes.
T}
prodverCDATAOptionalT{
The version level of the product this document
describes.
T}
licenseCDATAOptionalT{
Product license information. By default,
no license restrictions are applied.
T}
languageCDATAOptionalT{
The default language of the document. This
attribute may be overridden in later elements. The language attribute and the charset
attribute of elements are used to select the proper font for display.
T}
charsetCDATAOptionalT{
The default character set of the document.
This attribute may be overridden in later elements. The charset attribute and the language
attribute are used to select the proper font for display.
T}
authorCDATAOptionalT{
The source author or publisher of the document.
T}
versionCDATAOptionalT{
The default version of this document. This
attribute may be overridden in later elements.
T}
sdldtdCDATARequiredT{
The version level of the SDL DTD to which
this document conforms. This attribute is specified as &<major>.&<minor>
version. For example, 1.0. A change in the minor version
number implies a change that is backward compatible, albeit with potentially
reduced functionality in an older viewer. A change in the major version implies
an incompatible change to the DTD.
T}
srcdtdCDATAOptionalT{
The name of the DTD to which the source document
conformed.
T}

VSTRUCT

  Purpose

The container for all generated elements.

SYNOPSIS
&<!ELEMENT vstructT{
- - (loids, toss?, lophrases?, index?,
rel-docs?, rel-file?, notes?) >
T}
__
tgroup dispwid="6.09in"
&<!ATTLIST vstructversionCDATA#IMPLIED
doc-idCDATA#REQUIRED>

DESCRIPTION

The vstruct element is a container for all generated elements. Generated elements are items such as a list of identifiers in the document, a table of semantics and styles, and an index. The contents of this element are the normalized navigation information elements generated by the conversion process. No actual document content should be encoded within these elements.

The attributes of vstruct are:
versionCDATAOptionalT{
The version of this element. By default,
the version of the vstruct is the same as the version of
the document (sdldoc).
T}
doc-idCDATARequiredT{
The document identifier of the document to
which this element belongs.
T}
tgroup dispwid="5.75in"

VIRPAGE

  Purpose

The smallest directly addressable unit in a document.

SYNOPSIS
&<!ELEMENT virpageT{
- - (head*, snb?, (block | form)*)
>
T}
__
&<!ATTLIST virpageidID#REQUIRED
levelNUMBER#REQUIRED
versionCDATA#IMPLIED
languageCDATA#IMPLIED
charsetCDATA#IMPLIED
doc-idCDATA#REQUIRED
ssiCDATA#IMPLIED >
tgroup dispwid="5.39in"

DESCRIPTION

The virtual page ( virpage) element is the smallest, directly addressable unit in a document. It corresponds to a topic. Ideally, documents presented on-line (and perhaps even on paper) should be organized into small topics that are complete unto themselves. This allows readers to find and access the desired information.

A virtual page contains all information necessary to establish a formatting context. Virtual pages may be displayed and understood when removed from the context of the document as long as the table of semantics and styles ( toss) element is available for formatting information.

A virtual page may have zero or more head elements that provide title information and may also be used in display decoration, such as a title bar. The first head of a virtual page is intended to be displayed in a table of contents for the document.

Following the head elements is an optional system notation block ( snb). The system notation block, which provides access to objects external to the document, is covered later in this document.

Finally, a virtual page may contain any combination of block or form elements, including none.

The attributes of virpage are:
idIDRequiredT{
The identifier of the virtual page. The id attribute must be a valid SGML identifier and must be unique
within the document. To display a virtual page, hyperlink to this id.
T}
levelNUMBERRequiredT{
The hierarchical level of the information
contained in the element. The level attribute
makes explicit information that is implicit in typical SGML conforming documents.
An SDL conforming document may be considered to have been flattened to allow
direct access of inferior topics. For example, if the source DTD specified
divisions such as chapter, d1, d2, these would all appear in the SDL version of the document as
virtual pages but with levels of 1, 2
and 3, respectively.
T}
versionCDATAOptionalT{
The version of this element. By default,
the version of the virpage is the same as the version of
the document (sdldoc).
T}
languageCDATAOptionalT{
The language in which this element is written.
This attribute may be overridden individually within the form
and block elements contained in the virtual page.
T}
charsetCDATAOptionalT{
The default character set of the document.
This attribute may be overridden individually within the form
and block elements contained in the virtual page.
T}
doc-idCDATARequiredT{
The document identifier of the document to
which this element belongs.
T}
ssiCDATAOptionalT{
A source semantic identifier. This identifier
is chosen by the author of a higher level DTD or other source to SDL translator.
It may either reflect the meaning of the markup in the original document
or may reflect the actual generic identifier in the original document. The
source semantic identifier may be used to assist in semantic searches of
the SDL conforming document by preserving the original intent of the markup.
When the original markup was conforming to a domain specific DTD, the ssi may be used to enable structured searches of the SDL conforming
document by preserving the original generic identifiers.
T}
tgroup dispwid="6.19in"

The level and ssi attributes of the virtual page are used to look up formatting and semantic information in the table of semantics and styles ( toss) element covered later in this document.

SNB

  Purpose

The container for all references to objects external to the document.

SYNOPSIS
&<!ELEMENT snbT{
- - (head?, (graphic | text | audio
| video |animate | crossdoc | man-page | textfile | sys-cmd | callback | script
| switch)+) >
T}
__
tgroup dispwid="6.39in"
&<!ATTLIST snbversionCDATA#IMPLIED >
____
tgroup dispwid="5.39in"

DESCRIPTION

The system notation block ( snb) provides a container for elements that access data that are not in SGML notation. The one exception to this rule is the text element. The text element is in the system notation block because it is intended for use as a rich text alternative to other elements in the snb when elements are tried in turn during the instantiation of a system notation reference ( snref) looking for an alternative that can be formatted on the current system.

Data in the system notation block are not intended to be presented to the reader in the order that they appear in the document. The structural position of each snb element is established by a system notation reference.

Collecting all elements that require system resources at the top of the virtual page allows an application to marshal these resources before they are referenced. This gives the application the ability to alter the presentation of both the element and its reference based on the availability and performance of the required system resources.

The optional head element may be used by an application when presenting a list of required resources for a document.

The attribute of snb is:
versionCDATAOptionalT{
The version of this element. By default,
the version of the snb is the same as the version of the
document (sdldoc).
T}
____
tgroup dispwid="6.27in"

BLOCK

  Purpose

The basic unit of display style.

SYNOPSIS
&<!ELEMENT block- - (head*, (p | cp)*) >
__
&<!ATTLIST blockidID#IMPLIED
levelNUMBER#IMPLIED
versionCDATA#IMPLIED
class(table|
cell|
list|
item|
text|
udeffrmt)#IMPLIED
languageCDATA#IMPLIED
charsetCDATA#IMPLIED
lengthNUMBER#IMPLIED
app(all|
help|
tutorial|
ref|
sys)#IMPLIED
timing(sync|
async)#IMPLIED
ssiCDATA#IMPLIED >

DESCRIPTION

Blocks are the basic unit of display style. All data within a block are rendered in the style of the block that contains them. Blocks may contain zero or more head elements followed by zero or more paragraphs ( p) or character paragraphs ( cp).

Structurally, blocks contain a set of logically related paragraphs. A block identifies a display chunk, not document hierarchy elements. Blocks have an inherently flat structure; blocks do not nest. The presentational effect of nested blocks can be achieved by using the level attribute.

The structure of a document includes blocks that are part of the principal view and, optionally, blocks that form an alternate view. The principle view makes the assumption that primary blocks are presented in order as the sequential content of the document. That is, when taken in order the primary blocks compose the principle view of the document. For the purpose of this language, the principle view is the same as the traditional, printed view.

An alternate block is asynchronous to the primary document order. Alternate blocks may represent traditional, asynchronous elements such as a footnote or a spread, or some additional documentation (a teacher's section of a combined teacher/student manual, for example.) Alternate content blocks should only be included in the primary content by reference.

The level, class and ssi attributes of a block can be used to look up formatting and semantic information in the table of semantics and styles ( toss) element (covered later in this document).

The attributes of block are:
idIDOptionalT{
The identifier of the block.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
levelNUMBEROptionalT{
The hierarchical level of the information
contained in the element. The level attribute
makes explicit information that is implicit in typical SGML-conforming documents.
An SDL-conforming document may be considered to have been flattened with
implicit block nesting information stored in the
level attribute.
T}
versionCDATAOptionalT{
The version of this element. By default,
the version of the block
is the same as the version of the document
(sdldoc) unless that version
has been overridden by a version attribute
in the virtual page (virpage) or form
(covered later in this document) containing the block.
T}
classtableOptionalT{
The class
of a block describes the general
T}
cellT{
purpose the block is filling.
The class attribute is
T}
listT{
used in conjunction with the level and ssi
T}
itemT{
attributes to perform a lookup in the table
of
T}
textT{
semantics and styles (toss)
element. The result of
T}
udeffrmtT{
that lookup is formatting and semantic information
pertaining to the block.
T}
languageCDATAOptionalT{
The language in which this block was written.
T}
charsetCDATAOptionalT{
The character set of this block. The language and charset attributes plus information retrieved from the table of
semantics and styles (toss) element are used to select
the font for the block.
T}
lengthNUMBEROptionalT{
By default, the length of a block is determined dynamically as
a function of its content and rendering style. If a length value is present, it describes the length of the block in terms of current style lines.
T}
appallOptionalT{
The app
attribute is used for selective presentation of a block.
This attribute defaults to all.
T}
help
tutorial
ref
sys
timingsyncOptionalT{
The timing attribute
defaults to sync.
T}
asyncT{
A block with a timing attribute of async is only displayed when referenced via
an IDREF (or IDREFS). For example, an async block may
be referenced by the cells attribute of frowvec to repeat the block without reentering its data content.
T}
ssiCDATAOptionalT{
A source semantic identifier. This identifier
is chosen by the author of a higher level DTD to SDL translator. It may
either reflect the meaning of the markup in the original document or it may
reflect the actual generic identifier in the original document. The source
semantic identifier may be used to assist in semantic searches of the SDL-conforming
document by preserving the original intent of the markup. When the original
markup conforms to a domain-specific DTD, the ssi may
be used to enable structured searches of the SDL-conforming document by preserving
the original generic identifiers.
T}
tgroup dispwid="6.49in"

FORM

  Purpose

A two dimensional array of block and/or form elements.

SYNOPSIS
&<!ELEMENT formT{
- - (head*, (fstyle, fdata) | (fdata,
fstyle)) >
T}
__
tgroup dispwid="5.28in"
&<!ATTLIST formidID#IMPLIED
levelNUMBER#IMPLIED
versionCDATA#IMPLIED
class(table|
cell|
list|
item|
text|
udeffrmt)#IMPLIED
languageCDATA#IMPLIED
charsetCDATA#IMPLIED
lengthNUMBER#IMPLIED
app(all|
help|
tutorial|
ref|
sys)#IMPLIED
ssiCDATA#IMPLIED >

DESCRIPTION

The form element is a generalized representation of a data element that is partially preformatted. The form element is designed to be rendered in real time and automatically derived from typical SGML table markup. Uses include tables, lists and labeled lists. Generally, a form may be used to represent any information that is layout sensitive or contains data to be presented in a two dimensional matrix.

A form is made up of zero or more head elements followed either by a form style ( fstyle) and the form data ( fdata) or the form data followed by the form style.

The attributes of form are:
idIDOptionalT{
The identifier of the form.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
levelNUMBEROptionalT{
The hierarchical level of the information
contained in the element. The level attribute
makes explicit information that is implicit in typical SGML-conforming documents.
An SDL-conforming document may be considered to have been flattened with
implicit form nesting information stored in the
level attribute.
T}
versionCDATAOptionalT{
The version of this element. By default,
the version of the form
is the same as the version of the document
(sdldoc) unless that version
has been overridden by a version attribute
in the virtual page (virpage) containing the form.
T}
classtableOptionalT{
The class
of a form describes the general
T}
cellT{
purpose the form is filling.
The class attribute is used in conjunction
with the level and
T}
listT{
ssi attributes to perform
a lookup in
T}
itemT{
the table of semantics and styles ( toss)
T}
textT{
element. The result of that lookup is formatting
T}
udeffrmtT{
and semantic information pertaining to the form.
T}
languageCDATAOptionalT{
The language in which this form was written.
T}
charsetCDATAOptionalT{
The character set of this form.
The language and charset attributes plus information retrieved from the table of
semantics and styles (toss) element are used to select
the font for the form.
T}
lengthNUMBEROptionalT{
By default, the length of a form is determined dynamically as
a function of its content and rendering style. If a length value is present, it describes the length of the form in terms of current style lines.
T}
appallOptionalT{
The app
attribute is used for selective
T}
helpT{
presentation of a form.
This attribute defaults
T}
tutorialto all.
ref
sys
ssiCDATAOptionalT{
A source semantic identifier. This identifier
is chosen by the author of a higher level DTD to SDL translator. It may
either reflect the meaning of the markup in the original document or it may
reflect the actual generic identifier in the original document.
T}
tgroup dispwid="6.21in"

FSTYLE

  Purpose

Specify the style of a form.

SYNOPSIS
&<!ELEMENT fstyle- - (frowvec+) >
__

DESCRIPTION

The form style (fstyle) element specifies the style of the form. It is composed of one or more row reference vectors (frowvec). The list of cell id references in the reference row vectors establishes the relationship between the position and data block for a cell.

The form style element and formstyle element in the table of semantics and styles (toss) element (covered later in this document) contain information regarding the presentational style of the form. Cell-specific style and style attributes beyond those provided in the reference vectors must be specified in the data blocks that contain the cell data.

The attribute of fstyle is:
ncolsNUMBEROptionalT{
The number of columns in the form. This attribute should be a number greater than zero. Unless
overridden by a column width (colw) specification in
the toss, the available space is divided evenly among
the columns. Unless overridden by a column justification (colj)
specification in the toss, the block
and/or form elements in the form are
left justified in their cells.
T}
____

FROWVEC

  Purpose

Describes the style of a row and contains ID references to the contents of the row.

SYNOPSIS
&<!ELEMENT frowvec- O EMPTY >
__
&<!ATTLIST frowvechdr(YES|NO)#IMPLIED
cellsIDREFS#REQUIRED >
tgroup dispwid="5.39in"

DESCRIPTION

The reference row vector ( frowvec) describes the style of a row in a form and contains pointers (id references) to the contents of the row. There must be a row vector per row in the form.

The hdr attribute designates the entire row as a head row. Heads are significant because a display program might need to manage the display of heads differently than it does the data matrix. This is particularly true if the form must scroll, covers multiple screens or is displayed as a graph.

The attributes of frowvec are:
hdryesOptionalT{
Indicates whether or not the associated row
is a head row.
T}
no
cellsIDREFSRequiredT{
A list of id references to the block or form elements in the fdata element that make up the cell contents of this form.
T}
tgroup dispwid="6.00in"

Within a form element, spanning of rows or columns is done by repeating the appropriate id reference in the cells attribute of the frowvec. If the data is to be repeated in multiple unspanned cells, the block must be repeated and assigned unique identifiers.

The length of a row is the length of the cells in that row; the width is the cumulative width of each cell in that row. Row length may be determined at or before runtime. Typically, the length of a row is the length of the longest block or form in the row. There are two exceptions to this rule: the blocks or forms in the row can have an assigned length, or the id reference could be to an element that is not in the data container. These exceptional cells are referred to as virtual cells; virtual cells do not affect the length of the row.

Virtual cells may contain more data than can be displayed in the area assigned. Examples include blocks with the length set that contain long paragraphs, forms or figures. The actual display area of a virtual cell can be thought of as a viewport onto the data of a cell. Alternatively, virtual cells can use an information hiding technique such as an icon leading to a separate window.

The id references in a reference row may specify elements that are not in the data container of its form, even if the elements are not physically close. To protect the performance of the form element, references to data outside the current form may also be handled as virtual cells. The display program may take the liberty to replace any information referenced in a row vector that does not belong to the current form's data element with a link or icon.

FDATA

  Purpose

A container for information belonging solely to a form element.

SYNOPSIS
&<!ELEMENT fdata- - ((block | form)*) >
__

DESCRIPTION

The form data element ( fdata) is a container for information that belongs to a form. By default, without spanning and external references, form data is typically maintained in row major matrix form. Assumptions about the order of the block or form elements in the data area must not be used for anything except performance because the blocks are allowed to be represented in any order.

The fdata element has no attributes.

CONTAINER ELEMENTS

P

  Purpose

A paragraph.

SYNOPSIS
&<!ELEMENT pT{
- - (head*, (key | sphrase | rev
| if | spc | snref | anchor | link | #PCDATA)+) >
T}
__
tgroup dispwid="6.50in"
&<!ATTLIST pidID#IMPLIED
versionCDATA#IMPLIED
type(literal|
lined|
dynamic)#IMPLIED
ssiCDATA#IMPLIED >

DESCRIPTION

Paragraphs identify a formatting unit. Paragraphs collect information that needs to be rendered contiguously within a region. Paragraphs inherit style from their containing block although adjustments can be made by using the class and level attributes of the enclosing block plus the ssi attribute of the p to effect a lookup in the table of semantics and styles ( toss) element (covered later in this document).

Paragraphs may contain text, references and key phrases. The key element (discussed later in this document) may modify the style of a portion of a paragraph but the modification is always restricted to the current paragraph.

The attributes of p are:
idIDOptionalT{
The identifier of the p.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
versionCDATAOptionalT{
The version of this element. By default,
the version of the p is
the same as the version of the document ( sdldoc) unless that version has
been overridden by a version attribute in
the virtual page (virpage), form or block containing the p.
T}
typeliteralOptionalT{
Paragraph text may be either unformatted
or preformatted.
T}
linedT{
By default, paragraph text is assumed dynamic
(unformatted) to be
T}
dynamicT{
and all white space (space, tab, newline,
etc.) may be replaced with a single space. The type
attribute is used when the author needs to represent information
that is at least partially layout-sensitive. Newline characters are significant
in lined paragraphs and all whitespace is significant in literal paragraphs.
T}
ssiCDATAOptionalT{
A source semantic identifier. This identifier
is chosen by the author of a higher level DTD to SDL translator. It may
either reflect the meaning of the markup in the original document or it may
reflect the actual generic identifier in the original document. The source
semantic identifier may be used to assist in semantic searches of the SDL-conforming
document by preserving the original intent of the markup. When the original
markup was conforming to a domain specific DTD, the ssi
may be used to enable structured searches of the SDL conforming document
by preserving the original generic identifiers.
T}
tgroup dispwid="5.92in"

CP

  Purpose

A character paragraph.

SYNOPSIS
&<!ELEMENT cp- - (CDATA) >
__
&<!ATTLIST cpidID#IMPLIED
versionCDATA#IMPLIED
type(literal|
lined|
dynamic)#IMPLIED
ssiCDATA#IMPLIED >

DESCRIPTION

Character paragraphs are similar to paragraphs. The only difference is that markup contained in the text of a character paragraph is ignored. The only markup not ignored is the ``&</'' character pair. If that pair is to be included in the text, it must be preceded with an ampersand (&&).

The attributes of cp are:
idIDOptionalT{
The identifier of the p.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
versionCDATAOptionalT{
The version of this element. By default,
the version of the p is
the same as the version of the document ( sdldoc) unless that version has
been overridden by a version attribute in
the virtual page (virpage), form or block containing the p.
T}
typeliteralOptionalT{
Paragraph text may be either unformatted
or preformatted.
T}
linedT{
By default, paragraph text is assumed to
be dynamic (unformatted) and all white space
T}
dynamicT{
(space, tab, newline, etc.) may be replaced
with a single space. The type attribute is
used when the author needs to represent information that is at least partially
layout-sensitive. Newline characters are significant in lined paragraphs and
all whitespace is significant in literal paragraphs.
T}
ssiCDATAOptionalT{
A source semantic identifier. This identifier
is chosen by the author of a higher level DTD to SDL translator. It may
either reflect the meaning of the markup in the original document or it may
reflect the actual generic identifier in the original document. The source
semantic identifier may be used to assist in semantic searches of the SDL-conforming
document by preserving the original intent of the markup. When the original
markup was conforming to a domain-specific DTD, the ssi
may be used to enable structured searches of the SDL-conforming document
by preserving the original generic identifiers.
T}
tgroup dispwid="6.17in"

HEAD

  Purpose

Heading, label or caption.

SYNOPSIS
&<!ELEMENT headT{
- - ((key | sphrase | rev | if |
spc | snref | anchor | link | #PCDATA)*, subhead*) >
T}
__
tgroup dispwid="6.39in"
&<!ATTLIST headidID#IMPLIED
versionCDATA#IMPLIED
class(label|
head|
caption|
annotation|
phead|
udefhead)#IMPLIED
languageCDATA#IMPLIED
charsetCDATA#IMPLIED
type(literal|
lined|
dynamic)#IMPLIED
abbrevCDATA#IMPLIED
ssiCDATA#IMPLIED >

DESCRIPTION

Heads are phrase-like elements that are associated with the entire section that contains it. Heads may contain zero or more subhead elements followed by zero or more paragraphs.

The head element may also be used as the caption of a graphic (covered later in this document).

The user-defined head ( udefhead) value is for use by the developer of a higher level DTD to SDL translator when an unexpected use for a head is found.

The attributes of head are:
idIDOptionalT{
The identifier of the head.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
versionCDATAOptionalT{
The version of this element. By default,
the version of the head
is the same as the version of the document
(sdldoc) unless that version
has been overridden by a version attribute
in the virtual page (virpage), form
or block containing the head.
T}
classlabelOptionalT{
The class
of a head describes the general purpose the head is filling.
T}
headThe class
attribute is used
captionT{
in conjunction with the level of the object
T}
annotationT{
containing the head and ssi attributes
T}
pheadT{
to perform a lookup in the table of semantics
T}
udefheadT{
and styles (toss) element.
The result of that lookup is formatting and semantic information pertaining
to the head.
T}
languageCDATAOptionalT{
The language in which this head was written.
T}
charsetCDATAOptionalT{
The character set of this head.
The language and charset attributes plus information retrieved from the table of
semantics and styles (toss) element are used to select
the font for the head.
T}
typeliteralOptionalT{
Head text may be either unformatted or preformatted.
T}
linedT{
By default, paragraph text is assumed to
be dynamic (unformatted)
T}
dynamicT{
and all white space (space, tab, newline,
etc.) may be replaced with a single space. The type
attribute is used when the author needs to represent information
that is at least partially layout-sensitive. Newline characters are significant
in lined heads and all whitespace is significant in literal heads.
T}
abbrevCDATAOptionalT{
An abbreviation allows simple and/or short
text to be associated with a head element. This text
may be used in situations where rich text is inappropriate or where the head is too long to use.
T}
ssiCDATAOptionalT{
A source semantic identifier. This identifier
is chosen by the author of a higher level DTD to SDL translator. It may
either reflect the meaning of the markup in the original document or it may
reflect the actual generic identifier in the original document. The source
semantic identifier may be used to assist in semantic searches of the SDL-conforming
document by preserving the original intent of the markup. When the original
markup conforms to a domain specific DTD, the ssi may
be used to enable structured searches of the SDL-conforming document by preserving
the original generic identifiers.
T}
tgroup dispwid="6.27in"

SUBHEAD

  Purpose

Alternate or additional headings, labels or captions.

SYNOPSIS
&<!ELEMENT subheadT{
- - ((key | sphrase | rev | if
| spc | snref | anchor | link | #PCDATA)*) >
T}
__
tgroup dispwid="6.49in"
&<!ATTLIST subheadidID#IMPLIED
versionCDATA#IMPLIED
class(label|
head|
caption|
annotation|
phead|
udefhead)#IMPLIED
languageCDATA#IMPLIED
charsetCDATA#IMPLIED
type(literal|
lined|
dynamic)#IMPLIED
abbrevCDATA#IMPLIED
ssiCDATA#IMPLIED >
tgroup dispwid="5.81in"

DESCRIPTION

Subheads are simply one or more phrase-like elements that further refine the main head.

The attributes of subhead are:
idIDOptionalT{
The identifier of the subhead.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
versionCDATAOptionalT{
The version of this element. By default,
the version of the subhead is the same as the version
of the document (sdldoc) unless that
version has been overridden by a
version attribute in the virtual page
(virpage), form, block
or head containing
the subhead.
T}
classlabelOptionalT{
The class
of a subhead describes the general
T}
headT{
purpose the subhead is
filling. The class attribute is used in conjunction
with
T}
captionT{
the level
of the object containing the head to
T}
annotationwhich the subhead belongs
and ssi
pheadT{
attributes to perform a lookup in the table
of semantics and styles (toss) element.
T}
udefheadT{
The result of that lookup is formatting and
semantic information pertaining to the subhead.
T}
languageCDATAOptionalT{
The language in which this subhead was written.
T}
charsetCDATAOptionalT{
The character set of this subhead. The language and charset attributes plus information retrieved from the table of
semantics and styles (toss) element are used to select
the subhead font.
T}
typeliteralOptionalT{
Subhead text may be either unformatted or
preformatted.
T}
linedT{
By default, subhead text is assumed to be
dynamic (unformatted)
T}
dynamicT{
and all white space (space, tab, newline,
etc.) may be replaced with a single space. The type
attribute is used when the author needs to represent information
that is at least partially layout-sensitive. Newline characters are significant
in lined subheads and all whitespace is significant in
literal subheads.
T}
abbrevCDATAOptionalT{
An abbreviation allows simple and/or short
text to be associated with a subhead element. This text
may be used in situations where rich text is inappropriate or where the subhead is too long to use.
T}
ssiCDATAOptionalT{
A source semantic identifier. This identifier
is chosen by the author of a higher level DTD to SDL translator. It may
either reflect the meaning of the markup in the original document or it may
reflect the actual generic identifier in the original document. The source
semantic identifier may be used to assist in semantic searches of the SDL-conforming
document by preserving the original intent of the markup. When the original
markup conforms to a domain specific DTD, the ssi may
be used to enable structured searches of the SDL-conforming document by preserving
the original generic identifiers.
T}
tgroup dispwid="6.10in"

ATOMIC LINK ELEMENTS

ANCHOR

  Purpose

To give an ID to a point in the document.

SYNOPSIS
&<!ELEMENT anchor- O EMPTY >
__
&<!ATTLIST anchoridID#REQUIRED >
____

DESCRIPTION

The anchor element provides a mechanism for assigning an ID to an arbitrary spot in the document. An anchor may occur anywhere that running text is allowed. This includes as content of paragraphs ( p) and heads (head and subhead).

The attribute of anchor is:
idIDRequiredT{
The identifier of the anchor.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
____
tgroup dispwid="6.10in"

LINK

  Purpose

A hyperlink within or outside the current document.

SYNOPSIS
&<!ELEMENT linkT{
- - ((key | sphrase | rev | if
| spc | snref | anchor | link | #PCDATA)+) >
T}
__
tgroup dispwid="6.39in"
&<!ATTLIST linkridIDREF#REQUIRED
buttonIDREF#IMPLIED
linkinfoCDATA#IMPLIED
descriptCDATA#IMPLIED
window(current|
new|
popup)#IMPLIED
traversal(return|
noreturn)#IMPLIED
tgroup dispwid="5.90in"

DESCRIPTION

A link element is the start point of a hyperlink to another spot in the document or, via the system notation block ( snb), to another document or active hyperlink. The active hyperlinks are sys-cmd and callback. These hyperlinks (covered later in this document) are used to execute an operating system command or to initiate a callback to the application respectively.

A link may surround any text in the document, including text found in paragraphs or heads, with the only exception being that link elements may not contain other link elements.

The attributes of link are:
ridIDREFRequiredT{
The ID of the target of the hyperlink. The
ID specified must exist in the current document but may be to elements in
the system notation block (snb) of the current virtual
page (virpage) to allow reference to external objects or
actions.
T}
buttonIDREFOptionalT{
A graphic that may be displayed as a trigger
for the hyperlink in lieu of or in addition to highlighting the hyperlink
text itself. The ID referenced by the button
attribute must be the identifier of a graphic (covered later in this document)
in the system notation block (snb) of the current virtual
page (virpage). The graphic referenced must have a
class attribute of button.
T}
linkinfoCDATAOptionalT{
Information about the target of the link. This information may be displayed as part of a dialog with
the reader before traversing the link if such traversal
is in some way expensive in time.
T}
descriptCDATAOptionalT{
A general description of the action that
takes place when the hyperlink is activated.
T}
windowcurrentOptionalT{
By default, hyperlinking to another location
in
T}
newT{
this document or (via indirection) externally,
T}
popupT{
is done by changing the view in the current
window or display area. Specifying new for
the window attribute causes a new window
or display area to be created for displaying hyperlink target. Specifying
popup for this attribute causes the new window or
display area to be lighter weight, if possible. Often, popup windows are modal
and temporary.
T}
traversalreturnOptionalT{
By default, the current document and location
T}
noreturnT{
in the document are stored on a push down
stack to allow backtracking of hyperlinks. If this attribute is specified
as noreturn, the current location is forgotten on execution
of the link.
T}
tgroup dispwid="6.16in"

SNREF

  Purpose

Reference to an element or alternates in the system notation block ( snb).

SYNOPSIS
&<!ELEMENT snref- - (refitem+, alttext?) >
__
&<!ATTLIST snrefidID#IMPLIED >
____

DESCRIPTION

A system notation reference ( snref) is a reference to an external object. The result of resolving that object is that it is interpolated into the document at the point of the snref. The snref element references graphic and script elements, both of which are covered later in this document.

An snref element consists of one or more refitem elements followed by optional alternate text. Each refitem is tried in turn in the order specified until one can be successfully formatted and displayed. If none of the system notations can be successfully formatted and displayed, the alternate text, alttext, which is very simple character data, is displayed instead.

The attribute of snref is:
idIDOptionalT{
The identifier of the snref.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
____
tgroup dispwid="6.07in"

REFITEM

  Purpose

A reference to an element in a system notation block.

SYNOPSIS
&<!ELEMENT refitem- - (head*) >
__
&<!ATTLIST refitemridIDREF#REQUIRED
class(figure|
in-line|
button|
icon|
udefgraph|
table|
cell|
list|
item|
text|
udeffrmt)#REQUIRED
buttonIDREF#IMPLIED
ssiCDATA#IMPLIED >
tgroup dispwid="6.23in"

DESCRIPTION

A reference item ( refitem) is a single reference to an element in the system notation block ( snb) of the current virtual page ( virpage).

An snref consists of one or more refitem elements allowing alternate choices for the item to be displayed. The refitem elements are tried in turn in the order listed until one can be successfully formatted and displayed. A refitem can refer to a text element in the snb to allow a text alternative for the referenced item.

A refitem has zero or more head elements, which may serve, for example, as the caption of a graphic.

The attributes of refitem are:
ridIDREFRequiredT{
The identifier of the item being referenced
in the system notation block of the current virtual page.
T}
classfigureRequiredT{
The class
of a refitem describes the general purpose
T}
in-lineT{
the refitem is filling.
The class attribute is
T}
buttonT{
used in conjunction with the level of the enclosing
T}
iconT{
block, form
or virpage and ssi attributes to
T}
udefgraphT{
perform a lookup in the table of semantics
T}
tableT{
and styles (toss) element.
The result of that
T}
cellT{
lookup is formatting and semantic information
T}
listpertaining to the refitem.
item
text
udeffrmt
buttonIDREFOptionalT{
An optional reference to a graphic of class button in the snb of the current virpage. This button may be used to request refitem display
on systems where display of the item is slow or expensive in some other way.
That is, the button is displayed and the refitem is only displayed when the button
is activated.
T}
ssiCDATAOptionalT{
A source semantic identifier. This identifier
is chosen by the author of a higher level DTD to SDL translator. It may
either reflect the meaning of the markup in the original document or it may
reflect the actual generic identifier in the original document. The source
semantic identifier may be used to assist in semantic searches of the SDL-conforming
document by preserving the original intent of the markup. When the original
markup conforms to a domain specific DTD, the ssi may
be used to enable structured searches of the SDL-conforming document by preserving
the original generic identifiers.
T}
tgroup dispwid="6.28in"

ALTTEXT

  Purpose

Simple text alternative for snref.

SYNOPSIS
&<!ELEMENT alttext- - CDATA >
__

DESCRIPTION

The alttext element is a place to put simple text for use if all alternatives, including text replacements, from the list of refitem elements in an snref fail to format.

The alttext element has no attributes.

ATOMIC TEXT ELEMENTS

REV

  Purpose

Add change bars to displayed text.

SYNOPSIS
&<!ELEMENT revT{
- - ((key | sphrase | if | spc
| snref | anchor | link | #PCDATA)*) >
T}
__
tgroup dispwid="6.37in"

DESCRIPTION

Surrounding data with a rev element signals to the formatter that the surrounded data should be marked somehow as having undergone change. Typically, this mark is change bars on the side of the data. An empty rev element implies some text has been deleted.

The rev element has no attributes.

KEY

  Purpose

Effect a change in font.

SYNOPSIS

&<!ELEMENT key  - - ((key | sphrase | rev | if | spc | anchor | snref | #PCDATA)+) >

&<!ATTLIST keycharsetCDATA#IMPLIED
class(acro|
book|
emph|
jargon|
l10n|
name|
quote|
product|
termdef|
term|
mach-in|
mach-out|
mach-cont|
pub-lit|
udefkey)#REQUIRED
ssiCDATA#IMPLIED >
tgroup dispwid="5.92in"

DESCRIPTION

Key phrases are data that are key to understanding the paragraph in which they exist; that is, they have a special significance. The key element is used to call readers' attention to a particular phrase. The key element exists only within the context of a paragraph ( p); it is document sub-structure.

The semantics of the key element have value to both rendering and navigation. When rendered, the phrase is highlighted, typically using a different font style or attribute. In navigation, key data can be used as fields in semantic searches or as variables in a relevance-ranking algorithm.

There are an infinite variety of key phrases possible in source documents. To assure that the delivery system can fully use the semantics of key data, this delivery format forces the semantic to be normalized. Each phrase is required to have a class attribute as well as an optional source semantic identifier ( ssi).

The intended uses for the possible key classes are:

acro
    An acronym.

book
    The proper title of a document.

emph
    An emphasized phrase.

jargon
    A phrase with application unique significance; its definition is commonly understood by convention by the practitioner of the application field.

l10n
    A phrase that must be specially treated during localization.

name
    A proper name.

quote
    A direct quote.

product
    A proper product name.

pub-lit
    A literal phrase added by the publisher.

termdef
    A phrase defined within the current paragraph.

term
    A phrase defined elsewhere.

mach-in
    A machine input phrase.

mach-out
    A machine output phrase.

mach-cont
    A machine control or keyboard key name.

udefkey
    A user-defined key; this may be used by the author of a higher level DTD to SDL translator for unforeseen key phrases.

The attributes of key are:
charsetCDATAOptionalT{
The character set of this key.
The language of the enclosing paragraph
(p) and charset attributes
plus information retrieved from the table of semantics and styles ( toss) element are used to select the font for the key .
T}
classacroRequiredSee above.
book
emph
jargon
l10n
name
quote
product
pub-lit
termdef
term
mach-in
mach-out
mach-cont
udefkey
ssiCDATAOptionalT{
A source semantic identifier. This identifier
is chosen by the author of a higher level DTD to SDL translator. It may
either reflect the meaning of the markup in the original document or it may
reflect the actual generic identifier in the original document. The source
semantic identifier may be used to assist in semantic searches of the SDL-conforming
document by preserving the original intent of the markup. When the original
markup conforms to a domain-specific DTD, the ssi may
be used to enable structured searches of the SDL-conforming document by preserving
the original generic identifiers.
T}
tgroup dispwid="6.03in"

SPHRASE

  Purpose

A super or sub-scripted phrase

SYNOPSIS
&<!ELEMENT sphrase- - CDATA >
__
&<!ATTLIST sphraseclass(super|
sub)#REQUIRED
ssiCDATA#IMPLIED >

DESCRIPTION

The stylized phrase (sphrase) contains stylized text. The phrases are only presentationally significant. Two types are supported, sub and super.

The attributes of sphrase are:
stylesuperRequiredT{
Indicates whether the sphrase
should be set
T}
subin superscript or subscript.
ssiCDATAOptionalT{
A source semantic identifier. This identifier
is chosen by the author of a higher level DTD to SDL translator. It may
either reflect the meaning of the markup in the original document or it may
reflect the actual generic identifier in the original document. The source
semantic identifier assists in semantic searches of the SDL-conforming document
by preserving the original intent of the markup. When the original markup
conforms to a domain-specific DTD, the ssi may be used
to enable structured searches of the SDL-conforming document by preserving
the original generic identifiers.
T}
tgroup dispwid="6.23in"

SPC

  Purpose

A special character.

SYNOPSIS
&<!ELEMENT spc- O EMPTY >
__
&<!ATTLIST spcnameCDATA#REQUIRED >
____

DESCRIPTION

The spc element allows special characters, that is, those not in the current font, to be included in text. This is often achieved in DTDs by the use of character entities. SDL avoids runtime evaluation of entities because entities are global to a document and, for performance reasons, SDL applications often do not wish to process all global information just to display a single topic.

The attribute of spc is:
nameCDATARequiredT{
The name attribute must be one of the special
character names, for example, ``[bull ]'' (bullet), defined in the public
character entities such as ISOpub, ``ISO 8879:1986//ENTITIES Publishing//EN.''
These entities are defined in sections D.4.2.1 through D.4.5.6 of The SGML
Handbook (Goldfarb).
T}
____
tgroup dispwid="6.14in"

CONDITIONAL TEXT ELEMENTS

IF

  Purpose

Conditional inclusion of text or data.

SYNOPSIS
&<!ELEMENT if- - (cond, then, else?) >
__

DESCRIPTION

The if element allows conditional inclusion of other text and data elements.

The if element consists of a condition ( cond) followed by a then clause and an optional else clause. Based on the result of the condition, either the then clause or the else clause is included in the document. If the condition is false and no else clause exists, the if element is considered to be empty.

The if element has no attributes.

COND

  Purpose

Boolean condition for the if element.

SYNOPSIS
&<!ELEMENT cond- - CDATA >
__
&<!ATTLIST condinterpNOTATION
(tcl|
sh|
ksh|
csh)#IMPLIED >
tgroup dispwid="5.84in"

DESCRIPTION

The cond element contains a script to be run by the interpreter specified in the interp attribute. The CDATA content of cond is passed to the interp. The return value from the interpreter should be numeric.

The attribute of cond is:
interpNOTATION -OptionalT{
The interpreter to which to pass the CDATA
content
T}
tclT{
of the cond element. It
is expected that the interpreter
T}
shT{
returns a numeric string value. One of the
listed
T}
kshT{
interpreters is often embedded in the application
T}
cshT{
and does not require another process to
execute. If the specified interpreter does not exist, or returns a non-numeric
value, the default return value is zero.
T}
tgroup dispwid="6.11in"

THEN

  Purpose

Included text when the condition ( cond) of the if element is a non-zero string.

SYNOPSIS
&<!ELEMENT thenT{
- - (key | sphrase | rev | if |
spc | snref | anchor | link | #PCDATA)*) >
T}
__
tgroup dispwid="6.39in"

DESCRIPTION

The then element contains text and data to be included if the return value of the interpreter in the cond element is a non-zero string. The then element may contain a nested if element as well as any other text or data acceptable in a paragraph ( p).

The then element has no attributes.

ELSE

  Purpose

Included text when the condition ( cond) of the if element is a string evaluating to zero.

SYNOPSIS

&<!ELEMENT else - - (key | sphrase | rev | if | spc | snref | anchor | link | #PCDATA)*) >

DESCRIPTION

The else element contains text and data to be included if the return value of the interpreter in the cond element is a string evaluating to zero. The else element may contain a nested if element as well as any other text or data acceptable in a paragraph ( p).

The else element has no attributes.

NOTATION ELEMENTS

GRAPHIC

  Purpose

Attachment to a graphic image external to the current document.

SYNOPSIS
&<!ELEMENT graphic- O EMPTY >
__
&<!ATTLIST graphicidID#REQUIRED
formatCDATA#IMPLIED
methodIDREF#IMPLIED
xidCDATA#REQUIRED >

DESCRIPTION

The graphic element allows incorporation of graphic images into an SDL-conforming document. Only one graphic type element is declared; the class attribute is used to distinguish between figure, in-line or button. A graphic image is incorporated by putting an snref element in the document at the point of inclusion. The rid attribute of the snref should refer to the graphic element describing the storage location and format of the image.

The attributes of graphic are:
idIDRequiredT{
The identifier of the graphic.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
formatCDATARequiredT{
The format in which the graphic is stored.
Example values for the format attribute are:
tiff, xpm, xbm and xwd.
T}
methodIDREFOptionalT{
A reference to a script
element (discussed later) in the system notation block of the current virtual
page. The script in the script element provides a mechanism
for performing any setup necessary to display the graphic image.
T}
xidCDATARequiredT{
An external identifier for the graphic image.
T}
tgroup dispwid="6.04in"

TEXT

  Purpose

Alternate rich text for snref.

SYNOPSIS
&<!ELEMENT text- - ((p | cp)*) >
__
&<!ATTLIST textidID#REQUIRED
languageCDATA#REQUIRED
charsetCDATA#IMPLIED >

DESCRIPTION

The text element allows for rich text alternatives to other elements in the system notation block being referenced by refitem elements in snref. A text element contains zero or more paragraphs ( p) or character paragraphs ( cp).

The attributes of text are:
idIDRequiredT{
The identifier of the text.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
languageCDATAOptionalT{
The language in which this text was written.
T}
charsetCDATAOptionalT{
The character set of this text. The
language and charset
attributes plus information retrieved from the table of semantics and styles
(toss) element are used to select the text
font.
T}
tgroup dispwid="6.13in"

AUDIO

  Purpose

Attachment to an audio snippet external to the current document.

SYNOPSIS
&<!ELEMENT audio- O EMPTY >
__
&<!ATTLIST audioidID#REQUIRED
formatCDATA#IMPLIED
methodIDREF#IMPLIED
xidCDATA#REQUIRED >

DESCRIPTION

The audio element allows an audio snippet to be incorporated into an SDL-conforming document. An audio snippet is incorporated by putting an snref element in the document at the point of inclusion. The rid attribute of the snref should refer to the audio element describing the storage location and format of the audio snippet.

The attributes of audio are:
idIDRequiredT{
The identifier of the audio. The id attribute must be a valid SGML identifier and must be unique
within the document.
T}
formatCDATARequiredT{
The format in which the audio snippet is
stored.
T}
methodIDREFOptionalT{
A reference to a script
element (covered later in this document) in the system notation block of
the current virtual page. The script in the script element
provides a mechanism for performing any setup necessary to present the audio
snippet.
T}
xidCDATARequiredT{
An external identifier for the audio snippet.
T}
tgroup dispwid="6.14in"

VIDEO

  Purpose

Attachment to a video clip external to the current document.

SYNOPSIS
&<!ELEMENT video- O EMPTY >
__
&<!ATTLIST videoidID#REQUIRED
formatCDATA#IMPLIED
methodIDREF#IMPLIED
xidCDATA#REQUIRED >

DESCRIPTION

The video element allows a video clip to be incorporated into an SDL-conforming document. A video clip is incorporated by putting an snref element in the document at the point of inclusion. The rid attribute of the snref should refer to the video element describing the storage location and format of the video clip.

The attributes of video are:
idIDRequiredT{
The identifier of the video.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
formatCDATARequiredT{
The format in which the video clip is stored.
T}
methodIDREFOptionalT{
A reference to a script
element (covered later in this document) in the system notation block of
the current virtual page. The script in the script element
provides a mechanism for performing any setup necessary to present the video
clip.
T}
xidCDATARequiredT{
An external identifier for the video clip.
T}
tgroup dispwid="6.21in"

ANIMATE

  Purpose

Attachment to an animation sequence external to the current document.

SYNOPSIS
&<!ELEMENT animate- O EMPTY >
__
&<!ATTLIST animateidID#REQUIRED
formatCDATA#IMPLIED
methodIDREF#IMPLIED
xidCDATA#REQUIRED >

DESCRIPTION

The animate element allows an animation sequence to be incorporated into an SDL-conforming document. An animation sequence is incorporated by putting an snref element in the document at the point of inclusion. The rid attribute of the snref should refer to the animate element describing the storage location and format of the animation sequence.

The attributes of animate are:
idIDRequiredT{
The identifier of the animate.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
formatCDATARequiredT{
The format in which the animation sequence
is stored.
T}
methodIDREFOptionalT{
A reference to a script
element (covered later in this document) in the system notation block of
the current virtual page. The script in the script element
provides a mechanism for performing any setup necessary to present the animation
sequence.
T}
xidCDATARequiredT{
An external identifier for the animation
sequence.
T}
tgroup dispwid="6.14in"

SCRIPT

  Purpose

Data collection and/or generation of dynamic text.

SYNOPSIS
&<!ELEMENT script- - CDATA >
__
&<!ATTLIST scriptidID#REQUIRED
interpNOTATION
(tcl|
sh|
ksh|
csh)#IMPLIED >
tgroup dispwid="5.98in"

DESCRIPTION

The script element is the mechanism within SDL for collecting usage data or generating dynamic (on-the-fly) text. When referenced via an snref, the CDATA content of the script element is passed to the designated interpreter. If the return value from the interpreter is non- NULL, that value is interpolated into the document at the point of the snref. If the designated interpreter is embedded in the application, global variables may be used to collect usage data; otherwise, some mechanism, such as temporary files, may be used.

The attributes of script are:
idIDRequiredT{
The identifier of the script.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
interpNOTATION -OptionalT{
The interpreter to which to pass the CDATA
T}
tclT{
content of the script
element. One of the
T}
shT{
listed interpreters is often embedded in
the
T}
kshT{
application and does not require another
T}
cshT{
process to execute. If the specified interpreter
does not exist, the default return value is NULL.
T}
tgroup dispwid="6.69in"

CROSSDOC

  Purpose

Indirect element for following a hyperlink outside the current document.

SYNOPSIS
&<!ELEMENT crossdoc- O EMPTY >
__
&<!ATTLIST crossdocidID#REQUIRED
xidCDATA#REQUIRED >

DESCRIPTION

The crossdoc element is the mechanism within SDL for effecting a hyperlink to an external document. To create an external, cross-document hyperlink, a link to the crossdoc is placed in the text. The crossdoc element contains the necessary information to find the desired document and id within that document.

The attributes of crossdoc are:
idIDRequiredT{
The identifier of the crossdoc.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
xidCDATARequiredT{
An external identifier for the external document
and id.
T}
tgroup dispwid="6.05in"

MAN PAGE

  Purpose

Indirect element for following a hyperlink to a reference manual page.

SYNOPSIS
&<!ELEMENT man-page- O EMPTY >
&<!ELEMENT crossdoc- O EMPTY >
&<!ATTLIST man-pageidID#REQUIRED
xidCDATA#REQUIRED >

DESCRIPTION

The man-page element is the mechanism within SDL for effecting a hyperlink to (display of) a reference manual page such, as a Unix man page. To create a man page hyperlink, a link to the man-page is placed in the text. The man-page element contains the necessary information to find and display the desired manual page.

The attributes of man-page are:
idIDRequiredT{
The man-page identifier.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
xidCDATARequiredT{
An external identifier for the reference
manual page.
T}
tgroup dispwid="6.20in"

TEXTFILE

  Purpose

Indirect element for following a hyperlink to a text file.

SYNOPSIS
&<!ELEMENT textfile- O EMPTY >
__
&<!ATTLIST textfileidID#REQUIRED
xidCDATA#REQUIRED >

DESCRIPTION

The textfile element is the mechanism within SDL for effecting a hyperlink to (display of) a text file. To create a text file hyperlink, a link to the textfile is placed in the text. The textfile element contains the necessary information to find the desired file.

The attributes of textfile are:
idIDRequiredT{
The identifier of the textfile.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
xidCDATARequiredT{
An external identifier for the text file.
T}
tgroup dispwid="6.14in"

SYS-CMD

  Purpose

Indirect element for following a hyperlink to a system command.

SYNOPSIS
&<!ELEMENT sys-cmd- O EMPTY >
__
&<!ATTLIST sys-cmdidID#REQUIRED
xidCDATA#REQUIRED >

DESCRIPTION

The sys-cmd element is the mechanism within SDL for effecting a hyperlink to (execution of) a system command. To create a system command hyperlink, a link to the sys-cmd is placed in the text. The sys-cmd element contains the necessary information to find and execute the system command.

The attributes of sys-cmd are:
idIDRequiredT{
The identifier of the sys-cmd.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
xidCDATARequiredT{
An external identifier for the system command.
T}
tgroup dispwid="6.03in"

CALLBACK

  Purpose

Indirect element for following a hyperlink into the application.

SYNOPSIS
&<!ELEMENT callback- O EMPTY >
__
&<!ATTLIST callbackidID#REQUIRED
xidCDATA#REQUIRED >

DESCRIPTION

The callback element is the mechanism within SDL for effecting a hyperlink into the enclosing application. To create a application callback hyperlink, a link to the callback is placed in the text. The callback element contains the necessary information to inform the application of the desired action.

The attributes of callback are:
idIDRequiredT{
The identifier of the callback.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
xidCDATARequiredT{
An external identifier and user data for
the application callback.
T}
tgroup dispwid="6.05in"

SWITCH

  Purpose

Conditional hyperlink.

SYNOPSIS
&<!ELEMENT switch- - CDATA >
__
&<!ATTLIST switchidID#REQUIRED
interpNOTATION
(tcl|
sh|
ksh|
csh)#IMPLIED
branchesIDREFS#REQUIRED >
tgroup dispwid="6.28in"

DESCRIPTION

The switch element is part of the system notation block, snb, and is always instantiated via a reference by a link element. When activated by the hyperlink, the interpreter ( interp) is called passing it the CDATA content of the switch and the interpreter returns a non-negative number. The return value of the interpreter is used to index into the list of branches and the hyperlink is continued to that ID. A return value that is non-numeric, less than zero or greater than the number minus one of the ids in the branches attribute, will cause the hyperlink to continue to the first branch in the list.

The attributes of switch are:
idIDRequiredT{
The identifier of the switch.
The id attribute must be a valid SGML identifier and
must be unique within the document.
T}
interpNOTATION -OptionalT{
The interpreter to which to pass the
T}
tclT{
CDATA content of the switch
element. It is expected that the
T}
shT{
interpreter returns a numeric string value
T}
kshT{
equal to or greater than zero. One of the
T}
cshT{
listed interpreters is often embedded in
the application and does not require another process to execute. If the specified
interpreter does not exist, or returns either a non-numeric or out-of-bounds
value, the default return value is zero.
T}
branchesIDREFSRequiredT{
A list of IDs in the current document. The
return value of the interp attribute is used to index
into this list of IDs and the hyperlink is continued at the resulting ID.
T}
tgroup dispwid="6.31in"

GENERATED ELEMENTS

REL-DOCS

  Purpose

Documents related to this document.

SYNOPSIS

To be determined.

DESCRIPTION

To be determined.

  REL-FILE

  Purpose

Files related to this document.

SYNOPSIS

To be determined.

DESCRIPTION

To be determined.

NOTES

  Purpose

Notes related to this document.

SYNOPSIS

To be determined.

DESCRIPTION

To be determined.

LOIDS AND ID

  Purpose

List of identifiers in the document.

SYNOPSIS
&<!ELEMENT loids
__
&<!ATTLIST loidscountNUMBER#IMPLIED >
____
&<!ELEMENT id- O EMPTY >
__
&<!ATTLIST idtype(virpage|
block|
form|
p|
cp|
head|
subhead|
anchor|
switch|
snref|
graphic|
text|
audio|
video|
animate|
crossdoc|
man-page|
textfile|
sys-cmd|
script|
callback)#REQUIRED
ridIDREF#REQUIRED
rssiCDATA#IMPLIED
rlevelNUMBER#IMPLIED
offsetNUMBER#REQUIRED >

DESCRIPTION

The loids element is a container for a list of identifiers in the document. The list appears in the order the identifiers appear.

The loids element can be used to generate a table of contents for the document by selecting only those elements whose type is virpage and listing the heads of those virpage elements. The rlevel attribute can be used to infer the nesting level of the virpage and to avoid reading the head of virtual pages whose nesting level is deeper than is currently being displayed.

The attribute of loids is:
countNUMBEROptionalT{
The number of id elements
contained in the loids. This attribute, if present, can
be used by the processor to pre-allocate space for the id
elements.
T}
____
tgroup dispwid="6.14in"

The attributes of id are:
typevirpageRequiredT{
The name of the element to which this id
T}
blockbelongs.
form
p
cp
head
subhead
anchor
switch
snref
graphic
text
audio
video
animate
crossdoc
man-page
textfile
sys-cmd
script
callback
ridIDREFRequiredThe referenced identifier.
rssiCDATAOptionalT{
The source semantic identifier ( ssi) of the element referenced by the rid
attribute.
T}
rlevelNUMBEROptionalT{
The level
of the element referenced by the rid attribute. This
attribute defaults to 1.
T}
offsetNUMBERRequiredT{
The byte offset in the document to the start
of the virtual page containing the element referenced by the rid attribute.
T}
tgroup dispwid="6.07in"

INDEX AND ENTRY

  Purpose

Contains the index for the document.

SYNOPSIS
&<!ELEMENT index- - (entry*) >
__
&<!ATTLIST indexheadCDATA#IMPLIED
countNUMBER#IMPLIED >
&<!ELEMENT entryT{
- - ((key | sphrase | rev | if
| spc | snref | #PCDATA)*, entry*) >
T}
__
tgroup dispwid="6.39in"Caret
&<!ATTLIST entryidID#IMPLIED
mainIDREFS#IMPLIED
locsIDREFS#IMPLIED
synsIDREFS#IMPLIED
sortCDATA#IMPLIED >

DESCRIPTION

The index element contains all information necessary to create and display an index for the document. It is created during translation of a higher level DTD-conforming document to conform to SDL; that is, an index is not generated at the time of request.

The index can be used to enable keyword searches within a document.

An index consists of zero or more entries.

The attributes of index are:
headCDATAOptionalT{
Alternate text for the heading of the index.
T}
countNUMBEROptionalT{
The number of entry elements
contained in the index. The processor cn use this attribute (if this attribute
is present) to pre-allocate space for the entry elements.
T}
tgroup dispwid="6.21in"

The attributes of entry are:
idIDOptionalThe identifier of the index entry.
mainIDREFSOptionalT{
A list of identifiers specifying where the
indexed entry may be found. The main list of ids may be highlighted in some
way to indicate a greater importance than the ids found in the locs list.
T}
locsIDREFSOptionalT{
A list of identifiers specifying where the
indexed entry may be found. At least one of either main or locs must be specified.
T}
synsIDREFSOptionalT{
A list of identifiers that refer to other entry elements and correspond to a ``See also'' or synonym-type
of reference.
T}
sortCDATAOptionalT{
A sort key to use if
the indexed entry is to be sorted other than by its content.
T}
tgroup dispwid="6.13in"

LOPHRASES

  Purpose

A list of semantic phrases used in this document.

SYNOPSIS
&<!ELEMENT lophrases- - (phrase+) >
__
&<!ATTLIST lophrasescountNUMBER#IMPLIED >
____

DESCRIPTION

The list of phrases ( lophrases) element is generated by the higher level DTD to SDL translator. It is a list of phrases used from the toss element (covered later in this document) contained in this document. The phrases are used to map the user's knowledge domain into the constructs used in SDL. This information can be used to pass the phrases available for structured or semantic searches to a browser or viewer to allow that browser or viewer to offer that information to the user.

The lophrases element differs from the phrases in the toss in that the toss contains all phrases possible in a higher level DTD to SDL translation and the lophrases element contains only those used in the translation of this particular document.

The attribute of lophrases is:
countNUMBEROptionalT{
The number of phrase elements contained in
the lophrases. The processor can use this attribute (if
this attribute is present) to pre-allocate space for the phrase elements.
T}
____
tgroup dispwid="6.25in"

PHRASE

  Purpose

A single phrase in the lophrases element.

SYNOPSIS
&<!ELEMENT phrase- O EMPTY >
__
&<!ATTLIST phrasetextCDATA#REQUIRED >
____

DESCRIPTION

The phrase element is a single phrase from the list of phrases element ( lophrases).

The attribute of phrase is:
textCDATARequiredThe semantic phrase.
____

TOSS

  Purpose

The table of semantics and styles.

SYNOPSIS
&<!ELEMENT tossT{
- - (keystyle*, headstyle*, frmtstyle*,
grphstyle*)>
T}
__
tgroup dispwid="6.35in"

DESCRIPTION

The toss element is a container for the table of semantics and styles. Each sub-element of the toss represents a different formatting group. These sub-elements also contain class and ssi (source semantic identifier) attributes to allow general and specific semantic or structured searches. A phrase attribute of many of the toss sub-elements also assists by providing a natural language phrase to describe the semantics of the element as used in the higher level DTD to SDL translation.

Lookups in the toss are done by matching the class and ssi attributes of the element in the document proper with the class and ssi attributes of the sub-element of the toss. The lookup can often be further refined by matching the level attribute (if present) of the element in the document with the rlevel attribute (if present) in the sub-element of the toss.

Structured searches based on the structure of a domain-specific higher level DTD can be made by having the ssi attribute of the sub-element directly correspond to the generic identifier from the original DTD.

The attribute of toss is:
countNUMBEROptionalT{
The number of styles contained in the toss. The processor can use this attribute (if this attribute is
present) to pre-allocate space for the styles.
T}
____
tgroup dispwid="6.13in"

KEYSTYLE

  Purpose

Provides font and semantic information for key phrases.

SYNOPSIS
&<!ELEMENT keystyle- O EMPTY >
__
&<!ATTLIST keystyleclass(acro|
book|
emph|
jargon|
l10n|
name|
quote|
product|
termdef|
term|
mach-in|
mach-out|
mach-cont|
pub-lit|
udefkey)#REQUIRED
ssiCDATA#IMPLIED
rlevelNUMBER#IMPLIED
phraseCDATA#IMPLIED
srch-wtNUMBER#IMPLIED
pointszNUMBER#IMPLIED
set-widthNUMBER#IMPLIED
colorCDATA#IMPLIED
xlfdCDATA#IMPLIED
xldfiCDATA#IMPLIED
xlfdbCDATA#IMPLIED
xlfdibCDATA#IMPLIED
typenamCDATA#IMPLIED
typenamiCDATA#IMPLIED
typenambCDATA#IMPLIED
typenamibCDATA#IMPLIED
style(serif|
sans-serif|
symbol)#IMPLIED
spacing(monospace|
propspace)#IMPLIED
weight(medium|
bold)#IMPLIED
slant(roman|
italic|
rev-italic|#IMPLIED
special(underline|
strikeout|
none)#IMPLIED >
tgroup dispwid="6.13in"

DESCRIPTION

The keystyle element provides semantic and font information for key phrases in the document.

When a key element is encountered in the document, the toss list of keystyle elements is ssearched with an attempt made to match the class and ssi (if any) attributes of the key element to the class and ssi (if any) attributes of the keystyle. If the keystyle specifies an rlevel attribute, the search is further refined by matching the level of the block containing the paragraph ( p) to the rlevel of the keystyle. If the key element has no ssi attribute, the search in the toss looks for a keystyle element with no ssi specified. A keystyle element with no ssi specified matches any ssi in a key element although an explicit class/ssi pair is chosen in preference.

When a match is found, the font information contained in the keystyle is used in formatting the key element.

The attributes of keystyle are:
classacroRequiredT{
The general type of the key
element in
T}
bookthe document.
emph
jargon
l10n
name
quote
product
pub-lit
termdef
term
mach-in
mach-out
mach-cont
udefkey
ssiCDATAOptionalT{
A source semantic identifier. This identifier
is chosen by the author of a higher level DTD to SDL translator. It may
either reflect the meaning of the markup in the original document or it may
reflect the actual generic identifier in the original document. The source
semantic identifier may be used to assist in semantic searches of the SDL-conforming
document by preserving the original intent of the markup. When the original
markup conforms to a domain-specific DTD, the ssi may
be used to enable structured searches of the SDL-conforming document by preserving
the original generic identifiers.
T}
rlevelNUMBEROptionalT{
Used to further refine matches of the
class and ssi attributes. If
present, the rlevel of the keystyle
is matched against the level of the block containing the paragraph (p) containing
the key element.
T}
phraseCDATAOptionalT{
A natural language phrase describing the
semantics (meaning) of the element in the original SGML document that was
translated into this key. This phrase can be used to present
an interface to the reader for searching or otherwise examining the document.
T}
srch-wtNUMBEROptionalT{
A number indicating the likelihood that this
element contains an actual hit when doing a full-text search. It may be used
as a relevance indicator.
T}
pointszNUMBEROptionalT{
The height of the font in points. By default,
the main body of the document is 10 point.
T}
set-widthNUMBEROptionalT{
The width of the font in points; the default
is the point size. The set width is similar to point size but refers to
relative width rather than height. For example, an 8 point font based on a
square would be 8 pt., 8 set.
T}
colorCDATAOptionalT{
One of the 42 common desktop environment
(CDE) colors or RGB:rrrr/gggg/bbbb.
T}
xlfdCDATAOptionalT{
These attributes should always be specified
as a group.
T}
xlfdiT{
They are X logical font descriptions
T}
xlfdbT{
(XLFD) typeface names for use on the X
T}
xlfdibT{
Window System. Specified, for example, as
``-adobe-helvetica-bold-i-narrow-*-''. The four specifications are for normal,
italic, bold and bold-italic. These attributes should only be specified if
the author is sure of exactly what font is desired. In the usual case, only
the logical typeface specifcations (style, spacing, weight, slant)
are given.
T}
typenamCDATAOptionalT{
These attributes should always be specified
as a group.
T}
typenamiT{
They are the MS-Windows typeface name with
a maximum
T}
typenambT{
of 32 characters. There is one specification
each
T}
typenamibT{
for normal, italic, bold and bold-italic.
These attributes should only be specified if the author is sure of the desired
font and, in the usual case, only provides the following logical type specifications.
T}
styleserifOptionalThe font style.
sans-serif
symbol
spacingmonospaceOptionalSpecifies fixed versus proportional
propspacespacing.
weightmediumOptionalSpecifies normal versus bold font.
bold
slantromanOptionalT{
Specifies Roman, italic or reverse italic
T}
italicfont.
rev-italic
specialunderlineOptionalT{
Special attribute of the font. The underline
value is
T}
strikeoutT{
interpreted as appropriate for the font.
T}
noneT{
Some non-European fonts use overlining for
the purpose filled by underlining in European fonts.
T}
tgroup dispwid="6.08in"

HEADSTYLE

  Purpose

Provides formatting, font and semantic information for headings ( head and subhead).

SYNOPSIS
&<!ELEMENT headstyle- O EMPTY >
__
&<!ATTLIST headstyleclass(label|
head|
caption|
undefhead)#REQUIRED
ssiCDATA#IMPLIED
rlevelNUMBER#IMPLIED
phraseCDATA#IMPLIED
srch-wtCDATA#IMPLIED
orient(left-orient|
center-orient|
right-orient|
left-corner-orient|
right-corner-orient)#IMPLIED
vorient(top-vorient|
bottom-vorient|
center-vorient)#IMPLIED
placement(object|
parent)#IMPLIED
headwCDATA#IMPLIED
stack(horiz|
vert)#IMPLIED
flow(wrap|
nowrap)#IMPLIED
phraseCDATA#IMPLIED
srch-wtNUMBER#IMPLIED
pointszNUMBER#IMPLIED
set-widthNUMBER#IMPLIED
colorCDATA#IMPLIED
xlfdCDATA#IMPLIED
xldfiCDATA#IMPLIED
xlfdbCDATA#IMPLIED
xlfdibCDATA#IMPLIED
typenamCDATA#IMPLIED
typenamiCDATA#IMPLIED
typenambCDATA#IMPLIED
typenamibCDATA#IMPLIED
style(serif|
sans-serif|
symbol)#IMPLIED
spacing(monospace|
propspace)#IMPLIED
weight(medium|
bold)#IMPLIED
slant(roman|
italic|
rev-italic)#IMPLIED
special(underline|
strikeout|
none)#IMPLIED
f-marginCDATA#IMPLIED
l-marginCDATA#IMPLIED
r-marginCDATA#IMPLIED
t-marginCDATA#IMPLIED
b-marginCDATA#IMPLIED
border(no-border|
full-border|
horizontal-border|
vertical-border|
top-border|
bottom-border|
left-border|
right-border)#IMPLIED
justify(left-justify|
right-justify|
center-justify|
numeric-justify)#IMPLIED
vjust(top-vjust|
bottom-vjust|
center-vjust)#IMPLIED >
tgroup dispwid="6.58in"

DESCRIPTION

The headstyle element provides semantic, font and formatting information for headings ( head and subhead) in the document.

When a heading is encountered in the document and that heading has an ssi attribute, the toss list of headstyle elements is searched with an attempt made to match the class and ssi attributes of the heading to the class and ssi attributes of the headstyle. If the headstyle specifies an rlevel attribute, the search is further refined by matching the level of the element containing the heading to the rlevel of the headstyle. If the element containing the heading does not have a level attribute, the level of its containing element is used, and so on. A headstyle element with no ssi specified matches any ssi in a head element although an explicit class/ssi pair is chosen in preference.

When a match is found, the font and style information contained in the headstyle is used in formatting the heading.

The attributes of headstyle are:
classlabelRequiredT{
The general type of the heading in the
T}
headdocument.
annotation
phead
udefhead
ssiCDATAOptionalT{
A source semantic identifier. This identifier
is chosen by the author of a higher level DTD to SDL translator. It may
either reflect the meaning of the markup in the original document or it may
reflect the actual generic identifier in the original document. The source
semantic identifier may be used to assist in semantic searches of the SDL-conforming
document by preserving the original intent of the markup. When the original
markup was conforming to a domain-specific DTD, the ssi
may be used to enable structured searches of the SDL-conforming document
by preserving the original generic identifiers.
T}
rlevelNUMBEROptionalT{
Used to further refine matches of the
class and ssi attributes. If
present, the rlevel of the headstyle
is matched against the level of the element
containing the heading or, if none, the level
of the first containing element with a level
attribute.
T}
phraseCDATAOptionalT{
A natural language phrase describing the
semantics (meaning) of the element in the original SGML document that was
translated into this heading. This phrase can be used to present an interface
to the reader for searching or otherwise examining the document.
T}
srch-wtNUMBEROptionalT{
A number indicating the likelihood that this
element contains an actual hit when doing a full-text search.
T}
srch-wtNUMBEROptionalT{
A number indicating the likelihood that this
element contains an actual hit when doing a full-text search.
T}
orientleft-orientOptionalT{
The horizontal orientation of the head with
T}
center-orientT{
respect to its associated element or of
T}
right-orientT{
the subhead with respect
to its head. The
T}
left-margin-orientT{
default is center-orient. This value is used
in
T}
right-margin-orientT{
conjunction with the vorientattribute
to orient the heading. The corner orientations
T}
left-corner-orientT{
are to place the heading in one of the four
T}
right-corner-orientT{
corners above or below (top-vorient or bottom-vorient)
and to the right or left (right-corner-orient or left-corner-orient) of the
associated element. The margin orientations left or right justified this heading
with respect to the text of the heading parent. For example, a headstyle
with orient=left-margin-orient and vorient=top-vorient places the heading
above the parent element aligning the left margins of the parent and the heading.
T}
vorienttop-vorientOptionalT{
The vertical orientation of the head
T}
bottom-vorientT{
with respect to its associated element or
of the subhead with respect to its head.
T}
center-vorientThe default is top-vorient.
placementobjectOptionalT{
This attribute applies only to head elements.
T}
parentT{
This attribute indicates whether the orient and vorient attributes apply to the head proper or to the entire head object, including
all its subhead elements. This attribute should default
to parent.
T}
headwCDATAOptionalT{
The percentage of the available space for
the current element that should be given to its head or
the percentage of the head that should be given to its
subhead. It is expressed as a fixed point number 1 to
10000 with an implied decimal point two places to the left of the right side.
T}
stackhorizOptionalT{
Where to put this head
or subhead if it
T}
vertT{
collides with one already placed. Horizontal
stacking means place this one to the right of the other. Vertical stacking
means place this one under the other. This attribute should default to vert.
T}
flowwrapOptionalT{
Specifies whether the text of the containing
T}
nowrapT{
element should flow around the heading or
T}
joinT{
not. The default is no-wrap. A flow of join implies starting the content of the surrounding element
immediately after this head. That is, on the same line as the bottom of this
head.
T}
pointszNUMBEROptionalT{
The height of the font in points. By default,
the main body of the document is 10 point.
T}
set-widthNUMBEROptionalT{
The width of the font in points; the default
is the point size. The set width is similar to point size but refers to
relative width rather than height. For example, an 8 point font based on
a square would be 8 pt., 8 set.
T}
colorCDATAOptionalT{
One of the 42 CDE colors or RGB:rrrr/gggg/bbbb.
T}
xlfdCDATAOptionalT{
These attributes should always be specified
as a
T}
xlfdiT{
group. They are X logical font description
T}
xlfdbT{
(XLFD) typeface names for use on the X Window
System. Specified, for example, as
T}
xlfdibT{
``-adobe-helvetica-bold-i-narrow-*-''. The
four specifications are for normal, italic, bold and bold-italic. This attribute
should only be specified if the author is sure of the desired font. In the
usual case, only the logical typeface specifications ( style, spacing, weight, slant) is given.
T}
typenamCDATAOptionalT{
These attributes should always be specified
as a
T}
typenamiT{
group. They are the MS-Windows typeface
T}
typenambT{
name with a maximum of 32 characters. There
is
T}
typenamibT{
one specification each for normal, italic,
bold and bold-italic. These attributes should only be specified if the author
is sure of the desired font and, in the usual case, only provide the following
logical type specifications.
T}
styleserifOptionalThe font style.
sans-serif
symbol
spacingmonospaceOptionalT{
Specifies fixed versus proportional spacing.
T}
propspace
weightmediumOptionalSpecifies normal versus bold font.
bold
slantromanOptionalT{
Specifies Roman, italic or reverse italic
font.
T}
italic
rev-italic
specialunderlineOptionalT{
Special attribute of the font. The underline
value is
T}
strikeoutT{
interpreted as appropriate for the font.
T}
noneT{
Some non-European fonts use overlining for
the purpose filled by underlining in European fonts.
T}
f-marginCDATAOptionalT{
The first line margin (it may be negative).
A number used to indicate the extension or indentation at the start of a paragraph.
The default value is zero.
T}
l-marginNUMBEROptionalT{
The left margin. This value is additive,
that is, if an element has a left margin and is (logically) contained in
another element having a left margin, the contained element will have a left
margin equal to the sum of the two values. This value is measured in current
character widths. The default value is zero.
T}
r-marginNUMBEROptionalT{
The right margin. This value is additive,
that is, if an element has a right margin and is (logically) contained in
another element having a right margin, the contained element will have a right
margin equal to the sum of the two values. This value is measured in current
character widths. The default value is zero.
T}
t-marginNUMBEROptionalT{
The top margin. This value takes the maximum,
that is, if an element has a top margin and is (logically) contained in another
element having a top margin, the two elements together have a top margin
equal to the greater of the two. This value is measured in current line height.
The default value is zero.
T}
b-marginNUMBEROptionalT{
The bottom margin. This value takes the maximum,
that is, if an element has a bottom margin and is (logically) contained in
another element having a bottom margin, the two elements together have a
bottom margin equal to the greater of the two. This value is measured in
current line height. The default value is zero.
T}
borderno-borderOptionalT{
Specifies the decoration type. The default
is no-border.
T}
full-border
horizontal-border
vertical-border
top-border
bottom-border
left-border
right-border
justifyleft-justifyOptionalT{
Horizontal justification of the text or data.
T}
right-justifyT{
The default is left-justify. The numeric-justify
T}
center-justifyT{
value implies alignment of decimal points.
T}
numeric-justify
vjusttop-vjustOptionalT{
The alignment of the head
or subhead
T}
bottom-vjustT{
in the space carved out by the largest head
T}
center-vjustT{
or subhead in the same
plane. That is, should this head or
subhead be aligned with the top of the largest related
head or subhead, the bottom, or the
center. In general, the vjust attribute may be seen as
justifying text vertically. If a head or
subhead is being placed alongside another
head or subhead and the other one
is longer than the one being placed,
the one being placed has an implicit length equal
to that of the already placed one and the vjust attribute
justifies the text within that length.
T}
tgroup dispwid="7.52in"

FORMSTYLE

  Purpose

Provides formatting, font and semantic information for form elements.

SYNOPSIS
&<!ELEMENT formstyle- O EMPTY >
__
&<!ATTLIST formstyle(classtable|
list|
text|
udeffrmt)#REQUIRED
ssiCDATA#IMPLIED
rlevelNUMBER#IMPLIED
phraseCDATA#IMPLIED
srch-wCDATA#IMPLIED
phraseCDATA#IMPLIED
srch-wtNUMBER#IMPLIED
pointszNUMBER#IMPLIED
set-widthNUMBER#IMPLIED
colorCDATA#IMPLIED
xlfdCDATA#IMPLIED
xldfiCDATA#IMPLIED
xlfdbCDATA#IMPLIED
xlfdibCDATA#IMPLIED
typenamCDATA#IMPLIED
typenamiCDATA#IMPLIED
typenambCDATA#IMPLIED
typenamibCDATA#IMPLIED
style(serif|
sans-serif|
symbol)#IMPLIED
spacing(monospace|
propspace)#IMPLIED
weight(medium|
bold)#IMPLIED
slant(roman|
italic|
rev-italic)#IMPLIED
special(underline|
strikeout|
none)#IMPLIED
f-marginCDATA#IMPLIED
l-marginCDATA#IMPLIED
r-marginCDATA#IMPLIED
t-marginCDATA#IMPLIED
b-marginCDATA#IMPLIED
border(no-border|
full-border|
horizontal-border|
vertical-border|
top-border|
bottom-border|
left-border|
right-border)#IMPLIED
vjust(top-vjust|
bottom-vjust|
center-vjust)#IMPLIED >
tgroup dispwid="6.47in"

DESCRIPTION

The formstyle element provides semantic, font and formatting information for form elements.

When a form element is encountered in the document and that element has an ssi attribute, the toss list of formstyle elements is searched with an attempt made to match the class and ssi attributes of the element to the class and ssi attributes of the formstyle. If the formstyle specifies an rlevel attribute, the search is further refined by matching the nesting level of the form to the rlevel of the formstyle. A formstyle element with no ssi specified, matches any ssi in a form, although an explicit class/ssi pair is chosen in preference.

When a match is found, the font and style information contained in the formstyle is used in formatting the element.

The attributes of formstyle are:
classtableRequiredT{
The general function of the form in the
T}
celldocument.
list
item
text
udeffrmt
ssiCDATAOptionalT{
A source semantic identifier. This identifier
is chosen by the author of a higher level DTD to SDL translator. It may
either reflect the meaning of the markup in the original document or it may
reflect the actual generic identifier in the original document. The source
semantic identifier may assist in semantic searches of the SDL-conforming
document by preserving the original intent of the markup. When the original
markup conforms to a domain specific DTD, the ssi may
be used to enable structured searches of the SDL-conforming document by preserving
the original generic identifiers.
T}
rlevelNUMBEROptionalT{
Used to further refine matches of the
class and ssi attributes. If
present, the rlevel of the formstyle
is matched against the nesting level of the form being formatted.
T}
phraseCDATAOptionalT{
A natural language phrase describing the
semantics (meaning) of the element in the original SGML document that was
translated into this form. This phrase can be used to
present an interface to the reader for searching or otherwise examining
the document.
T}
srch-wtNUMBEROptionalT{
A number indicating the likelihood that this
element contains an actual hit when doing a full-text search.
T}
colwCDATAOptionalT{
Column widths. One specification for each
column in the form. Amounts given for each column are
summed and each column is then given a fraction of the available formatting
space equal to its specification divided by the total. Specifications take
the form D[,T[,G]] where ``D'' is the desired (optimal) column width, ``T''
is the amount the column is willing to grow (take) and, if ``G'' is unspecified,
willing to give (that is, plus or minus). ``G'' is the amount the column
is willing to shrink (give). Column specifications are delimited by a space.
For example, a specification of: COLW=``10 90'' implies two columns with the
first taking 10% of the available space and the second taking 90%. If either
column has a graphic or unsplittable word that pushes it over the size specified,
a horizontal scrollbar is added and the available space is grown until the
requirement can be met. A specification of: COLW=``20,5 80,5'' implies two
columns with the first optimally taking 20% and the second optimally taking
80%. Each column, however is willing to shrink or grow such that the ranges
of sizes run from 15/85 to 25/75. If the sizes cannot be adjusted to contain
a graphic or unsplittable word, a horizontal scrollbar is added and the available
space is grown until the requirement is met. Finally, a specification of:
COLW=``20,10,5 80,5,10'' implies two columns with the first optimally taking
20% of the available space but willing to take as much as 30% or a little
as 15%. The second column desires 80% but is willing to take as much as
85% or as little as 70% of the available space. A scrollbar may be added
to the viewed space if the constraints cannot be met. The specifications
need not all be uniformly singles, doubles or triples. That is, a legal specification
could take the form: COLW=``20,5 80,0,5'' that translates to two columns;
the first desiring 20% of the available space but willing to take as much
as 25% or as little as 15/80 (18.75%). The second column desires 80% of the
available space, but is willing to take as little as 75%. The totals in
the above examples usually add up to 100. This value is mere convention for
ease of use. In practice, the sum of desired points may be any number. If
the number of columns specified is greater than the ncols
attribute of the fstyle of the related form,
the extra specifications are ignored. If the number of columns specified
is less than the ncols attribute, the final specification
is replicated to cover the actual number of columns.
T}
coljCDATAOptionalT{
The column justification is the default justification
applied to each cell in the column. This attribute is a list of ncols letters chosen from: ``l,'' ``r,'' ``c,'' and ``d.'' These
letters specify left, right, centered and decimal justification, respectively.
This attribute defaults to ``l.''
T}
pointszNUMBEROptionalT{
The height of the font in points. By default,
the main body of the document is 10 point.
T}
set-widthNUMBEROptionalT{
The width of the font in points; the default
is the point size. The set width is similar to point size but refers to
relative width rather than height. For example, an 8 point font based on
a square would be 8 pt., 8 set.
T}
colorCDATAOptionalT{
One of the 42 common desktop environment
(CDE) colors or RGB:rrrr/gggg/bbbb.
T}
xlfdCDATAOptionalThese attributes should always be
xlfdiT{
specified as a group. They are X logical
T}
xlfdbT{
font descriptions (XLFD) typeface names
T}
xlfdibT{
for use on the X Window System. Specified,
for example, as ``-adobe-helvetica-bold-i-narrow-*-''. The four specifications
are for normal, italic, bold and bold-italic. These attribute should only
be specified if the author is sure of exactly what font is desired. In the
usual case, only the logical typeface specifications ( style, spacing, weight, slant) is given.
T}
typenamCDATAOptionalT{
These attributes should always be specified
T}
typenamias a group with a maximum of 32
typenamibT{
characters. There is one specification each
for normal, italic, bold and bold-italic. These attributes should only be
specified if the author is sure of the desired font and, in the usual case,
only provides the following logical type specifications.
T}
styleserifOptionalThe font style.
sans-serif
symbol
spacingmonospaceOptionalT{
Specifies fixed versus proportional spacing.
T}
propspace
weightmediumOptionalSpecifies normal versus bold font.
bold
slantromanOptionalT{
Specifies Roman, italic or reverse italic
font.
T}
italic
rev-italic
specialunderlineOptionalT{
Special attribute of the font. The underline
T}
italicT{
value is interpreted as appropriate for the
font.
T}
rev-italicT{
Some non-European fonts use overlining for
T}
strikeoutT{
the purpose filled by underlining in European
T}
nonefonts.
l-marginNUMBEROptionalT{
The left margin. This value is additive,
that is, if an element has a left margin and is (logically) contained in
another element having a left margin, the contained element will have a left
margin equal to the sum of the two values. This value is measured in current
character widths and defaults to zero.
T}
r-marginNUMBEROptionalT{
The right margin. This value is additive,
that is, if an element has a right margin and is (logically) contained in
another element having a right margin, the contained element will have a right
margin equal to the sum of the two values. This value is measured in current
character widths and defaults to zero.
T}
t-marginNUMBEROptionalT{
The top margin. This value takes the maximum,
that is, if an element has a top margin and is (logically) contained in another
element having a top margin, the two elements will together have a top margin
equal to the greater of the two. This value is measured in current line height
and defaults to zero.
T}
b-marginNUMBEROptionalT{
The bottom margin. This value takes the maximum,
that is, if an element has a bottom margin and is (logically) contained in
another element having a bottom margin, the two elements together have a
bottom margin equal to the greater of the two. This value is measured in
current line height and defaults to zero.
T}
borderno-borderOptionalSpecifies the decoration type.
no-borderThe default is no-border.
full-border
horizontal-border
vertical-border
top-border
bottom-border
left-border
right-border
vjusttop-vjustOptionalT{
Vertical justification of the text of this
T}
bottom-vjustelement. The default is top-vjust.
center-vjust
tgroup dispwid="6.79in"

FRMTSTYLE

  Purpose

Provides formatting, font and semantic information for virpage, block and p elements.

SYNOPSIS
&<!ELEMENT frmtstyle- O EMPTY >
__
&<!ATTLIST frmtstyle(classtable|
list|
text|
udeffrmt)#REQUIRED
ssiCDATA#IMPLIED
rlevelNUMBER#IMPLIED
phraseCDATA#IMPLIED
srch-wtCDATA#IMPLIED
phraseCDATA#IMPLIED
srch-wtNUMBER#IMPLIED
pointszNUMBER#IMPLIED
set-widthNUMBER#IMPLIED
colorCDATA#IMPLIED
xlfdCDATA#IMPLIED
xldfiCDATA#IMPLIED
xlfdbCDATA#IMPLIED
xlfdibCDATA#IMPLIED
typenamCDATA#IMPLIED
typenamiCDATA#IMPLIED
typenambCDATA#IMPLIED
typenamibCDATA#IMPLIED
style(serif|
sans-serif|
symbol)#IMPLIED
spacing(monospace|
propspace)#IMPLIED
weight(medium|
bold)#IMPLIED
slant(roman|
italic|
rev-italic|#IMPLIED
special(underline|
strikeout|
none)#IMPLIED
f-marginCDATA#IMPLIED
l-marginCDATA#IMPLIED
r-marginCDATA#IMPLIED
t-marginCDATA#IMPLIED
b-marginCDATA#IMPLIED
border(no-border|
full-border|
horizontal-border|
vertical-border|
top-border|
bottom-border|
left-border|
right-border)#IMPLIED
vjust(top-vjust|
bottom-vjust|
center-vjust)#IMPLIED
justify(left-justify|
right-justify|
center-justify|
numeric-justify)#IMPLIED >
tgroup dispwid="6.60in"

DESCRIPTION

The frmtstyle element provides semantic, font and formatting information for virpage, block and p elements.

When a one of the elements listed in the FRMSTYLE Synopsis is encountered in the document and that element has an ssi attribute, the toss list of frmtstyle elements is serached with an attempt made to match the class and ssi attributes of the element to the class and ssi attributes of the frmtstyle. If the frmtstyle specifies an rlevel attribute, the search is further refined by matching the level of the element containing the element to the rlevel of the frmtstyle. If the element does not have a level attribute, the level of its containing element is used, and so on. A frmtstyle element with no ssi specified matches any ssi in a formattable element although an explicit class/ssi pair is chosen in preference.

When a match is found, the font and style information contained in the frmtstyle is used in formatting the element.

The attributes of frmtstyle are:
classtableRequiredThe general function of the form .
cellin the document.
list
item
text
udeffrmt
ssiCDATAOptionalT{
The general function of the form. A source semantic identifier. This identifier is chosen by the
author of a higher level DTD to SDL translator. It may either reflect the
meaning of the markup in the original document or it may reflect the actual
generic identifier in the original document. The source semantic identifier
may be used to assist in semantic searches of the SDL-conforming document
by preserving the original intent of the markup. When the original markup
conforms to a domain-specific DTD, the ssi may be used
to enable structured searches of the SDL-conforming document by preserving
the original generic identifiers.
T}
rlevelNUMBEROptionalT{
Used to further refine matches of the
class and ssi attributes. If
present, the rlevel of the frmtstyle
is matched against the level of the element
being formatted or, if none, the level of
the first containing element with a level
attribute.
T}
phraseCDATAOptionalT{
A natural language phrase describing the
semantics (meaning) of the element in the original SGML document that was
translated into this element. This phrase can be used to present an interface
to the reader for searching or otherwise examining the document.
T}
srch-wtNUMBEROptionalT{
A number indicating the likelihood that this
element contains an actual hit when doing a full-text search.
T}
pointszNUMBEROptionalT{
The height of the font in points. By default,
the main body of the document is 10 point.
T}
set-widthNUMBEROptionalT{
The width of the font in points; the default
is the point size. The set width is similar to point size but refers to
relative width rather than height. For example, an 8 point font based on a
square would be 8 pt., 8 set.
T}
colorCDATAOptionalT{
One of the 42 CDE colors or RGB:rrrr/gggg/bbbb.
T}
xlfdCDATAOptionalT{
These attributes should always be specified
as a group.
T}
xlfdiT{
They are X logical font description (XLFD)
T}
xlfdbT{
typeface names for use on the X Window System.
Specified, for example,
T}
xlfdibT{
as ``-adobe-helvetica-bold-i-narrow-*-''.
The four specifications are for normal, italic, bold and bold-italic. These
attributes should only be specified if the author is sure of exactly what
font is desired. In the usual case, only the logical typeface specifications
(style, spacing, weight, slant) are given.
T}
typenamCDATAOptionalT{
These attributes should always be specified
as a group.
T}
typenamiThey are the MS-Windows typeface
typenambT{
names with a maximum of 32 characters.
T}
typenamibT{
There is one specification each for normal,
italic, bold and bold-italic. These attributes should only be specified if
the author is sure of the desired font. In the usual case, only the logical
typeface specifications (style, spacing, weight, slant)
are given.
T}
styleserifOptionalThe font style.
sans-serif
symbol
spacingmonospaceOptionalSpecifies fixed versus proportional
propspacespacing.
weightmediumOptionalSpecifies normal versus bold font.
bold
slantromanOptionalT{
Specifies Roman, italic or reverse italic
T}
italicfont.
rev-italic
specialunderlineOptionalT{
Special attribute of the font. The underline
value is interpreted
T}
strikeoutT{
as appropriate for the font. Some non-European
T}
noneT{
fonts use overlining for the purpose filled
by underlining in European fonts.
T}
f-marginCDATAOptionalT{
The first line margin (it may be negative).
A number used to indicate the extension or indentation at the start of a paragraph.
The default value is zero.
T}
l-marginNUMBEROptionalT{
The left margin. This value is additive,
that is, if an element has a left margin and is (logically) contained in
another element having a left margin, the contained element will have a left
margin equal to the sum of the two values. This value is measured in current
character widths. The default value is zero.
T}
r-marginNUMBEROptionalT{
The right margin. This value is additive,
that is, if an element has a right margin and is (logically) contained in
another element having a right margin, the contained element will have a right
margin equal to the sum of the two values. This value is measured in current
character widths. The default value is zero.
T}
t-marginNUMBEROptionalT{
The top margin. This value takes the maximum,
that is, if an element has a top margin and is (logically) contained in another
element having a top margin, the two elements together have a top margin
equal to the greater of the two. This value is measured in current line height.
The default value is zero
T}
b-marginNUMBEROptionalT{
The bottom margin. This value takes the maximum,
that is, if an element has a bottom margin and is (logically) contained in
another element having a bottom margin, the two elements together have a
bottom margin equal to the greater of the two. This value is measured in
current line height. The default value is zero
T}
borderno-borderOptionalSpecifies the decoration type.
full-borderThe default is no-border.
horizontal-border
vertical-border
top-border
bottom-border
left-border
right-border
vjusttop-vjustOptionalT{
Vertical justification of the text of
T}
bottom-vjustT{
this element. The default is top-vjust.
T}
center-vjust
justifyleft-justifyOptionalT{
Horizontal justification of the text or data.
T}
right-justifyThe default is left-justify.
center-justifyThe numeric-justify value implies
numeric-justifyalignment of decimal points.
tgroup dispwid="6.90in"

GRPHSTYLE

  Purpose

Provides formatting and semantic information for refitem elements with a class attribute value taken from the graphic class.

SYNOPSIS
&<!ELEMENT grphstyle- O EMPTY >
__
&<!ATTLIST grphstyle(classfigure|
in-line|
button|
icon|
udefgrph)#REQUIRED
ssiCDATA#IMPLIED
rlevelNUMBER#IMPLIED
phraseCDATA#IMPLIED
l-marginCDATA#IMPLIED
r-marginCDATA#IMPLIED
t-marginCDATA#IMPLIED
b-marginCDATA#IMPLIED
border(no-border|
full-border|
horizontal-border|
vertical-border|
top-border|
bottom-border|
left-border|
right-border)#IMPLIED
vjust(top-vjust|
bottom-vjust|
center-vjust)#IMPLIED
justify(left-justify|
right-justify|
center-justify)#IMPLIED >
tgroup dispwid="6.49in"

DESCRIPTION

The grphstyle element provides semantic, font and formatting information for refitem elements with a class attribute taken from the graphic class.

When a one of the above elements is encountered in the document and that element has an ssi attribute, the toss list of grphstyle elements is searched with an attempt made to match the class and ssi attributes of the element to the class and ssi attributes of the grphstyle. If the grphstyle specifies an rlevel attribute, the search is further refined by matching the level of the element containing the element to the rlevel of the grphstyle. The level of a refitem is taken from the level of its enclosing block. If the enclosing block does not have a level attribute, the level of its enclosing virpage is used. A grphstyle element with no ssi specified, matches any ssi in a refitem element, although an explicit class/ssi pair is chosen in preference.

When a match is found, the style information contained in the grphstyle is used in formatting the graphic.

The attributes of grphstyle are:
classfigureRequiredThe general function of the graphic
in-linein the document.
button
icon
udefgrph
ssiCDATAOptionalT{
A source semantic identifier. This identifier
is chosen by the author of a higher level DTD to SDL translator. It may
either reflect the meaning of the markup in the original document or it may
reflect the actual generic identifier in the original document. The source
semantic identifier may be used to assist in semantic searches of the SDL-conforming
document by preserving the original intent of the markup. When the original
markup was conforming to a domain-specific DTD, the ssi
may be used to enable structured searches of the SDL-conforming document
by preserving the original generic identifiers.
T}
rlevelNUMBEROptionalT{
Used to further refine matches of the
class and ssi attributes. If
present, the rlevel of the grphstyle
is matched against the level of the first
containing element with level attribute.
T}
phraseCDATAOptionalT{
A natural language phrase describing the
semantics (meaning) of the element in the original SGML document that was
translated into this element. This phrase can be used to present an interface
to the reader for searching or otherwise examining the document.
T}
l-marginNUMBEROptionalT{
The left margin. This value is additive,
that is, if an element has a left margin and is (logically) contained in
another element having a left margin, the contained element will have a left
margin equal to the sum of the two values. This value is measured in current
character widths. The default value is zero.
T}
r-marginNUMBEROptionalT{
The right margin. This value is additive,
that is, if an element has a right margin and is (logically) contained in
another element having a right margin, the contained element will have a right
margin equal to the sum of the two values. This value is measured in current
character widths. The default value is zero.
T}
t-marginNUMBEROptionalT{
The top margin. This value takes the maximum,
that is, if an element has a top margin and is (logically) contained in another
element having a top margin, the two elements together have a top margin
equal to the greater of the two. This value is measured in current line height.
The default value is zero.
T}
b-marginNUMBEROptionalT{
The bottom margin. This value takes the maximum,
that is, if an element has a bottom margin and is (logically) contained in
another element having a bottom margin, the two elements together have a
bottom margin equal to the greater of the two. This value is measured in
current line height. The default value is zero.
T}
borderno-borderOptionalSpecifies the decoration type.
full-borderThe default is no-border.
horizontal-border
vertical-border
top-border
bottom-border
left-border
right-border
vjusttop-vjustOptionalT{
Vertical justification of the graphic.
T}
bottom-vjustThe default is top-vjust.
center-vjust
justifyleft-justifyOptionalT{
Horizontal justification of the graphic.
T}
right-justifytThe default is left-justify.
center-justify
tgroup dispwid="6.58in"

SEE ALSO

DtCreateHelpDialog(3), DtCreateHelpQuickDialog(3).