falso
/
cdesktopenv
mirror of https://git.code.sf.net/p/cdesktopenv/code
1
0
Fork 0
Code Issues Releases Wiki Activity
cdesktopenv/cde/doc/C/guides/docbookGuide/book.sgm

5215 lines
196 KiB
Plaintext
Raw Blame History

<!-- $XConsortium: book.sgm /main/9 1996/09/08 19:44:55 rws $ -->
<!DOCTYPE Book PUBLIC "-//HaL and O'Reilly//DTD DocBook//EN" [
<!ENTITY % ISOpublishing PUBLIC "ISO 8879-1986//ENTITIES Publishing//EN">
%ISOpublishing;
<!ENTITY % ISOnumeric PUBLIC "ISO 8879-1986//ENTITIES Numeric and Special Graphic//EN">
%ISOnumeric;
<!ENTITY % ISOalatin1 PUBLIC "ISO 8879-1986//ENTITIES Added Latin 1//EN">
%ISOalatin1;
<!ENTITY exm.docarch SYSTEM "./docbookGuide/examples/docarch.sgm" CDATA linespecific>
<!ENTITY exm.shell SYSTEM "./docbookGuide/examples/shell.sgm" CDATA linespecific>
<!ENTITY exm.chaphead SYSTEM "./docbookGuide/examples/chaphead.sgm" CDATA linespecific>
<!ENTITY exm.toc SYSTEM "./docbookGuide/examples/toc.sgm" CDATA linespecific>
<!ENTITY exm.renderas SYSTEM "./docbookGuide/examples/renderas.sgm" CDATA linespecific>
<!ENTITY exm.sect SYSTEM "./docbookGuide/examples/sect.sgm" CDATA linespecific>
<!ENTITY exm.warn SYSTEM "./docbookGuide/examples/warn.sgm" CDATA linespecific>
<!ENTITY exm.itlist SYSTEM "./docbookGuide/examples/itlist.sgm" CDATA linespecific>
<!ENTITY exm.orlist SYSTEM "./docbookGuide/examples/orlist.sgm" CDATA linespecific>
<!ENTITY exm.varlist SYSTEM "./docbookGuide/examples/varlist.sgm" CDATA linespecific>
<!ENTITY exm.seglist SYSTEM "./docbookGuide/examples/seglist.sgm" CDATA linespecific>
<!ENTITY exm.simlist SYSTEM "./docbookGuide/examples/simlist.sgm" CDATA linespecific>
<!ENTITY exm.proc SYSTEM "./docbookGuide/examples/proc.sgm" CDATA linespecific>
<!ENTITY exm.msg SYSTEM "./docbookGuide/examples/msg.sgm" CDATA linespecific>
<!ENTITY exm.tabl SYSTEM "./docbookGuide/examples/tabl.sgm" CDATA linespecific>
<!ENTITY exm.fig SYSTEM "./docbookGuide/examples/fig.sgm" CDATA linespecific>
<!ENTITY exm.ll SYSTEM "./docbookGuide/examples/ll.sgm" CDATA linespecific>
<!ENTITY exm.screen SYSTEM "./docbookGuide/examples/screen.sgm" CDATA linespecific>
<!ENTITY exm.sshot SYSTEM "./docbookGuide/examples/sshot.sgm" CDATA linespecific>
<!ENTITY exm.indterm SYSTEM "./docbookGuide/examples/indterm.sgm" CDATA linespecific>
<!ENTITY exm.link1 SYSTEM "./docbookGuide/examples/link1.sgm" CDATA linespecific>
<!ENTITY exm.link2 SYSTEM "./docbookGuide/examples/link2.sgm" CDATA linespecific>
<!ENTITY exm.anchor SYSTEM "./docbookGuide/examples/anchor.sgm" CDATA linespecific>
<!ENTITY exm.xref SYSTEM "./docbookGuide/examples/xref.sgm" CDATA linespecific>
<!ENTITY exm.refmeta SYSTEM "./docbookGuide/examples/refmeta.sgm" CDATA linespecific>
<!ENTITY exm.refnmdv1 SYSTEM "./docbookGuide/examples/refnmdv1.sgm" CDATA linespecific>
<!ENTITY exm.refnmdv2 SYSTEM "./docbookGuide/examples/refnmdv2.sgm" CDATA linespecific>
<!ENTITY exm.refnmdv3 SYSTEM "./docbookGuide/examples/refnmdv3.sgm" CDATA linespecific>
<!ENTITY exm.refsyndv SYSTEM "./docbookGuide/examples/refsyndv.sgm" CDATA linespecific>
<!ENTITY % DOCBOOK.ORIG "IGNORE">
]>
<book>
<bookinfo>
<bookbiblio>
<title>Guide to the DocBook DTD</>
<subtitle>Documentation version 1.0 for release 2.2.1</subtitle>
<authorgroup>
<corpauthor>HaL Computer Systems, Inc.</>
<corpauthor>O'Reilly &amp; Associates, Inc.</>
</authorgroup>
<releaseinfo>DTD release 2.2.1</>
<pubdate>25 February 1995</>
<copyright>
<year>1992</year>
<year>1993</year>
<year>1994</year>
<year>1995</year>
<holder>HaL Computer Systems, Inc.</>
<holder>O'Reilly &amp; Associates, Inc.</holder>
</copyright>
</bookbiblio>
<legalnotice>
<para>Permission to use, copy, modify and distribute the
DocBook DTD and its accompanying documentation for any
purpose and without fee is hereby granted,
provided that this copyright notice appears in all copies.
HaL Computer Systems and O'Reilly &amp; Associates make no
representation about the suitability of the DTD for any
purpose. It is provided &ldquo;as is&rdquo; without expressed or
implied warranty.
</para>
</legalnotice>
<legalnotice>
<para>Please direct all questions, bug reports, or suggestions for changes to davenport@ora.com or by mail to
either: Terry Allen, O'Reilly &amp; Associates, Inc.,
101 Morris Street, Sebastopol, California, 95472; or
Conleth O'Connell, HaL Computer Systems, 3006&ndash;A Longhorn
Blvd., Austin, Texas, 78758.
</para>
</legalnotice>
</bookinfo>
<![ %DOCBOOK.ORIG; [
<toc><title>Table of Contents</title>
<tocchap><tocentry pagenum="1">Acknowledgements</>
<toclevel1><tocentry pagenum="1">How to Get the DocBook DTD Online</></>
</tocchap>
<tocchap><tocentry pagenum="3">Development of the DocBook DTD</>
<toclevel1><tocentry pagenum="4">Changes Since the Last Revision</tocentry>
<!--
<toclevel2><tocentry pagenum="4">New Policy on Future Changes</tocentry></>
<toclevel2><tocentry pagenum="4">Structure of the Distribution</tocentry></>
<toclevel2><tocentry pagenum="5">Parameter Entities in the DTD</tocentry></>
<toclevel2><tocentry pagenum="5">Backward Incompatible Changes</tocentry></>
<toclevel2><tocentry pagenum="6">Other Changes</tocentry></>
-->
</toclevel1>
<toclevel1><tocentry pagenum="8">Using the DocBook DTD</tocentry></>
</tocchap>
<tocchap><tocentry pagenum="9">A Structural View of the DTD</></tocchap>
<tocchap<tocentry pagenum="11">Sets, Books, and Their Parts</>
<toclevel1>
<tocentry pagenum="14">Preface, Chapter, Appendix, Bibliography, Glossary, and Index</></>
<toclevel1><tocentry pagenum="15">Table of Contents</tocentry></>
<toclevel1><tocentry pagenum="16">Lists of Titles (LoT)</></>
<toclevel1><tocentry pagenum="16">BookInfo and DocInfo</></>
<toclevel1><tocentry pagenum="17">References</></>
<toclevel1><tocentry pagenum="18">Sections (Heads)</></>
</tocchap>
<tocchap><tocentry pagenum="21">Block-Oriented Elements</>
<toclevel1><tocentry pagenum="22">Highlights and Epigraphs</></>
<toclevel1><tocentry pagenum="22">Paragraphs</></>
<toclevel1><tocentry pagenum="23">Lists</></>
<toclevel1><tocentry pagenum="28">Procedures</></>
<toclevel1><tocentry pagenum="29">MsgSet</></>
<toclevel1><tocentry pagenum="31">Tables</></>
<toclevel1><tocentry pagenum="32">Figures and Equations</></>
<toclevel1><tocentry pagenum="34">Examples and InformalExamples</></>
<toclevel1><tocentry pagenum="34">LiteralLayouts, ProgramListings, Screens,
and ScreenShots</></>
<toclevel1><tocentry pagenum="35">BlockQuotes</></>
<toclevel1><tocentry pagenum="35">Sidebars</></>
<toclevel1><tocentry pagenum="36">Footnotes</></>
<toclevel1><tocentry pagenum="36">Admonitions and Other Blocks</></>
</tocchap>
<tocchap><tocentry pagenum="37">Elements Indicating Nonlinear Relationships</>
<toclevel1><tocentry pagenum="37">IndexTerms</></>
<toclevel1><tocentry pagenum="39">IndexEntries</></>
<toclevel1><tocentry pagenum="39">Links and Anchors</></>
<toclevel1><tocentry pagenum="40">Cross References (XRefs)</></>
</tocchap>
<tocchap><tocentry pagenum="41">In-line Elements</>
</tocchap>
<tocchap><tocentry pagenum="43">Using In-line Elements</>
</tocchap>
<tocchap><tocentry pagenum="45">Articles</>
</tocchap>
<tocchap><tocentry pagenum="47">Reference Entries</>
<toclevel1><tocentry pagenum="47">RefEntry Basics</></>
<toclevel1><tocentry pagenum="48">RefEntry Variations</></>
<toclevel1><tocentry pagenum="49">RefMeta</></>
<toclevel1><tocentry pagenum="50">RefNameDiv</></>
<toclevel1><tocentry pagenum="51">RefSynopsisDiv</></>
<toclevel1><tocentry pagenum="51">Synopses</></>
<toclevel1><tocentry pagenum="52">RefHeads</></>
</tocchap>
<tocchap><tocentry pagenum="53">Miscellaneous</>
</tocchap>
<tocchap><tocentry pagenum="55">The Elements Alphabetized</>
<toclevel1><tocentry pagenum="55">Common Attributes</></>
<toclevel1><tocentry pagenum="56">Other Attributes</></>
<toclevel1><tocentry pagenum="56">&ldquo;In-line&rdquo; vs. &ldquo;In flow&rdquo;</></>
<toclevel1><tocentry pagenum="57">CALS Tables</></>
<toclevel1><tocentry pagenum="57">List of Elements</></>
</tocchap>
</toc>
]]>
<preface Id="DB.div.1"><title>Acknowledgements</title>
<para>The DocBook DTD is a joint effort of
Hal Computer Systems Inc., and O'Reilly &amp;
Associates, Inc.
Conleth O'Connell, Eve Maler,
and Terry Allen are the current design
team for the DTD; Con deserves special mention as chief
architect. Through several revisions,
a lot of other people at several companies contributed
their insight and encouragement, among them
David Bass,
Bryan Caporlette,
Dale Dougherty,
and Steve Williams.
</para>
<sect1 Id="DB.div.2"><title>How to Get the DocBook DTD Online</title>
<para>You can find the DocBook DTD and its documentation
online in the Davenport archive
(<filename>/pub/davenport/docbook</filename>) at
<filename>ftp.ora.com</filename> (198.112.208.13).
</para>
<para>This sample session shows how to retrieve the DTD
and its documentation:
<screen>
<!-- could mark up the prompt in next line with computeroutput -->
<systemitem class="prompt">%</><userinput>ftp ftp.ora.com</>
<computeroutput>Connected to amber.ora.com.</>
<computeroutput>220 amber FTP server (Version wu-2.4(1) Fri Apr 15 14:14:30 EDT 1994) ready.</>
<computeroutput>Name (ftp.ora.com:terry): </><userinput>anonymous</>
<computeroutput>331 Guest login ok, send your complete e-mail address as password.</>
<computeroutput>Password: </><lineannotation>&larr; type e-mail address</>
<systemitem class="prompt">ftp&gt;</><userinput>cd pub/davenport/docbook</>
</screen>
The DocBook DTD and related ASCII files are in
a file named <filename>docbook.N.shar</>, where <emphasis>N</>
is the current revision number:
<screen>
<systemitem class="prompt">ftp&gt;</><userinput>get docbook.2.2.1.shar</>
</screen>
Most of these files
also exist separately and may be ftp'd individually.
</para>
<para>The <command>get</> command will put this ASCII shar
file on your system. You must later unpack
it on your system:
<screen>
<userinput>sh docbook.2.2.1.shar</>
</screen>
</para>
<para>Back to your ftp session. The DocBook documentation
is in a compressed PostScript file:
<screen>
<systemitem class="prompt">ftp&gt;</><userinput>binary</>
<systemitem class="prompt">ftp&gt;</><userinput>get docbook.ps.Z</>
</screen>
This puts the binary file <filename>docbook.ps.Z</> on your system.
You must uncompress it before sending it to a PostScript
printer or viewer.
</para>
</sect1>
</preface>
<chapter Id="DB.div.3"><title>Development of the DocBook DTD</title>
<para>The DocBook DTD defines structural SGML markup for computer
documentation and technical books. It is supported by
the Davenport Group, which is a group of software
documentation producers that was established to promote
the interchange and delivery of computer documentation
using SGML and other relevant standards.
</para>
<para>Our primary goal in developing this DTD was to filter
existing software documentation into SGML. It describes the
structures we and other producers and consumers of software
documentation have encountered in processing large bodies of
such material. While it was initiated as an interchange
format, the DTD is now coming into use as a production DTD.
</para>
<para>We expect that this DTD will evolve as it is applied to more
documents, as more SGML tools come into use, and as users
gain more experience in working with it. We are interested
in your use of the DocBook DTD and welcome comment
(see title page for addresses). We are committed to reviewing
revisions made by various groups and
evaluating them for inclusion in the next release.
</para>
<para>Groups using the DocBook DTD
for material other than software documentation may need
to extend it for their domain of applications.
Likewise, anyone may wish to construct a subset of this
DTD, or a local version that constrains authors more
tightly.
Before making changes you should read the section
near the top of the DTD itself regarding
local modifications.
</para>
<sect1 Id="DB.div.4"><title>Changes Since the Last Revision</>
<para>Both the structure of the distribution and
the content of the DTD have changed somewhat since
the last public release, 2.1.
</>
<sect2 Id="DB.div.5"><title>New Policy on Future Changes</title>
<para>We have established a new policy that we shall
make no future backward incompatible changes in
minor revisions (x.a to x.b), that
backward incompatible changes shall be made only
in major revisions (x.a to y.a), that there
shall be no more than two major revisions per
year, and that we shall
give warning of these at least six months in advance.
</>
<para>Accordingly, some future backward incompatible changes
are signalled in
&ldquo;FUTURE USE&rdquo; comments in the DTD. We expect
to make these changes in version 3.0:
<itemizedlist>
<listitem><para>The SpanEnd attribute on IndexTerm will be renamed
to indicate that it points to the content of the IndexTerm
being spanned. Another attribute will be added to be
used if it is desired to show that the IndexTerm is the
origin point of a span.
</></>
<listitem><para>FootnoteRef will be made EMPTY and its Mark
attribute renamed as Label.
</></>
<listitem><para>RevHistory will require at least one Revision.
</></></itemizedlist></para>
</sect2>
<sect2 Id="DB.div.6"><title>Structure of the Distribution</>
<para>The DocBook distribution is now composed of
the DTD, an SGML declaration, a catalogue
of public entities in the style defined in
SGML Open Technical Report 9401, and this documentation.
</>
<para>The list of public entities formerly found in the
DTD itself is now to be found in that catalogue, which
may be used with parsers that can accept it (such
as James Clark's SP).
</>
<para>Some small changes in the order of declarations
in the DTD have been made.
</>
<para>This documentation is now split up into multiple
files: one main file containing the narrative text,
and one file for each of the SGML examples. The
examples can now be written in SGML without escaping
the control characters, and they can be validated
by proper parsing. If you wish to print this document
from the SGML source, be aware that these example
files, referred to by use of the ULink element,
need to be dealt with appropriately for your application.
</>
</sect2>
<sect2 Id="DB.div.7"><title>Parameter Entities in the DTD</>
<para>There has been some rearrangement of parameter
entities. The BeginPage element and the
parameter entity &percnt;ndxterm.gp; have
been removed to a new parameter entity,
&percnt;ubiq.gp;, which is provided as an inclusion
in some content models, and excluded from others.
This means that BeginPage
and IndexTerm may appear anywhere within the contents
of the elements in which &percnt;ubiq.gp; is
included; these are the elements from the highest
level of the DocBook hierarchy (Set) down to Sect1
and RefEntry. If you use BeginPage or IndexTerm,
and wish to declare a doctype from
a lower level of the hierarchy (such as Para), you
may need to modify the DTD or redeclare the doctype
element in the prologue to your instance, including
&percnt;ubiq.gp;.
</>
</sect2>
<sect2 Id="DB.div.8"><title>Backward Incompatible Changes</>
<para>In this revision most changes are minor, although
a few are backward incompatible. As remarked above,
future backward incompatible changes are signalled
in the DTD.
</>
<itemizedlist>
<listitem><para>The elements Character, Charset, Font, and Glyph
have been removed, as have EventStructure, EventType,
Mask, and ProtocolRequest.
</para></listitem>
<listitem><para>The FAXTILE notation has been removed.
</para></listitem>
<listitem><para>IndexTerms are no longer allowed in Highlights.
</para></listitem>
<listitem><para>Footnote is now excluded from itself (beware, all
you folks who were footnoting your footnotes!)
</para></listitem>
<listitem><para>The Mark attribute on FootnoteRef (which is to
be renamed Label in a future revision) is now IMPLIED
rather than CONREF.
</para></listitem>
<listitem><para>The Width attribute has been removed from ScreenShot.
</para></listitem>
<listitem><para>Logo has been removed from the Class attribute
on ProductName and Trademark.
</para></listitem>
<listitem><para>The Linkend attribute has been removed from
ToCFront.
</para></listitem>
<listitem><para>The Linkend and PageNum attributes
formerly found on the components of ToC have been
moved to the new ToCEntry element.
</para></listitem>
</itemizedlist>
</sect2>
<sect2 Id="DB.div.9"><title>Other Changes</>
<para>Other significant
nonincompatible changes in this revision include:
<itemizedlist>
<listitem><para>A notation declaration has been added for CGM-BINARY.
</para></listitem>
<listitem><para>ProductName and ProductNumber are now available within
&percnt;docinfo.content.gp;, and thus as in-line
markup in most places.
</para></listitem>
<listitem><para>Optional is now available as in-line markup.
</para></listitem>
<listitem><para>Subtitle may now contain in-line markup.
</para></listitem>
<listitem><para>All the link elements may now contain in-line objects,
and have common attributes. XRef now has
common attributes in addition to Linkend and Endterm.
</para></listitem>
<listitem><para>LegalNotice may now contain many additional block-oriented
elements.
</para></listitem>
<listitem><para>In Revision, AuthorInitials and RevRemark are now optional.
</para></listitem>
<listitem><para>Application, CiteTitle, and Quote
may now contain a wider range of in-line
elements.
</para></listitem>
<listitem><para>Subscript and Superscript may now contain Emphasis.
</para></listitem>
<listitem><para>GlossSee and GlossSeeAlso may now contain in-line elements.
</para></listitem>
<listitem><para>PrimaryIE, SecondaryIE, TertiaryIE, SeeIE,
and SeeAlsoIE may now contain
in-line elements, and their Linkends attributes are
now IMPLIED rather than REQUIRED.
</para></listitem>
<listitem><para>Contrib has been created and included in the content
models of Author, Editor, and OtherCredit, as a place
to store information about the contributions of these
parties to the document in question. It contains
plain text.
</para></listitem>
<listitem><para>GlossList has been created: it's a set of
GlossEntries and may be used anywhere lists are
allowed.
</para></listitem>
<listitem><para>InformalExample has been created, as a parallel to
other Informal block-oriented elements. It's just
like Example, but without a title.
</para></listitem>
<listitem><para>ToCentry has been created and added to all the
components of ToC, to hold the actual entries in
a Table of Contents. It may contain plain text
and in-line elements.
</para></listitem>
<listitem><para>Address now contains the new OtherAddr for modes
of addressing not now covered by other elements.
</para></listitem>
<listitem><para>Block-oriented elements may now occur between SubSteps.
</para></listitem>
<listitem><para>Para may now properly contain InlineGraphic and
InlineEquation.
</para></listitem>
<listitem><para>Entry (a table cell) may now contain elements from &percnt;code.example.gp; (LiteralLayout,
ProgramListing, Screen, and ScreenShot).
</para></listitem>
<listitem><para>A Glossary may now close with an optional Bibliography.
</para></listitem>
<listitem><para>A RefNameDiv may now contain more than one RefClass.
</para></listitem>
<listitem><para>Editor and OtherCredit have been added as allowable
contents in AuthorGroup.
</para></listitem>
<listitem><para>A new Scope attribute has been added to IndexTerm
with the allowed values All, Global, and Local
(the default is IMPLIED), to meet the case of
IndexTerms that should be used to generate, <emphasis>e.g.</>, an index for a Book (Local)
but not an index for a Set (Global) or vice
versa; the value
All should be used when the IndexTerm should
appear in all generated indices. You should
define your implementation's default accordingly.
</para></listitem>
<listitem><para>Also, a new Zone attribute, with IMPLIED IDREFS
values, has been added to IndexTerm. This attribute
is to be used when it is desired to attach indexing
information to SGML elements rather than, or
in addition to, placing IndexTerms in the flow of
the text so as to be sure page references are
generated correctly. Zone could be used to
attach keywords to sections and paragraphs,
for example, facilitating the assembly of nonstructural
views of the indexed text.
</para></listitem>
<listitem><para>The RenderAs attribute default for Sect1--5
and Bridgehead has
been changed to IMPLIED (from the same value
as the element's generic identifier, or Other,
in the case of Bridgehead--there might be some
backward incompatibility for Bridgehead).
</para></listitem>
<listitem><para>A SrcCredit attribute has been added to Graphic,
InlineGraphic, and LoTEntry for storage of information
crediting the source of an image.
</para></listitem>
<listitem><para>Many more in-line elements now have common attributes.
</para></listitem>
<listitem><para>The ID attributes on Footnote and BeginPage are now
IMPLIED rather than REQUIRED.
</para></listitem>
<listitem><para>The PageNum attribute on Anchor is now
IMPLIED rather than REQUIRED.
</para></listitem>
<listitem><para>Part has been added as a defined value for the Pubwork
attribute on CiteTitle.
</para></listitem>
<listitem><para>GlossEntry now has a SortAs attribute, like IndexEntry.
</para></listitem>
<listitem><para>The Subject attribute on GlossDef has been changed
from NMTOKENS to CDATA.
</para></listitem>
</itemizedlist>
</para>
</sect2>
</sect1>
<sect1 Id="DB.div.10"><title>Using the DocBook DTD</>
<para>In order to
parse your document, you must specify its highest-level
element at its head, in the
document type declaration:
<screen>
<sgmltag>!DOCTYPE chapter SYSTEM &quot;-//HaL and O'Reilly//DTD DocBook//EN&quot;</sgmltag>
</screen>
or construct a shell file that contains a document type
declaration, and refers to your document as an entity.
In this case, your document should have no document type
declaration itself.
</para>
<para>Some SGML tools compilation a preparsed version of a DTD for
internal use, and may fix the doctype at that time. The Docbook DTD
as distributed may require some
assembly for input to such a tool. For example, to prepare the
DTD for compilation by ArborText's Docarch product for the doctype
Book, prepend the
SGML declaration to the DTD wrapped in a document type declaration:
<literallayout role=sgmlexample>
&exm.docarch;</>
</para></sect1>
</chapter>
<chapter Id="DB.div.11"><title>A Structural View of the DTD</title>
<para>The DTD uses the model of books to represent the content
of documentation. The primary metainformation about a
collection of documents is located at the Book level.
A collection of Books can be a Set, but no larger
structures are provided. A Book is composed
of book components, such as Prefaces
and Chapters and Appendices, some of which may be
organized in Parts.
Within these book components additional
levels of sectioning, marked as Sect1 through Sect5, may occur.
</para>
<para>A section is further organized by block-oriented
elements such as Paras (paragraphs). Other
block-oriented elements, such as lists, are
more complex, requiring other elements within them.
For example, a Listitem (an item in
a list) may contain more than one paragraph, and lists
may be nested within Listitems.
</para>
<para>In addition to its hierarchical organization, the information
may be marked up with elements that indicate nonlinear
relationships, including IndexTerms, XRefs (cross references),
and links.
</para>
<para>This DTD also provides many general and specific in-line
elements, some of which are peculiar to computer documentation.
</para>
<para>The following sections show examples of
how to combine the elements defined in the DocBook DTD.
Following these examples is a reference section with brief
definitions of all the elements.
</para>
<note>
<itemizedlist>
<listitem><para>SGML element names are not
case-sensitive. They are capitalized here for readability.
</para></listitem>
<listitem><para>A few elements appear in various contexts;
for example, Title is used for
the contents of headings at all levels.
</para></listitem>
<listitem><para>In some elements the dreaded SGML mixed
content is allowed, but it should almost always be benign.
</para></listitem>
<listitem><para>Some attributes are not mentioned in the following
description. For full details
on attributes, see the alphabetical list of elements.
</para></listitem>
</itemizedlist>
</note>
</chapter>
<chapter Id="DB.div.12"><title>Sets, Books, and Their Parts</title>
<para>Here's a diagram of a fairly vanilla Book:
</para>
<literallayout role="blockdiagram">
Book
BookInfo
ToC
LoT
Preface
Chapter
Chapter
Chapter
Chapter
Reference
Appendix
Appendix
Glossary
Bibliography
Index
</literallayout>
<para>Books may have Chapters and Appendices grouped in
Parts:
</para>
<literallayout role="blockdiagram">
Book
BookInfo
Preface
Part
PartIntro
Chapter
Chapter
Part
PartIntro
Chapter
Chapter
Chapter
Part
PartIntro
Chapter
Chapter
</literallayout>
<para>A reference manual might be
arranged like this:
<literallayout role="blockdiagram">
Book
BookInfo
ToC
LoT
Preface
Reference
Reference
Reference
Reference
Appendix
Appendix
Appendix
Appendix
Index
</literallayout>
</para>
<para>A Set of Books may
have a SetInfo and must contain two or more
Books:
<literallayout role="blockdiagram">
Set
SetInfo
Book
Book
Book
</literallayout>
</para>
<para>In this example a short Book is represented, with
its later parts commented out:
</para>
<literallayout role="sgmlexample">
&exm.shell;
</>
<para>A Book may begin with a Title and TitleAbbrev
(abbreviated title), followed in order by an optional
BookInfo, an optional ToC (Table of Contents),
any number of LoTs (List of Titles), any number of Prefaces,
main contents, and back matter.
The main contents are
required, and must be one or more Parts;
one or more Chapters followed by any
number of References;
one or more Articles; or one or more References.
All back matter is optional, but must appear in order:
any number of Appendices,
a Glossary, a Bibliography, and any number of Indexes,
followed by any number of LoTs, followed by an optional
ToC.
</para>
<para>Book has FPI and Label attributes; you can supply an
SGML Formal Public Indentifier (FPI) as the value of
the former. You might use
the number of a Book, when it is part of a Set, in
the latter.
</>
<para>The Label attribute, which is provided for other elements,
too, allows you to &ldquo;take a snapshot&rdquo; of
a document collection, or to use one particular state
of it for reference. The Mark attribute on OrderedList
and the BeginPage element do the same.
You might want to use these elements to
ensure that an on-line presentation of your document collection
can be matched to a print version by standard
reference methods (citing chapter number, number of
an item in a list, page number). If you desire to autonumber
your text you can simply disregard these attributes.
</para>
<para>Part contains an optional DocInfo, a required Title, an
optional TitleAbbrev, an optional PartIntro,
followed by one or more book components.
</para>
<para>You can use book components individually.
For example, here is a Chapter standing
on its own:
</para>
<literallayout role="blockdiagram">
Chapter
Title
TitleAbbrev
Para
Para
</literallayout>
<literallayout role="sgmlexample">
&exm.chaphead;</>
<sect1 Id="DB.div.13"><title>Preface, Chapter, Appendix, Bibliography, Glossary, and Index</title>
<para>A Chapter or Appendix
may have a DocInfo, followed by a required
Title and some text&mdash;at least a Sect,
a paragraph, a list, RefEntry, or other such structure.
<!-- component.gp -->
It may also have a
TitleAbbrev. The DocInfo may contain information
relevant to that book part alone; information general
to the collection(s) of which it is part should be
placed in the collection(s)'s BookInfo(s).
</para>
<para>A Preface, Glossary, or Bibliography must have a Title.
Thus you can use the Preface element for a foreword or
acknowledgements section
and call a Glossary or Bibliography something else, such as
&ldquo;Key Words,&rdquo; or &ldquo;Sources.&rdquo;
</para>
<para>Bibliography, Glossary, and Index are also allowed to have
more specialized contents: BiblioEntry for Bibliography,
GlossEntry for Glossary, and
IndexEntry for Index.
These specialized book parts may be divided
into BiblioDivs, GlossDivs, or IndexDivs, respectively.
(An IndexEntry is part of an Index, whereas
an IndexTerm is part of the text of a document, marking the
term to be indexed.) Additionally, an IndexDiv may have
a SegmentedList, to accommodate permuted indices.
A Glossary may end with a Bibliography.
</para>
<para>IndexEntries and IndexTerms are discussed later.
</para>
<para>BiblioEntries may begin and end with BiblioMisc,
between which there must be an ArtHeader, BookBiblio,
or SeriesInfo. This makes it possible to use the
same content model for metainformation and bibliographic
reference. (In the future there should perhaps be some way
to link from a BiblioEntry to a BookBiblio somewhere
on one's local system.)
</para>
<para>GlossEntries are pairs composed of a GlossTerm (followed optionally
by an Acronym and an Abbrev), which may contain in-line elements,
and either a GlossSee
(a cross reference to another GlossEntry where the GlossTerm is
actually defined)
or a GlossDef, which may contain elements typical of a Listitem,
followed optionally by a GlossSeeAlso
(a cross reference to another GlossEntry where there is
related information about the GlossTerm).
</para>
<para>ToC, LoT, Bibliography, Glossary, and
Index may be book components on their own or
may occur at the beginning
or end of the body of a Preface, Chapter, Appendix, or Sect.
A RefEntry (the element for a man page) cannot be
a book component, but can appear in the same places within
Preface, Chapter, Appendix, or Sect.
You could construct a Chapter this way:
<literallayout role="blockdiagram">
Chapter
Title
Para
Sect1
Title
Para
Para
Para
Glossary
Bibliography
Sect1
Title
RefEntry
RefEntry
RefEntry
RefEntry
Index
</literallayout>
</para>
</sect1>
<sect1 Id="DB.div.14"><title>Table of Contents</title>
<para>A ToC, or table of contents, may be
a book component on its own or may
occur within other book components.
ToC is subdivided to follow the divisions of a book:
following an optional DocInfo, Title, and
TitleAbbrev, a ToC may have any number of ToCFronts, which
are the entries for the front matter. Following the
ToCFronts, if any, a ToC must have either
one or more ToCParts (entries for Parts)
or ToCChaps (entries for Chapters and Appendices),
and may have any number of ToCBacks
(entries for back matter).
A ToCPart begins with one or more ToCEntries
(a wrapper for the actual table of contents
entry), then contains
any number of ToCChaps. ToCEntry
has a PageNum attribute, which may have the
value of a physical page
number. A ToCChap begins with
one or more ToCEntries, then may have any number of ToCLevel1s,
which are entries for Sect1s.
A ToCLevel1 begins with one or more ToCEntries,
then may have
any number of ToCLevel2s, and so on down to ToCLevel5,
which may have only one or more ToCEntries. Thus if you have a
Table of Contents that shows section headings,
the second-level entries
are nested within the first-level entries, and so on.
You could make a link of all or
part of the contents of a ToCEntry.
<literallayout role="sgmlexample">
&exm.toc;
</>
</para>
</sect1>
<sect1 Id="DB.div.15"><title>Lists of Titles (LoT)</title>
<para>An LoT is like a ToC except that it is used for
lists of tables, figures, and so on, and has no
hierarchy. An LoT contains LoTEntries,
which could contain links, just like ToCEntries.
LoTEntries have a PageNum attribute,
and a SrcCredit attribute, the latter for providing a
credit for the source of, <foreignphrase>e.g.</>, an
illustration.
</para>
</sect1>
<sect1 Id="DB.div.16"><title>BookInfo and DocInfo</title>
<para>A BookInfo contains metainformation about the collection
of documents of which it is a part. BookInfo
must contain a BookBiblio (a wrapper
for any information that might appear in
a bibliographic reference),
followed by any number of LegalNotices,
followed by any number of ModeSpecs (which
are link processing information sets,
pointed to by the LinkMode attribute of OLink,
and collected here for common reference).
BookInfo has a Contents attribute, the
values of which are the IDs of the ToC, LoTs,
Prefaces, Parts, Chapters, Appendixes, References,
Glossary, Bibliography, and Indexes
comprising the Book, in the order of their appearance.
</para>
<para>BookBiblio contains all the information about a book
that may be relevant to a bibliographical citation, so that
it may also be used or referred to by BiblioEntry.
In fact, all the information typically found on a
title page's recto and verso are included in BookBiblio,
except the LegalNotices, although only Title and AuthorGroup
are required. BookBiblio may contain, in order:
the required Title (the title of the Book),
optional TitleAbbrev,
Subtitle, and Edition, followed by one or more required
AuthorGroups; then, optionally, either an ISBN followed
by an optional VolumeNum (the number of the volume in
a Set) or (in case you are using Book for a journal
composed of Articles) an ISSN followed by
optional VolumeNum, optional IssueNum, and an
optional PageNums (the numbers of the pages contained in
a given issue or volume). After these elements there may
occur, again optionally and in order, one occurrence
each of the labelling
information InvPartNumber, ProductNumber, ProductName,
PubsNumber, and ReleaseInfo.
Then there may be any number
of Pubdates followed by any number of Publishers,
followed by an optional
Copyright, then an optional SeriesInfo (information
about a series the Book is published as part of).
Following that there may be any number of
Abstracts, any number of ConfGroups (wrappers for
information about a conference from which the Book
results), any number
of ContractNums mixed with any number of ContractSponsors,
and an optional
PrintHistory followed by an optional RevHistory.
</>
<para>Some of these BookBiblio elements have subelements; see
the alphabetical list of elements for details.
</para>
<para>An individual book component may have a DocInfo,
in which information pertinent only to that component
should appear. DocInfo contains, in order:
a required Title, optional TitleAbbrev and
Subtitle, followed by one or more
AuthorGroups, any number of
Abstracts, an optional RevHistory, and any number of
LegalNotices.
</para>
</sect1>
<sect1 Id="DB.div.17"><title>References</title>
<para>A Reference is a collection of RefEntries. Before
its RefEntries, it has an optional DocInfo,
a required Title, an optional TitleAbbrev,
and an optional PartIntro. It may be a book component or
may occur within a Part.
For example:
</para>
<literallayout role="blockdiagram">
Reference
Title
PartIntro
RefEntry
RefEntry
RefEntry
RefEntry
RefEntry
</literallayout>
</sect1>
<sect1 Id="DB.div.18"><title>Sections (Heads)</title>
<para>A Preface, Chapter, or Appendix may contain
up to five levels of hierarchical sections called Sect1, Sect2, and so on.
In a RefEntry, these are RefSect1 through RefSect3
(no further subheads). Headings must be
nested properly: a Sect3, for example, is not allowed
directly under a Sect1 without a Sect2 in between.
Sects1--4 that contain lower-level Sects
may be empty of other content. However, a Bridgehead
(a heading not contained in a wrapper associating
it with the text following, and independent of the
Sect hierarchy)
may be inserted between block-oriented elements anywhere,
with its Renderas attribute set to an appropriate value.
Sects also have a Renderas attribute, so that you may
accomodate cases for which it is desired that,
for example, all the headings in a book part
appear as third-level heads:
<literallayout role=sgmlexample>
&exm.renderas;
</>
</para>
<para>The Docbook DTD does not allow
you to put paragraphs, lists, and other
block-oriented
elements between Sects.
</para>
<para>A section includes a Title
(the text of the heading itself) and all material
following, up to the end of the document or the next section at the same
level or the end of the higher-level section that contains the
section in question.
Consequently, anything may occur in a section except another
book component (DocInfo, Glossary, and
so on) or another section of the same or higher level; deeper
sections must be nested properly.
</para>
<literallayout role=sgmlexample>
&exm.sect;</>
<para>Sections have a Label attribute, in case you wish to
hard-code section numbering for reference.
</para>
</sect1></chapter>
<chapter Id="DB.div.19"><title>Block-Oriented Elements</title>
<para>Most book components can contain the following
block-oriented elements, some of them in formal
and informal dress. Informal elements such as
InformalTable are simply untitled equivalents
of their formal sisters (Table), and are not to
be listed in a LoT (such as a List of Tables).
</para>
<itemizedlist>
<listitem><para>Highlights (list of main points)
</para></listitem>
<listitem><para>an Epigraph
</para></listitem>
<listitem><para>Paragraphs
</para></listitem>
<listitem><para>Lists
</para></listitem>
<listitem><para>Procedures
</para></listitem>
<listitem><para>MsgSets (error messages)
</para></listitem>
<listitem><para>Admonitions (Warnings, Tips, and so on)
</para></listitem>
<listitem><para>Tables and InformalTables
</para></listitem>
<listitem><para>Figures and Equations
</para></listitem>
<listitem><para>Examples and InformalExamples
</para></listitem>
<listitem><para>LiteralLayouts, ProgramListings, Screens, and ScreenShots
</para></listitem>
<listitem><para>Graphics
</para></listitem>
<listitem><para>BlockQuotes
</para></listitem>
<listitem><para>Sidebars
</para></listitem>
<listitem><para>Footnotes
</para></listitem>
<listitem><para>Admonitions, and other blocks
</para></listitem>
</itemizedlist>
<sect1 Id="DB.div.20"><title>Highlights and Epigraph</title>
<para>Highlights (a section of major points appearing in the book
component) typically appears below the Title or
below any Epigraph, or may be extracted and presented
separately.
</para>
<para>An Epigraph (a section of poetry or prose, usually
specially formatted) typically occurs between a book component's
Title and other content.
</para>
</sect1>
<sect1 Id="DB.div.21"><title>Paragraphs</title>
<para>Paragraphs are the lowest level of
ordinary text that you need to tag except for
in-line elements. The DocBook DTD offers three kinds of paragraphs.
Para may contain block-oriented elements
(for example, lists, and Figures), while SimPara excludes
them. FormalPara requires a Title, while Para and
SimPara may not have Titles.
FormalPara, Para, and SimPara are allowed in exactly
the same contexts. No provision is made, in the case of
SimPara, for indicating indentation of
&ldquo;continuation paragraphs&rdquo;, or paragraphs following
a object such as a Figure; in the case of
FormalPara and Para no such provision is needed.
</para>
<para>In some cases, such as admonitions and Footnotes,
paragraph tags are required within the outer tags, to allow
multiple paragraphs. Thus a paragraph may be nested within
a paragraph if a wrapper intervenes.
<literallayout role=sgmlexample>
&exm.warn;
</>
</para>
<para>Lists contain ListItems, which typically contain
paragraphs; ListItems, too, may contain more than one
paragraph. (See List examples below.)
Aside from straight text and, in the case of
SimPara, block-oriented elements,
paragraphs may contain any of the in-line
elements discussed
in the &ldquo;In-line Elements&rdquo; section.
</para>
</sect1>
<sect1 Id="DB.div.22"><title>Lists</title>
<para>There are six kinds of lists:
</para>
<itemizedlist>
<listitem><para>ItemizedList (bulletted, dashed, and so on)
</para></listitem>
<listitem><para>OrderedList (numbered or lettered)
</para></listitem>
<listitem><para>VariableList (composed of paragraphs or sets of paragraphs
with associated Terms)
</para></listitem>
<listitem><para>SegmentedList (a series of entries composed of equal
numbers of segments, with optional titles pertaining
to all the first segments, all the second segments,
and so on)
</para></listitem>
<listitem><para>SimpleList (composed of terms that may be arranged in columns
or in-line)
</para></listitem>
<listitem><para>GlossList (composed of GlossEntries only)
</para></listitem>
</itemizedlist>
<para>Lists may be
nested within ListItems (an ItemizedList inside a ListItem
of an OrderedList, for example),
and ListItems may include paragraphs and other block-oriented
elements which themselves may contain lists.
</para>
<para>ItemizedLists use the Mark attribute to determine the
character that precedes each ListItem. You may leave
this to an application to decide, or supply a
text string (there is no default and there are no
generally agreed upon strings) to specify the mark that
should appear before
each ListItem. While the value of the Mark attribute is
not confined to an entity (such as &amp;check;) the processsing
expectation should be that it is.
The Mark
value can be overridden at the ListItem level
by the value of the ListItem's Mark attribute,
if it is supplied.
</para>
<para>Here's an ItemizedList:
<literallayout role=sgmlexample>
&exm.itlist;
</>
</para>
<para>Normally an ItemizedList nested within a list of
the same type is given a different mark or alphanumeric
style (as in an outline).
The DocBook DTD does not define any default sequence of marks.
You must either indicate them by using the appropriate
attributes or instruct your
rendering application that, for example, the
sequence of marks for an
ItemizedList that contains another ItemizedList is
bullets, then dashes.
</para>
<para>OrderedLists may use the Numeration attribute to
determine how the list is numbered. This attribute
has a delimited set of values:
Arabic (1, 2, 3), Upperalpha (A, B, C), Loweralpha
(a, b, c), Upperroman (I, II, III), or
Lowerroman (i, ii, iii). If extensions are needed, for example in the
case of Japanese or Arabic documents, the values
LocalAlpha and
LocalNumber might be used, though these are not now
supported.
There is no default.
OrderedList
also has a Continuation attribute, to
indicate whether the numbering of a list begins afresh
(the default) or
continues the numbering of the immediately preceding list.
Finally, OrderedList has an InheritNum attribute, the values
of which are Inherit and Ignore. Ignore is the default;
<foreignphrase>i.e.</>, numbering
starts over (1, 2, 3 instead of 3.1, 3.2, 3.3).
Set InheritNum to Inherit if you want nested lists to
pick up the numbering of the ListItem within which they
are nested (an OrderedList nested under the
third ListItem of another OrderedList is numbered
3.1, 3.2, 3.3, instead of 1, 2, 3).
</para>
<literallayout role=sgmlexample>
&exm.orlist;
</>
<para>A VariableList may have a Title and TitleAbbrev,
and must have VarListEntries, each of which contains a set of
one or more Terms followed by
a ListItem. As of this revision, the set of Terms (even
if there is only one Term) must be contained with a TermGrp
wrapper, but as both start- and end-tags of TermGrp are
omissible, instances conforming to DocBook 2.1 need not be
changed and TermGrp may be omitted when constructing instances.
(However, once normalized, an instance will probably contain
TermGrp tags.)
Terms may contain in-line
elements. Schematically a VariableList looks like this:
<literallayout role="blockdiagram">
VariableList
VarListEntry
Term
Term
ListItem
Para
Para
VarListEntry
Term
ListItem
Para
VarListEntry
Term
ListItem
Para
</literallayout>
</para>
<para>In actual markup:
<literallayout role=sgmlexample>
&exm.varlist;
</>
</para>
<para>A SegmentedList is composed of labelled
sets of information,
and may be used to represent information
that is often presented in simple tables. A SegmentedList
may have a Title and TitleAbbrev, followed by any number of
SegTitles and two or more SegListItems. SegListItems
are composed of two or more Segs, which may contain
in-line elements. You might render a SegmentedList
in tabular form, or use some other typographic arrangment,
such as:
<literallayout role="sgmlexample">
&exm.seglist;
</>
</para>
<para>This SegmentedList might appear in print as follows:
<literallayout>
Museum: Asian Art Museum
City: San Francisco
Collections: East Asian, Indian, and Islamic
</literallayout>
<literallayout>
Museum: British Museum
City: London
Collections: all areas
</literallayout>
<literallayout>
Museum: Louvre
City: Paris
Collections: mostly paintings
</literallayout>
</para>
<para>A SimpleList is intended for long lists of single words
or short phrases. It consists of one or more Members, and
has Columns and Type attributes.
The value of Type may be Vert (the default),
Horiz, or Inline. Inline indicates that the list
should be formatted as a regular part of a paragraph,
with commas and &ldquo;and&rdquo; inserted, such as:
<literallayout role="sgmlexample">
&exm.simlist;
</>
<literal>a, b, c, d, e, f, g, h, i, j, k,</> and <literal>l.</>
Vert and Horiz indicate that the Members
should be displayed in the number of columns
specified by the Columns attribute (the default
is 1). If the value of Type is Vert, the Members should be
ordered from top to bottom of each column:
<literallayout role="blockdiagram">
a d g j
b e h k
c f i l
</literallayout>
</para>
<para>If Horiz,
the Members should be ordered left to right, one row at
a time:
<literallayout role="blockdiagram">
a b c d
e f g h
i j k l
</literallayout>
</para>
</sect1>
<sect1 Id="DB.div.23"><title>Procedures</title>
<para>A Procedure is a quasilist of operations to
be performed. Procedure may have a Title and
TitleAbbrev, followed by block-oriented elements,
such as paragraphs, followed by one or more Steps.
A Step may have a SubSteps wrapper for Steps nested
within it, and this nesting may continue indefinitely
(contrast the methods of nesting lists and Sects).
This construction is intended to maximize the reusability
of subsections of Procedures.
Note that &ldquo;SubSteps&rdquo; is an element name,
not the plural of SubStep (there is no element named
SubStep).
</para>
<para>After an optional Title, a Step must consist either
of block-oriented elements such as
paragraphs followed optionally by a SubSteps element,
or simply a
SubSteps element. A SubSteps then contains one or more
Steps&mdash;it is a wrapper. Block-oriented elements may
occur between the SubStepses.
<literallayout role="sgmlexample">
&exm.proc;</>
</para>
</sect1>
<sect1 Id="DB.div.24"><title>MsgSet</title>
<para>A MsgSet is a quasilist of messages produced
by a system, with various additional information.
These are typically error messages, but they
could conceivably be congratulatory
or soothing messages to the user.
Please note that the entire Msg*
construction is new and complicated;
it may be simplified in the future.
</para>
<para>MsgSet contains one or more MsgEntries, which
are merely wrappers, each containing
one or more Msgs, followed by an optional
MsgInfo, then any number of MsgExplans.
</para>
<para>Msg is the part of a MsgEntry that contains
the error message and its subparts, along with
explanatory text. A Msg has a required MsgMain,
followed by any number of MsgSubs and MsgRels, in any
order.
</para>
<para>MsgMain is the main error message of a
Msg. MsgMain begins with an optional Title,
followed by MsgText, the real content of the message
(containing may be block-oriented elements).
</para>
<para>MsgSub contains messages that appear in various
contexts. It, too,
contains a an optional Title followed by
MsgText. MsgRel contains
a message that is related to the main message
(MsgMain) but which appears in a
different place. For example, MsgMain
might be a message that appears on a
network client, and MsgRel a related message
that appears at the
server console in response to the same condition or event.
MsgRel begins with an optional Title and contains
MsgText.
</para>
<para>That finishes the Msg part of MsgEntry; there remain
MsgInfo and MsgExplan.
</para>
<para>MsgInfo holds information about the Msg
containing it. It may have any number of MsgLevels,
MsgOrigs, and MsgAuds, in any order.
MsgLevel describes, in plain text,
the level of importance or severity
of a Msg. MsgOrig describes, in plain
text, the origin of a Msg.
MsgAud describes, again in plain text, the audience
to which a Msg is
relevant.
</para>
<para>MsgExplan is a holder for any kind of explanatory
material relating to the
Msg. MsgExplan begins with an optional Title
(typically something such as
&ldquo;Explanation:&rdquo; or &ldquo;Action:&rdquo;)
and may contain block-oriented elements.
<literallayout role=sgmlexample>
&exm.msg;</>
</para>
</sect1>
<sect1 Id="DB.div.25"><title>Tables</title>
<para>A Table is an ordered array of text, usually with a title
and headings. This information may be represented in SGML,
but it may also be convenient to provide it in
another form. The DocBook
DTD allows you to mark up a table in SGML or to provide
a graphic representation of it in an external file
by using the Graphic element.
The Table fragment was derived from
the CALS MIL-28001
DTD.
</para>
<para>A Table has a required Title, a TitleAbbrev, and one or more
Graphics (which may be
pointers to external files that contain the Table formatted
in a different way) or one or more TGroups, which are
slabs of CALS table. For details on the contents of
Table see the alphabetical list of elements; Tables may
not be nested within Tables, but a Table may contain
an EntryTbl, which achieves the same effect.
InformalTable is Table's untitled sister.
</para>
<para>With this revision, the
content model of Entry (the contents of a table cell)
has been broken into two possibilities:
paragraph-like elements (Para, Note, LiteralLayout, lists,
etc.), and in-line content, to avoid the unwanted possibility
that block-oriented elements could be mixed with free text.
You may include one but not
the other. However, this means that no line breaks may occur
between tags within an Entry (the only place in this DTD
where this effect is produced). In the future, a wrapper for
in-line content may be provided so as to avoid this difficulty.
<literallayout role="sgmlexample">
&exm.tabl;
</>
</para>
<para>For Graphic, see <emphasis>Figure,</> below.
</para></sect1>
<sect1 Id="DB.div.26"><title>Figures and Equations</title>
<para>A Figure must have
a Title, may have a TitleAbbrev, and may contain
one or more of the following:
<!-- object.gp, links.gp -->
BlockQuote, CmdSynopsis, FuncSynopsis, InformalEquation,
Graphic, InformalTable, Link, LiteralLayout, OLink,
ProgramListing, Screen, ScreenShot, Synopses, and
ULink.
</para>
<para>A Graphic may contain graphical data or point to
an exterior
file that contains such data. It has an ID attribute
and a Format attribute that indicates how the
data is formatted. Format may have the value
CGM-BINARY, CGM-CHAR, CGM-CLEAR, DITROFF, DVI, EPS,
EQN, FAX, GIF, IGES, PIC, PS, TBL, TEX,
TIFF (see the &ldquo;NOTATIONS&rdquo; section of the
DTD for details about these formats). There is no
default. Graphic may point to an external file via
its Fileref or Entityref attributes. The value of
Fileref should be a filename; the value of
Entityref should be that of an
external data entity. These attributes may conflict,
so an order of precedence is specified:
if data is given as the
content of Graphic, neither Entityref nor Fileref
should be given but a Format value should be supplied.
If no data is given as the content of
Graphic, only one of Entityref
Fileref should be given; if both are present,
Entityref pre&euml;mpts Fileref. If either
of those attributes is used, Format should not be.
</para>
<para>Whether Graphic occurs within or between paragraphs,
it is to be displayed as a block (that is,
Graphic is an informal figure);
if a graphical image is to be presented in-line,
it must be marked as an
InlineGraphic, which is otherwise just like Graphic.
</para>
<para>Figure has common,
Label, and Float attributes; Float indicates
whether the Figure is to be rendered
where convenient (use the value 1) or at
the place it occurs in the text (the default; use the value 0).
<literallayout role="sgmlexample">
&exm.fig;
</>
</para>
<para>Equations are solely graphical (math support is to be
added in a future revision).
An Equation may have a Title and TitleAbbrev, and
then contains one or more InformalEquations
or Graphics, in any order. InformalEquation
is an untitled equation to be displayed as a block,
like InformalTable, and may contain one or more
Graphics; it has common attributes. InlineEquation
is just the same as InformalEquation, but is to
be display in-line.
</para>
</sect1>
<sect1 Id="DB.div.27"><title>Examples and InformalExamples</title>
<para>Example is defined very loosely, so that
a program listing can be accompanied by other
block-oriented elements.
An Example must have a Title, may have a TitleAbbrev,
and then contains any combination of paragraphs,
lists, and other block-oriented elements.
An InformalExample is just the same, but without
a Title.
</para>
</sect1>
<sect1 Id="DB.div.28"><title>LiteralLayouts, ProgramListings, Screens,
and ScreenShots</title>
<para>The DocBook DTD provides three elements for material
set off from the main text, in which
white space and line breaks are to be considered
significant: LiteralLayout, ProgramListing, and
Screen. All of these elements
may contain in-line elements only, not
block-oriented elements. They all have a Width
attribute, which is some number indicating to an
application how wide the widest line is, and
a fixed Format attribute, with the value &ldquo;linespecific.&rdquo;
</para>
<para>LiteralLayout is the simplest of the linespecific elements.
It consists only of the set-off lines:
<literallayout role="sgmlexample">
&exm.ll;
</>
</para>
<para>A ProgramListing is just like a LiteralLayout, but should
be reserved for listings of programs, which may require
a different style of presentation. ProgramListings,
like the other line-specific elements,
may have LineAnnotations, which are a document author's
comments on the code, not the comments written
into the code itself by the code's author.
</para>
<para>A Screen is a representation of all or part of a screen
display, which may be textual or graphical.
A Screen contains text and in-line elements,
in the manner of a LiteralLayout. A Screen has no Title;
if you want
a Screen to have a Title, enclose it in a Figure or Example.
Here's a Screen with text content:
<literallayout role="sgmlexample">
&exm.screen;
</>
</para>
<para>If you want to represent a Screen's contents graphically,
use the ScreenShot element. A ScreenShot
contains an
optional ScreenInfo and a required Graphic.
The ScreenInfo is a comment about how the image in the
Graphic was created (so you can recreate it if need be),
and is not meant to be displayed or printed; it contains
plain text.
</para>
<para>Here's a ScreenShot:
<literallayout role=sgmlexample>
&exm.sshot;
</>
</para>
</sect1>
<sect1 Id="DB.div.29"><title>BlockQuotes</title>
<para>BlockQuote is intended for a quotation set off from
the main text, rather than occurring in-line (for an in-line
quote, use Quote).
In a BlockQuote white space is not significant: the lines
wrap. A BlockQuote contains paragraphs and other block-oriented
elements, not plain text.
</para>
</sect1>
<sect1 Id="DB.div.30"><title>Sidebars</title>
<para>A Sidebar is a segment of text isolated from the narrative
flow of the main text, typically boxed and allowed to float
in the page layout. Magazines and newspapers contain
many sidebars. A Sidebar may have
a Title and a TitleAbbrev, and must have text in the
form of paragraphs, lists, Figures, or
other block-oriented elements;
no Sects or other Sidebars are allowed.
</para>
</sect1>
<sect1 Id="DB.div.31"><title>Footnotes</title>
<para>Footnotes may be marked up in two ways.
In one method,
within a paragraph or other element, the location of the
footnote mark should be indicated with
FootnoteRef, which points to the
corresponding Footnote with its Linkend attribute,
the value of which is the ID of the associated Footnote.
The Footnote need not be anywhere close to the FootnoteRef.
FootnoteRef may contain plain text, which is the mark to be
displayed, or it may be empty, in which case its Mark
attribute provides
another way of indicating the contents of the mark,
such as an asterisk (*), a number (84), or a dingbat specified by
a name that is to be interpreted by the application. While
the DTD does not specify that the value of Mark be an entity,
the processing expectation should be that it is
(<foreignphrase>e.g.</>, &amp;dagger;).
</para>
<para>Using the other method, a
Footnote may occur at the spot where it is desired to generate
the footnote mark. The mark may be left to be generated
automatically, or a FootnoteRef may be supplied to specify it.
</>
<para>Footnote may contain any of the following, but may not
contain another Footnote:
<!-- para.gp, list.gp, object.gp -->
BlockQuote,
CmdSynopsis,
FuncSynopsis,
Graphic,
InformalEquation,
InformalTable,
LiteralLayout,
any kind of paragraph,
ProgramListing,
Screen,
ScreenShot,
Synopsis,
and any kind of list.
</para>
</sect1>
<sect1 Id="DB.div.32"><title>Admonitions and Other Blocks</title>
<para>Admonitions are special sections of text that
call attention to some matter of importance. Admonitions
are one of the following elements:
Caution, Important, Warning, Tip, and Note.
They may have Titles,
paragraphs, and other block-oriented elements,
but no Sects or other admonitions.
</para>
<para>Abstract (a document summary) and AuthorBlurb
(author information) may have Titles and paragraphs.
</para>
</sect1>
</chapter>
<chapter Id="DB.div.33"><title>Elements Indicating Nonlinear Relationships</title>
<para>IndexTerms, Links, Anchors, and XRefs all indicate
nonlinear relationships within the text&mdash;unlike the
hierarchical nesting of
Sects and the linear flow of paragraphs within Sects.
</para>
<sect1 Id="DB.div.34"><title>IndexTerms</title>
<para>IndexTerms are words or phrases to be indexed.
The DocBook DTD provides for
three levels of indexing, as well as for &ldquo;see&rdquo; and &ldquo;see
also&rdquo; indexing. IndexTerms may occur almost anywhere,
but their contents may not do double duty as part
of the text: the contents of IndexTerm do not appear in the text itself.
</para>
<para>An IndexTerm must contain a Primary, and may contain a
See and one or more SeeAlsos, as well as a Secondary; within
Secondary there may be a See and one or more
SeeAlsos, as well as a Tertiary; a Tertiary may include
a See and one or more SeeAlsos, also.
IndexTerm has common, SpanEnd, PageNum,
Significance, Scope, and Zone attributes.</>
<para>The SpanEnd attribute is for use in an IndexTerm
ending a span
of text to be indexed; that IndexTerm must be
empty (have no content or end tag) and must have
as the value of SpanEnd the ID of the IndexTerm
that begins the span, earlier in the text.
The PageNum attribute may be used to
indicate the page on which the indexed term is found in
print. Significance may have the value Preferred,
indicating that the entry is the most pertinent of the
series, or Normal (the default).
</>
<para>The Scope attribute, which may
have the values All, Global, or Local
(the default is IMPLIED), can be used to meet the case of
IndexTerms that should be used to generate,
<foreignphrase>e.g.</>, an index for a Book (Local)
but not an index for a Set (Global) or
<foreignphrase>vice versa</>; the value
All should be used when the IndexTerm should
appear in all generated indices. You should
define your implementation's default accordingly.
</para>
<para>The Zone attribute
is to be used when it is desired to attach indexing
information to SGML elements rather than, or
in addition to, placing IndexTerms in the flow of
the text so as to be sure page references are
generated correctly. Zone could be used to
attach keywords to sections and paragraphs,
for example, facilitating the assembly of nonstructural
views of the indexed text. The values of Zone should
be the IDs of the element or elements referred to.
<literallayout role="sgmlexample">
&exm.indterm;
</literallayout>
</para>
</sect1>
<sect1 Id="DB.div.35"><title>IndexEntries</title>
<para>IndexEntries, which occur in the Index,
might be constructed by extracting
and processing the IndexTerms.
</para>
<para>IndexEntries themselves
are put together just like IndexTerms, with the
corresponding elements PrimaryIE, SecondaryIE,
TertiaryIE, SeeIE, and SeeAlsoIE.
</para>
</sect1>
<sect1 Id="DB.div.36"><title>Links and Anchors</title>
<para>A link is a pointer to another section in the document, or
to another document. The link elements
are still somewhat provisional, and are under active
review. The most conventional of them
is Link, which may include in-line elements as
text and has a required Linkend attribute, which is the ID
of the element it is linked to. It also has a Type
attribute, so you can assign a role to a Link.
And Link has an Endterm attribute, the value of which
may be the ID of an element whose content
is to appear as the text of the Link.
For example, Link might give the label of a
hot spot explicitly:
<literallayout role="sgmlexample">
&exm.link1;
</>
or a Link might point to a section and display its title:
<literallayout role="sgmlexample">
&exm.link2;
</>
where the content of the element that bears the ID
T1-061-ch05-1 (perhaps the title of Chapter Five)
is displayed as the hot spot. (This is
effectively an unclean form of CONREF.)
</para>
<para>Please note that the common attribute XRefLabel
provides another mechanism for displaying text
associated with a Link's target.
</para>
<para>Link uses the SGML mechanism of IDREF in pointing to
an element by its ID.
An SGML application may report an IDREF error
when the ID does not occur in the document set being
processed. This may be harmless.
</para>
<para>Anchor is an in-line element that marks a location as a
target for a Link (any element bearing an ID
may be a target, of course). Anchor has ID,
PageNum, Remap, Role, and XRefLabel attributes,
but only the ID is required.
It is an empty element: at minimum,
the start tag is supplied, with an ID only:
<literallayout role="sgmlexample">
&exm.anchor;
</>
You could also supply a value for the XrefLabel
attribute to provide text to be generated by an XRef to
the point marked by that Anchor.
</>
<para>Two other links are provided, OLink
(a link that performs some operation on its target)
and ULink (a link that uses a Universal Resource
Locator, useful for making reference by pathname and
filename).
</para>
<warning><para>Neither OLink nor ULink
is a traditional SGML link, though both are fully
conformant to ISO 8879 (the SGML standard). In particular,
ULink stores all link information in a format that
SGML does not process. Conventional
SGML browsers may not yet work with ULinks.
</para>
</warning>
</sect1>
<sect1 Id="DB.div.37"><title>Cross References (XRefs)</title>
<para>An XRef is a cross reference to another part of a document.
It has Linkend and Endterm attributes, just like Link,
but like Anchor, it may not have content.
XRef must have a Linkend, but the Endterm is optional.
If it is used, the content of the element it points
to is displayed as the text of the cross reference;
if it is absent, the XRefLabel of the cross-referenced
object is displayed.
<literallayout role="sgmlexample">
&exm.xref;
</>
</para>
<para>The example above references the section that has the ID
&quot;ch05-s1&quot;and supplies the text of its
Title, which has the ID &quot;ch05-t1&quot;, in
the manner of: &ldquo;See <emphasis>Terminal
Emulation and the xterm Terminal Type</>
for more information.&rdquo;
</para>
<para>To include in the cross reference text generated
text that may be associated with the target, <foreignphrase>e.g.,</>
&ldquo;Figure 5-1.&rdquo;, use the same mechanism you employ
to generate that text in the first place (your
application's defaults or style sheet).
</para>
</sect1>
</chapter>
<chapter Id="DB.div.38"><title>In-line Elements</title>
<para>In-line elements
are used to label specific terms or usage.
In-line elements may appear anywhere in
a block-oriented element, but may not span two
block-oriented
elements. In documentation these
elements are typically
indicated by font changes.
</para>
<para>All of the elements defined in the DTD in the
parameter entities that comprise
inlinechar.gp may appear in-line. (See the
Reference section for brief definitions of in-line elements.)
</para>
</chapter>
<chapter Id="DB.div.39"><title>Using In-line Elements</title>
<para>Trying to determine the most specific in-line element
that can be applied to the specialized terms in your
document can be time-consuming and frustrating. Instead,
you may wish to tag these terms using only the most general
in-line elements. We have found it useful, in
converting files from troff to SGML, to translate the
font changes that mark off these terms in print into
five DocBook tags: Emphasis, Literal, Parameter,
UserInput, and Interface (which correspond
well to our conventional use of
italic, typewriter font, italic typewriter, bold
typewriter, and sans serif; you may wish to choose
other values).
</para>
<para>Some such tags (Application, Database,
Interface, MediaLabel, Parameter, Replaceable,
SystemItem, Trademark, and SGMLtag) have
a Class attribute with delimited values for each
element. This mechanism provides a two-step
approach toward specifying the meanings of
in-line terms. For example, an Interface may
be further specified as Button, Icon, Menu, or
MenuItem through its Class attribute. You can
thus indicate the general meaning of the term
or be more precise, as you like.
</para>
</chapter>
<chapter Id="DB.div.40"><title>Articles</title>
<para>A Book may consist
of Articles, in which case it represents an issue of a journal
(and you should provide its ISSN, not ISBN, in the BookInfo)
or a collective work, such as an anthology.
</para>
<para>An Article has, in order,
a required ArtHeader, main contents as for Chapter,
then any number of Indexes, Glossaries, Bibliographies,
Appendixes and Acknos, in any order. Article has
common and ParentBook attributes, the latter pointing
to the ID of the enclosing Book. For the details of ArtHeader,
see the alphabetical list of elements.
</para>
</chapter>
<chapter Id="DB.div.41"><title>Reference Entries</title>
<para>A man page or reference page is a distinct form of reference
information. We have modelled our RefEntry element on man
pages. In this DTD, a RefEntry may occur within a
Chapter or Appendix, or
a collection of RefEntries may be made into a book component
called Reference.
</para>
<sect1 Id="DB.div.42"><title>RefEntry Basics</title>
<para>A RefEntry contains, in order:
one DocInfo (optional);
one RefMeta (optional);
one or more Comments, links, FootnoteRefs,
or XRefs (optional);
one RefNameDiv (required);
one RefSynopsisDiv (optional);
one or more RefSect1s (required). Schematically,
with additional elements particular to RefEntries:
<literallayout role="blockdiagram">
RefEntry
DocInfo
RefMeta
RefEntryTitle
ManVolNum
RefMiscInfo
RefNameDiv
RefName
RefPurpose
RefSynopsisDiv
Synopsis
RefSect1
RefSect2
RefSect2
RefSect1
RefSect1
</literallayout>
</para>
</sect1>
<sect1 Id="DB.div.43"><title>RefEntry Variations</title>
<para>Reference entries have conventional divisions, but no single
definitive conventional format.
The arrangement
of information in the initial divisions of a reference entry
may be rather complicated. RefEntry accomodates
several alternate structures for this information.
For example, a typical reference
entry has only a single subject (here, RefName), which is
named in a division that is usually called &ldquo;Name&rdquo;
(here, RefNameDiv), and is followed by
an em dash and a short descriptive phrase (here, RefPurpose).
A reference entry for <emphasis>mwm,</>
the Motif window manager,
might have this text in its Name division:
&quot;mwm &mdash; the Motif window manager&quot;
</para>
<para>This is simple to tag: &ldquo;mwm&rdquo; is a RefName and
the descriptive phrase is a RefPurpose (the em dash should
not be represented in the SGML document).
</para>
<para>Other reference entries may provide
a purpose statement on more than one subject
(command, function, file format, and so on).
For example, in a reference entry for <emphasis>grep</>
there may be several subjects described by the same purpose
statement:
&quot;grep, egrep, fgrep &mdash; search a file for a string or regular expression&quot;
</para>
<para>Here all the terms in the series are RefNames, and should
be tagged individually.
</para>
<para>Still other
reference entries may provide a group name for a series of subjects
that is not itself one of the subjects discussed. For example,
in an AT&amp;T reference entries called &ldquo;string,&rdquo; the name of
the reference entry is given in this manner:
&quot;string: strcasecmp, strncasecmp &mdash;
string operators&quot;
</para>
<para>In this series, &ldquo;string,&rdquo;
is not a function name like the terms that follow the colon
following &ldquo;string.&rdquo; In a RefEntry the word &ldquo;string&rdquo;
is tagged as a RefDescriptor, which is an optional rather
than a required element of RefNameDiv.
</para>
<para>Many of the higher-level elements of RefEntry may occur only
within
RefEntries, not within Chapters or other book components.
These are: RefMeta, RefEntryTitle, ManVolNum, RefMiscInfo,
RefNameDiv, RefDescriptor, RefName, RefPurpose, RefSynopsisDiv, and RefSect1--3.
</para>
</sect1>
<sect1 Id="DB.div.44"><title>RefMeta</title>
<para>The RefMeta contains, in order,
a RefEntryTitle, an optional ManVolNum, and any number of
RefMiscInfos.
</para>
<para>All this is metainformation, some of which may occur
in the heading of a reference entry. None of it is from the
body of a reference entry.
RefEntryTitle is the primary name by which the
reference entry is sorted and indexed.
ManVolNum is the alphanumerical
designation often supplied in parentheses after the RefEntryTitle,
as in &ldquo;string(3C).&rdquo; It refers to the historical arrangement
of reference entries in sections. Other pieces of
information
may follow the ManVolNum,
each
captured with the tag RefMiscInfo, so that you may have a
series of RefMiscInfos (as many as eight have been reported
in legacy documents). For example, O'Reilly's reference entry for
XmuReshapeWidget includes the heading
&ldquo;Xmu&mdash;Shape
Extension Utilities,&rdquo; which should be tagged as a RefMiscInfo.
Other examples of RefMiscInfo contents are copyright,
date, draft status, hardware architecture, and a descriptive
phrase for use in a print header.
Of these RefMeta elements, only RefEntryTitle
may contain in-line elements; the others may
contain only plain text.
</para>
<para>Do not be confused by the fact that RefEntryTitle may
contain the same contents
as RefName in the RefNameDiv. For the <emphasis>mwm</> reference
entry, &ldquo;mwm&rdquo; is the content of both RefEntryTitle and
RefName. This may not always be the case, as in the
&ldquo;string&rdquo; example above: in that instance, &ldquo;string&rdquo; is
the content of RefEntryTitle, but it is not a RefName.
Remember, the RefMeta does not contain the contents of
the Name division of a reference entry, only metainformation.
<literallayout role="sgmlexample">
&exm.refmeta;
</>
</para>
</sect1>
<sect1 Id="DB.div.45"><title>RefNameDiv</title>
<para>RefNameDiv is the top division
of a reference entry, the one usually labelled &ldquo;Name.&rdquo;
The RefNameDiv contains, in order, an optional
RefDescriptor (for reference entries such as the &ldquo;string&rdquo;
example), one or more RefNames, a required RefPurpose,
followed by any number of RefClasses.
Comments, FootnoteRefs, links, or
XRefs may also appear at the end of RefNameDiv.
</para>
<para>In RefClass you indicate the
applicability or scope of the topic of a RefEntry
(such as &ldquo;LocalBlocking&rdquo;).
RefName may contain further nested elements
from the parameter entity computerterms.gp, such as
Command or Function.
RefPurpose may contain any in-line elements.
</para>
<para>The examples of RefNameDiv cited above are tagged like this:
<literallayout role="sgmlexample">
&exm.refnmdv1;</>
<literallayout role="sgmlexample">
&exm.refnmdv2;</>
<literallayout role="sgmlexample">
&exm.refnmdv3;</>
</para>
</sect1>
<sect1 Id="DB.div.46"><title>RefSynopsisDiv</title>
<para>RefSynopsisDiv
is intended for the second division of reference
entries, usually titled Synopsis or Syntax. But there
are reference entries without Synopsis or Syntax divisions, so
RefSynopsisDiv
is an optional part of RefEntry. The content of
this division is often simply a
single line giving the syntax for the
subject of the reference entry, or something less
constrained, in some cases including
subheadings.
Thus the content of RefSynopsisDiv may be one or more
synopses
(Synopsis, CmdSynopsis, or FuncSynopsis,
containing a single line or a set of lines), or one
or more synopses
followed by any number of RefSect2s, or one or more RefSect2s.
</para>
<para>Here is a valid RefSynopsisDiv:
<literallayout role="sgmlexample">
&exm.refsyndv;
</>
</para>
</sect1>
<sect1 Id="DB.div.47"><title>Synopses</title>
<para>For explanations of the
CmdSynopsis and FuncSynopsis elements,
please see the alphabetical list of elements.
</para>
</sect1>
<sect1 Id="DB.div.48"><title>RefHeads</title>
<para>The rest of a reference entry consists of one or more divisions,
which are to be tagged as RefSect1s, which may have RefSect2s,
which may have RefSect3s.
These are just like Sect1--3,
with the same required and allowable contents.
</para>
</sect1>
</chapter>
<chapter Id="DB.div.49"><title>Miscellaneous</title>
<para>Some elements are not part of the
illustrations or body
of text in a printed work. Such elements
may appear in a printed work
but are not
part of the text. Others are provided in case they
should be needed for some aspect of on-screen display or book
production (TitleAbbrevs). Still others are
metainformation, such as comments.
</para>
<para>TitleAbbrev may be provided where a long
Title might be inappropriately truncated in some
on-line display such as a title bar, or for use in a printed
header
or footer.
</para>
<para>RevHistory, an element of DocInfo, records the authorship of
changes to
a book. It consists of one or more Revisions, each of which
must contain a RevNumber and a Date,
and may have one or more AuthorInitials and
a RevRemark.
</para>
<para>A Comment, containing in-line elements and plain text,
is something not meant to be displayed
or printed, such as a message to a production editor.
Beware! Comment is not an SGML comment, it is an
element. Just tagging text as a Comment will not ensure
that it is hidden; you must arrange that in your
application. And in line-specific elements you may find
that the line breaks in your comment are rendered by
your application.
</para>
</chapter>
<chapter Id="DB.div.50"><TITLE>The Elements Alphabetized</TITLE>
<PARA>Emphasized entries indicate
block-oriented elements.
</PARA>
<SECT1 Id="DB.div.51"><TITLE>Common Attributes</TITLE>
<PARA>Common attributes are ID, Lang (language), Remap
(to store the former GI of an element in a document filtered
to Docbook), Role (to type Docbook elements when
need be), and XRefLabel (text to be displayed as the
label of cross references to a block-oriented element).
</PARA>
<PARA>ID is an identifier, which must be a
string that is unique at least within the document and
which must begin with a letter. Lang should be a
language code drawn from ISO 639 (perhaps extended with
a country code drawn from ISO 3166, as en&lowbar;US). Use
it when you need to signal your application to change
hyphenation and other display characteristics.
Remap is a device for
preserving a previous tag name when fitting a document
to the DocBook DTD.
Think of <SGMLTAG>CHAPTER Remap=&ldquo;Fascicle&rdquo;</SGMLTAG>
as saying, &ldquo;I'm a Chapter now, but in a previous life
I was a Fascicle.&rdquo; Role allows you to clone DocBook
elements without creating new ones: if you have lists
of vegetables and lists of fruit (perhaps displayed
differently), give them appropriate Role attributes,
such as
<SGMLTAG>TERM Role=vegetables</SGMLTAG> and
<SGMLTAG>TERM Role=fruit</SGMLTAG>.
</PARA></SECT1>
<SECT1 Id="DB.div.52"><TITLE>Other Attributes</TITLE>
<PARA>Certain other attributes occur regularly. PageNum is
the number of the page on which a given element begins
or occurs in a printed book. Label holds some text
associated with its element that is to be output when
the document is rendered. XRefLabel holds some text
that is to be used when a cross reference (XRef)
is made to its element (XRefLabel may become an element of
its own in the future). Type is used with links,
as it is clear that different types of links may be
required; it duplicates the function of Role.
</PARA>
<PARA>Elements that bear the Class attribute, such as
Interface, have general
meanings that can be made more specific
by providing a value for Class from the delimited list
for that element. For example, for the Interface element
one may specify Menu, or Button; for the MediaLabel
element one may specify CDRom or Tape. Each element
has its own list of permissible values for Class, and
no default is set, so you can ignore this attribute
if you wish.
</PARA>
<PARA>Some attributes are defined with the keyword &percnt;yesorno;,
which resolves to NUMBER. The number
must be either 1 (yes) or 0 (no).
</PARA>
<PARA>An attribute that has the keyword IMPLIED bears no
processing expections if it is absent or its
value is null. Application designers might wish to
supply plausible defaults, but none is specified here.
However, it would be plausible to imply that the
language of a DocBook instance is U.S. English
unless specified otherwise.
</PARA></SECT1>
<SECT1 Id="DB.div.53"><TITLE>&ldquo;In-line&rdquo; vs. &ldquo;In flow&rdquo;</TITLE>
<PARA>In this document, &ldquo;in-line&rdquo; means &rdquo;occuring within a line
of text, like a character or character string, not causing
a line break.&rdquo; This term is sometimes used to
refer to objects such as an illustration around which
something like a paragraph is wrapped; here that circumstance
will be called &ldquo;in flow.&rdquo; There is no provision yet
for indicating that an object is in flow, but one could
make creative use of the Role attribute to do so.
</PARA>
<PARA>A related point: formal objects have titles; informal
objects do not. That an object is informal does not mean
that it is in-line: these are two different
characteristics.
</PARA></SECT1>
<SECT1 Id="DB.div.54"><TITLE>CALS Tables</TITLE>
<PARA>The Table model used here
is derived from MIL-M-28001B, dated
26 July 1993 (supersedes MIL-M-28001A of 20 July
1990.)
The documentation of Table and its subelements,
below, has been taken from that document,
with some editing and attempts at clarification.
</PARA></SECT1>
<SECT1 Id="DB.div.55">
<TITLE>List of Elements</TITLE>
<VARIABLELIST>
<VARLISTENTRY><TERM><EMPHASIS>Abstract</EMPHASIS></TERM>
<LISTITEM>
<PARA>A document summary.
Abstract contains an optional Title followed by
paragraphs, and
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Abbrev</TERM>
<LISTITEM>
<PARA>An abbreviation, especially one
followed by a period. It contains plain text and
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Ackno</TERM>
<LISTITEM>
<PARA>Acknowledgements in an Article.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Acronym</TERM>
<LISTITEM>
<PARA>A pronounceable contraction of
initials, usually printed in all caps or small caps.
It contains plain text and
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Action</TERM>
<LISTITEM>
<PARA>A function invoked in response to a user event. It may contain members of cptrphrase.gp,
and has common and MoreInfo attributes.
For the MoreInfo
attribute see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Address</TERM>
<LISTITEM>
<PARA>A real-world address. It contains
any number, in any order, of: Street, POB, Postcode,
City, State, Country, Phone, Fax, Email, and OtherAddr.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Affiliation</TERM>
<LISTITEM>
<PARA>Author's institutional affiliation.
It contains, in order, an optional ShortAffil, any number
of JobTitles, optional OrgName, any number of
Orgdivs, and any number of Addresses.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Anchor</TERM>
<LISTITEM>
<PARA>Marks a target for a Link.
Anchor may appear almost anywhere, and has no content.
Anchor has optional ID, Pagenum, Remap, Role, and XRefLabel attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Appendix</EMPHASIS></TERM>
<LISTITEM>
<PARA>May occur only after Chapters
or References, in a Book.
Appendix begins with an optional DocInfo, followed by
a required Title, optional TitleAbbrev, and anything
found in the body of a Chapter.
It has common and Label attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Application</TERM>
<LISTITEM>
<PARA>The name of a software program.
It may contain in-line elements and plain text,
and has common, Class, and MoreInfo attributes.
Class may be Hardware or Software (no default). MoreInfo
may have the value RefEntry, indicating that a
RefEntry exists containing additional information
about this term. The default value for MoreInfo is None.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Arg</TERM>
<LISTITEM>
<PARA>Argument in a CmdSynopsis. Arg may contain
any number of Args, Groups, Options, SynopFragmentRefs, Replaceables,
in any order, mixed with plain text. Arg is defined in
the DTD as having common attributes and the attributes
defined by the parameter entities argchcatt and repatt.
</PARA>
<PARA><EMPHASIS>argchcatt</EMPHASIS> or &ldquo;argument choice attribute&rdquo;
resolves to the attribute
Choice, with allowed values Opt (the Arg is
optional; the default), Req (it is required),
and Plain (neither optional nor required).
</PARA>
<PARA><EMPHASIS>repatt</EMPHASIS> or &ldquo;repetition attribute&rdquo;
resolves to the attribute Rep, with allowed
values Repeat (the Arg may be repeated; the default)
and Norepeat (the Arg does not repeat).
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>ArtHeader</EMPHASIS></TERM>
<LISTITEM>
<PARA>Metainformation for an Article.
ArtHeader has, in order, a required Title, optional
TitleAbbrev, optional Subtitle, one or more AuthorGroups,
optional BookBiblio, a required ArtPageNums,
any number of
Abstracts, any number of ConfGroups, and finally any number
ContractNums and ContractSponsors, in any order.
ArtHeader has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Article</EMPHASIS></TERM>
<LISTITEM>
<PARA>An article in a journal. Book may
be used to hold Articles. An Article has, in order,
a required ArtHeader, main contents as for Chapter,
then any number of Indexes, Glossaries, Bibliographies,
Appendixes and Acknos, in any order. Article has
common and ParentBook attributes, the latter pointing
to the ID of the enclosing Book.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ArtPageNums</TERM>
<LISTITEM>
<PARA>Page numbers of an Article
as published. It contains plain text
(<foreignphrase>e.g.</>, 23&ndash;147)
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Author</TERM>
<LISTITEM>
<PARA>Author of a document, occuring in
AuthorGroup. It consists of
one or more of the following, in any order:
Honorific, Firstname, Surname, Lineage, OtherName,
Affiliation, Contrib, and AuthorBlurb. It has common
attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>AuthorBlurb</EMPHASIS></TERM>
<LISTITEM>
<PARA>Short description of
author.
AuthorBlurb contains an optional Title followed by
paragraphs, and
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>AuthorGroup</TERM>
<LISTITEM>
<PARA>Wrapper for Author information.
It contains one or more CorpAuthors, Collabs,
Editors, OtherCredits, and
Authors, in any order. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>AuthorInitials</TERM>
<LISTITEM>
<PARA>Indicates the author of
a Revision or Comment. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>BeginPage</TERM>
<LISTITEM>
<PARA>BeginPage marks a page break in a print
version of a work that may be displayed online.
It is without content, but has
optional ID, PageNum, Remap, Role, and
XRefLabel attributes. The value of PageNum, which is
not required, should be
the folio (page number) of the page beginning at that
point. <EMPHASIS>Usage Note:</EMPHASIS> Once you give
a PageNum to a BeginPage, subsequent BeginPages should
be assumed to indicate that value incremented by one per
BeginPage. You can indicate a change or reset in page
numbering by providing a PageNum value for a later
BeginPage.</>
<para>BeginPage, like IndexTerm,
is handled as an SGML inclusion. If you parse a
DocBook instance that has as its doctype a structure
smaller than Sect1, your SGML parser will not pick
up the inclusion, and you will have to include a
modification of the doctype element in the document
type declaration, or redefine the element in your local
copy of the DTD.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>BiblioDiv</EMPHASIS></TERM>
<LISTITEM>
<PARA>A section of a
Bibliography. It may have, in order, an
optional Title, optional TitleAbbrev,
any number of block-oriented elements,
followed by one or more BiblioEntries.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>BiblioEntry</EMPHASIS></TERM>
<LISTITEM>
<PARA>An entry in a Bibliography.
It may begin and end with BiblioMiscs,
between which must be an ArtHeader, BookBiblio,
or SeriesInfo. That is, the main content of a
BiblioEntry may be identical to a section of
metainformation. BiblioEntry has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Bibliography</EMPHASIS></TERM>
<LISTITEM>
<PARA>A bibliography. It may be a
book component on its own, or may appear within a Preface, Chapter, or Appendix, or at
the end of a Glossary. It may have a DocInfo,
a Title and a TitleAbbrev, then optional
block-oriented elements, and then
one or more BiblioEntries or one or more BiblioDivs.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>BiblioMisc</TERM>
<LISTITEM>
<PARA>Untyped information required in a
BiblioEntry or BookInfo, in addition to the elements
required there. It contains plain text and
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>BlockQuote</EMPHASIS></TERM>
<LISTITEM>
<PARA>A quotation set off from the main text,
rather than occurring in-line. It may have a Title, followed
by block-oriented elements. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Book</EMPHASIS></TERM>
<LISTITEM>
<PARA>A collection of book components.
The Book content model is loose enough
to accomodate English, French, and Japanese books.
A Book may have
a Title and TitleAbbrev, followed in order by an optional
BookInfo, an optional ToC,
any number of LoTs, any number of Prefaces,
main contents, and back matter. The main contents are
required, and must be one or more Parts;
one or more Chapters followed by any
number of References;
one or more Articles; or one or more References.
All back matter is optional, but must appear in order:
any number of Appendices,
a Glossary, a Bibliography, and any number of Indexes
and SetIndexes,
followed by any number of LoTs followed by an optional
ToC. Book has common, FPI, and Label
attributes. The FPI attribute is intended to hold an
SGML Formal Public Identifier for the Book;
the Label attribute can be used to supply the
number of a Book, or you can use the content of the
VolumeNum element in BookInfo.
(In constructing Formal Public Identifiers you may wish to use
your ISBN publisher's prefix. In the ISBN
1-565692-043-0, for example, the publisher's
prefix is 1-565692.)
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>BookBiblio</EMPHASIS></TERM>
<LISTITEM>
<PARA>All the information about a book
that may be relevant
to a bibliographical citation; occurs in BookInfo and
may be used in BiblioEntry.
Only Title and AuthorGroup
are required. BookBiblio may contain, in order:
the required Title, optional TitleAbbrev,
Subtitle, and Edition, followed one or more required
AuthorGroups; then, optionally, either an ISBN followed
by an
optional VolumeNum or an ISSN followed by
optional VolumeNum, optional IssueNum, and an
optional PageNums. After these elements there may
occur, again optionally and in order,
InvPartNumber, ProductNumber, ProductName,
PubsNumber, and ReleaseInfo; then there may be any number
of Pubdates followed by any number of Publishers,
followed by optional
Copyright, then optional SeriesInfo; then any number of
Abstracts, any number of ConfGroups, any number
of ContractNums mixed with any number of ContractSponsors,
and an optional
PrintHistory followed by an optional RevHistory.
BookBiblio has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>BookInfo</EMPHASIS></TERM>
<LISTITEM>
<PARA>Metainformation for a Book,
in which it may appear. BookInfo must contain
a BookBiblio, followed by any number of LegalNotices,
followed by any number of ModeSpecs (which
are pointed to by the LinkMode attribute of OLink,
and are collected here for convenience).
BookInfo has common attributes
and a Contents attribute, the
values of which are the IDs of the ToC, LoTs,
Prefaces, Parts, Chapters, Appendixes, References,
Glossary, Bibliography, and indexes
comprising the Book, in the order of their appearance.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>BridgeHead</EMPHASIS></TERM>
<LISTITEM>
<PARA>A free-floating heading not
tied to the Sect hierarchy. It may contain
in-line elements and has common and Renderas
attributes. Use the Renderas attribute to indicate
the format in which the BridgeHead should appear (Sect1,
Sect2, Sect3, Sect4, Sect5, or Other; the default
is IMPLIED).
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Caution</EMPHASIS></TERM>
<LISTITEM>
<PARA>An admonition set off from the text;
Tip, Warning, Important, and Note all share its model.
Its contents may include paragraphs, lists, and so forth,
but not another admonition.
Caution and its sisters have common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Chapter</EMPHASIS></TERM>
<LISTITEM>
<PARA>A part of a Book.
Chapter contain anything except
higher-level elements
such as Part, Book, and Set, or peers such as
Appendix and Preface. A Chapter
may begin with a DocInfo, followed by
a required Title, optional TitleAbbrev, and body.
The body may be
either paragraphs and block-oriented elements or Sects containing
them. At the beginning and end of the body of
a Chapter, or the beginning and end of any Sect,
there may be any number of ToCs, LoTs, Indexes, Glossaries,
and Bibliographies, not that such an organization is
recommended for ordinary use.
Chapter has common and Label attributes; the Label
attribute is for holding a numeric designation
(3 for Chapter 3, for example).
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Citation</TERM>
<LISTITEM>
<PARA>Any in-line bibliographic
reference to another published work that uses a reference
string, such as an abbreviation in a Bibliography.
Compare CiteTitle.
Citation contains plain text and
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>CiteTitle</TERM>
<LISTITEM>
<PARA>A citation for some published
work. Compare Citation.
It may contain in-line elements and plain text,
and has common and Pubwork attributes.
The value of Pubwork should indicate the type
of work cited; it may be Article, Book, Chapter,
Part, RefEntry, or Section (no default).
CiteTitle is not a link or a cross reference,
only a citation.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>CiteRefEntry</TERM>
<LISTITEM>
<PARA>A citation of a reference
entry. It must have a RefEntryTitle, followed
by an optional ManVolNum. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>City</TERM>
<LISTITEM>
<PARA>Part of Address. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Classname</TERM>
<LISTITEM>
<PARA>The name of the class to which a
program component belongs.
It contains plain text and
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>CmdSynopsis</TERM>
<LISTITEM>
<PARA>Synopsis for a Command. A
CmdSynopsis contains any number of
Args and Groups, in any order, followed by a
single required
Command, another set of any number of Args and
Groups, in any order, and ending with any number of
optional SynopFragments. CmdSynopsis has common,
Label, and Sepchar attributes. Label has no
default; Sepchar has the default &ldquo; &rdquo;.
The following is courtesy Eve Maler (see also
the entries for the subelements elsewhere in
this list:
</PARA>
<PARA>An argument at the command level (Arg)
is a parameter passed to a
command to specify or modify the command's behavior; it
often consists of a variable value
(Replaceable)
such as a filename field, or an option
(Option) and its own nested
argument (Arg). If the contents of an
argument are not marked up further, they are assumed to be
something the user must type as shown (probably an option,
but this is implicit). The Choice attribute on the two
argument elements indicates whether the argument must be
present (&ldquo;Req&rdquo;, the default), whether it
is optional (&ldquo;Opt&rdquo;), or whether no indication of presence
is given (&ldquo;Plain&rdquo;, the default).
</PARA>
<PARA>A group (Group) as a peer
or child of an argument is a
collection of arguments, options, or other constructs that must appear in some
relation to each other. For example, three options that are
exclusive of each other and are optional would be in a group
with a choice of &ldquo;Opt&rdquo; (the default).
The &ldquo;Optmult&rdquo; choice allows zero or more of the
children of the group to be supplied, and the &ldquo;Reqmult&rdquo;
choice requires one or more of the children of the group to
be supplied.
</PARA>
<PARA>An option (Option) is a literal string or name of a
parameter-keyword controlling the behavior of the command; a
variable value (Replaceable) is a
mnemonic name for a value that the user must supply, such as
an input file name. The Option and Replaceable
elements are available in text as
well as in synopses. Stacks of options (for example,
&ldquo;-aefstuv&rdquo;) should
be put into a single Option element for simplicity.
</PARA>
<PARA>Depressingly complex constructs may
appear anywhere within a
synopsis. A SynopFragment reference (SynopFragmentRef) is a
special kind of variable value assigned in place of this
construct, which is
then broken out into its own synopsis subset (SynopFragment) for
clarity. A SynopFragment must have an ID, and any
SynopFragmentRefs supplied
must point to some SynopFragment.
</PARA>
<PARA>Plain text within a CmdSynopsis
is allowed only inside Cmd, Arg,
Option, Replaceable, and SynopFragmentRef. The
top-level separator character attribute
value (&ldquo; &rdquo; by default) should
be used to separate arguments and groups
from their repeat indicators (&ldquo;...&rdquo;) and
to separate Commands and their arguments and groups at the top level.
</PARA>
<PARA>The CmdSynopsis structure does
not meet the needs of DCL
and other VMS-related command languages that have command
parameters such
as /[NO]WRITE, positional versus nonpositional parameters, and so on.
Probably additional low-level elements would have to be
added to the mix and the top-level structure enhanced
slightly to account for
these. However, CmdSynopsis
appears to meet most UNIX-related needs.
</PARA>
<PARA><EMPHASIS>Processing expectations:</EMPHASIS>
The &ldquo;Opt&rdquo; settings on arguments and groups (and probably
&ldquo;Optmult&rdquo; as
well for now) should produce square brackets.
The &ldquo;Req&rdquo;
settings (and probably &ldquo;Reqmult&rdquo; as well for now)
should produce curly braces. The children of Group (if
there is more than one child) should be either separated by vertical bars or formatted as a stacked list.
Spacing at the Command and Group levels
is controlled by formatter defaults and/or the
sepchar setting.
</PARA>
<SCREEN>
Example command synopsis in typical UNIX(tm) format:
rm [-f] [-r] [-i] [-] {filename|dirname}...
| | | | | | | | |
| optional args | | | repeat indicator
| (contain options)| | |
| | | second child of group
command name | |
| first child of group
|
required repeatable group
SGML source for this example:
<SGMLTAG>CMDSYNOPSIS</SGMLTAG>
<SGMLTAG>COMMAND</SGMLTAG>rm<SGMLTAG>/COMMAND</SGMLTAG>
<SGMLTAG>ARG Choice="opt"</SGMLTAG>-f<SGMLTAG>/ARG</SGMLTAG> (<SGMLTAG>OPTION</SGMLTAG> not required for arg contents
<SGMLTAG>ARG Choice="opt"</SGMLTAG>-r<SGMLTAG>/ARG</SGMLTAG> unless doing extra-special processing)
<SGMLTAG>ARG Choice="opt"</SGMLTAG>-i<SGMLTAG>/ARG</SGMLTAG>
<SGMLTAG>ARG Choice="opt"</SGMLTAG>-<SGMLTAG>/ARG</SGMLTAG> (various synopsis formats
<SGMLTAG>GROUP Choice="req" Rep="repeat"</SGMLTAG> can be generated)
<SGMLTAG>REPLACEABLE</SGMLTAG>filename<SGMLTAG>/REPLACEABLE</SGMLTAG>
<SGMLTAG>REPLACEABLE</SGMLTAG>dirname<SGMLTAG>/REPLACEABLE</SGMLTAG>
<SGMLTAG>/GROUP</SGMLTAG>
<SGMLTAG>/CMDSYNOPSIS</SGMLTAG>
</SCREEN>
</LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Collab</TERM>
<LISTITEM>
<PARA>A collaborative group
of authors. It contains a required CollabName
followed by any number of Affiliations,
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>CollabName</TERM>
<LISTITEM>
<PARA>Name of a collaborative group
of authors. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ColSpec</TERM>
<LISTITEM>
<PARA>Column specifier,
that is, formatting information for a
column in a Table, part of TGroup, THead, or TGroup.
ColSpec is an empty element, bearing common
and Align, Char, Charoff,
Colname, Colnum, Colsep, Colwidth, and Rowsep
attributes. The default values come from the TGroup,
THead, or TFoot that starts the current enclosing group.
Each ColSpec is for a single column, so it properly has a
column number, Colnum, implicitly in order starting
from 1, and an optional Colname by which it is known when
used in any SpanSpec or in Entry.
A ColSpec set on THead or TFoot should be complete for
all columns. It overrides those on the containing TGroup
and applies to just the THead or
TFoot. If there is no ColSpec used within THead or
TFoot, then the ColSpec of the containing TGroup (or the
prior TGroup) is used. ColSpecs from the containing
TGroup apply to TBody.
</PARA>
<PARA>For <EMPHASIS>TGroupStyle</EMPHASIS>, see <EMPHASIS>TGroup.</EMPHASIS>
</PARA>
<PARA><EMPHASIS>Align</EMPHASIS> controls the horizontal position
of text within the column.
The value of Align may be Left (quad flush left),
Center (centered), Right (quad flush right),
Justify (both quad left and right), or Char (align to
the left of Char, positioned by Charoff). There is
no default.
</PARA>
<PARA><EMPHASIS>Char</EMPHASIS> contributes to Align. If the
value of Align is &ldquo;char&rdquo;, the value of Char
should be a character on the first occurrance
of which the entry is to be aligned. If that
character does not occur in the entry, the entry
is aligned to the left of the position determined
by Charoff. (Think of using the decimal point to
align decimal numbers: Char=&ldquo;. &rdquo;and
Charoff says how far over in the column the decimals
should be; if no decimal occurs, the number is an
integer and is aligned to the left of the decimals.)
No value implies there
is no character to align on.
The default is implied, from the enclosing TGroup.
(That is, you normally declare that an entire TGroup
shall be decimal-aligned, but if you need to align
a specific column differently, you can do it by
specifying another Char at the ColSpec level.)
</PARA>
<PARA><EMPHASIS>Charoff</EMPHASIS> contributes with Char to Align.
Charoff is the proportion
of the current column width, expressed in percentage,
to be allowed before the left edge of the first occurrence
of the character given as the value of Char.
The default is inherited from the enclosing TGroup.
That is, if columns in a TGroup are to be decimal-aligned,
and the decimal point is to fall three-quarters of the
way across each cell (most of your numbers are of the
form 123.4), you could set Charoff to 75 in
TGroup; that value would be inherited by ColSpec, where
you could modify it for a specific column (for
example, by setting it to
50 for a column of numbers of the form 12.34).
</PARA>
<PARA><EMPHASIS>Colname</EMPHASIS> gives the name of the column, which
is used
to specify the position in a row, or the start or end of a
horizontal span of columns (SpanSpec). There is no default.
</PARA>
<PARA><EMPHASIS>Colnum</EMPHASIS> gives the number of the column,
counting from 1 at left of the table.
There is no default.
</PARA>
<PARA><EMPHASIS>Colsep</EMPHASIS>
determines column separators. If its value
is 1 (yes), display the internal column rulings to
the right of each item; if 0 (no), do not
display it. It is ignored for the last column, where the
Frame setting applies. There is no default. The
value is inherited from TGroupStyle if used.
</PARA>
<PARA><EMPHASIS>Colwidth</EMPHASIS> is either a proportional
measure of the form <EMPHASIS>number*</EMPHASIS>, such as &ldquo;5*&rdquo; for
5 times the proportion, or &ldquo;*&rdquo; (=&ldquo;1*&rdquo;); or a
fixed measure, such as 2pt for 2
points, 3pc for 3 picas; or a mixed measure, such as 2*+3pt.
Coefficients are positive numbers with up to
two decimal places. There is no default.
If no value is given, the value should
be obtained from the FOSI, or, if there is no FOSI value,
the value 1 should be used. (Perhaps this means that
you can vary the width of columns by stating their relative
proportions, or you can give fixed widths. If you use
a decimal number less than one, express it in the form
0.2, not .2.)
</PARA>
<PARA><EMPHASIS>Rowsep</EMPHASIS>
determines row separators. If its content is
1 (yes), display the internal vertical row ruling
below each item; if 0 (no), do not display it. It is
ignored for the last row of the table, where
the value of Frame applies to the entire Table.
There is no default.
The value is inherited from TGroupStyle, if used.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Command</TERM>
<LISTITEM>
<PARA>An executable program, or
the entry a user makes to execute a command.
It may contain members of cptrphrase.gp,
and has common and MoreInfo attributes.
For the MoreInfo
attribute see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Comment</EMPHASIS></TERM>
<LISTITEM>
<PARA>A remark made within the document file that
is intended for use during interim stages of production.
A Comment should not be displayed to the reader of the
finished, published work. It may appear almost anywhere,
and may contain almost anything
below the Section level. Note that,
unlike an SGML comment, unless you take steps
to suppress it, the Comment element
will be output by an SGML parser
or application. You may wish to do this to display Comments
along with text during the editorial process.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ComputerOutput</TERM>
<LISTITEM>
<PARA>Data presented to the user by
a computer.
It may contain elements from cptrphrase.gp,
and has common and
MoreInfo attributes For the MoreInfo attribute
see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ConfDates</TERM>
<LISTITEM>
<PARA>Dates of a conference in connection
with which a document was written. It contains plain text
(<foreignphrase>e.g.</>, 21&ndash;24 May 1927)
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ConfGroup</TERM>
<LISTITEM>
<PARA>A wrapper for information about
a conference. It contains any number of ConfDates,
ConfTitles, ConfNums, Addresses, and ConfSponsors,
in any order, and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ConfNum</TERM>
<LISTITEM>
<PARA>The number of a conference. It
contains plain text, and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ConfSponsor</TERM>
<LISTITEM>
<PARA>Sponsor of a conference in connection
with which a document was written. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ConfTitle</TERM>
<LISTITEM>
<PARA>Title of a conference in connection
with which a document was written. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ContractNum</TERM>
<LISTITEM>
<PARA>Number of a contract under which
a document was written. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ContractSponsor</TERM>
<LISTITEM>
<PARA>Sponsor of a contract under which
a document was written. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Contrib</TERM>
<LISTITEM>
<PARA>Holds information about the contributions
of an Author, Editor, or OtherCredit to the work
in question; it may occur within those elements
and contains plain text. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Copyright</EMPHASIS></TERM>
<LISTITEM>
<PARA>Copyright information about
a document. It consists of one or
more Years followed by any number of Holders.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>CorpAuthor</TERM>
<LISTITEM>
<PARA>Corporate author of a book, for use
in BookInfo or BiblioEntry. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>CorpName</TERM>
<LISTITEM>
<PARA>Name of a corporation. It contains
plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Country</TERM>
<LISTITEM>
<PARA>Part of Address. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Data</TERM>
<LISTITEM>
<PARA>Optional component of FuncParam and
ParamDef. It wraps plain text, Replaceable, more Data,
Emphasis, and may contain links and indexing information.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Date</TERM>
<LISTITEM>
<PARA>Date of publication or revision.
It contains plain text. (No provision
has been made for representing eras; you could include this
information along with the date data.)
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Database</TERM>
<LISTITEM>
<PARA>An organized set of data.
It may contain members of cptrphrase.gp,
and has common, Class, and MoreInfo attributes.
Class may have the value
Name, Table, Field, Key1, Key2, or Record
(no default). For the MoreInfo
attribute see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>DocInfo</EMPHASIS></TERM>
<LISTITEM>
<PARA>Metainformation for a book
component, in which it may appear. Only Title and AuthorGroup
are required. DocInfo may contain, in order:
the required Title, optional TitleAbbrev and
Subtitle, followed by one or more
AuthorGroups, any number of
Abstracts, an optional RevHistory, and any number of
LegalNotices.
DocInfo has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Edition</TERM>
<LISTITEM>
<PARA>The edition of a document. It contains
plain text. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Editor</TERM>
<LISTITEM>
<PARA>The editor of a document.
Contents are the same as for <EMPHASIS>Author.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Email</TERM>
<LISTITEM>
<PARA>Part of Address. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Emphasis</TERM>
<LISTITEM>
<PARA>Provided for use where you would
traditionally use italics
or bold type to emphasize a word or phrase.
It contains plain text and
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Entry</EMPHASIS></TERM>
<LISTITEM>
<PARA>A euphemism for a cell in a table&mdash;you'd
rather be in an Entry than in a Cell, wouldn't you?
An Entry occurs in
a Row, and must have either some assortment
of paragraphs, block-oriented elements,
and Graphics, or in-line elements.
Entry has common
and Align, Char, Charoff, Colname, Colsep,
Morerows, Nameend, Namest,
Rotate, Rowsep, Spanname, and VAlign attributes.
Attribute values may be inherited
from enclosing elements that share the same
attribute.
&ldquo;An Entry not specified by a SpanSpec gets its
defaults from its starting column.&rdquo;
</PARA>
<PARA><EMPHASIS>Align</EMPHASIS> controls the horizontal position
of text within the column.
The value of Align may be Left (quad flush left),
Center (centered), Right (quad flush right),
Justify (both quad left and right), or Char (align on
leftmost of Char, positioned by Charoff). There is
no default; the value may be inherited from
ColSpec or SpanSpec.
</PARA>
<PARA><EMPHASIS>Char</EMPHASIS> contributes to Align. If the
value of Align is &ldquo;char&rdquo;, the value of Char
should be a character on the first occurrance
of which the entry is to be aligned. If that
character does not occur in the entry, the entry
is aligned to the left (the original doc incorrectly
specifies &ldquo;right&rdquo;)
of the position determined
by Charoff.
The default is inherited; no value implies there
is no character to align on.
</PARA>
<PARA><EMPHASIS>Charoff</EMPHASIS> contributes with Char to Align.
Charoff is the proportion
of the current column width, expressed in percentage,
to be allowed before the left edge of the first occurrence
of the character given as the value of Char, if any.
The default is inherited from ColSpec or SpanSpec.
</PARA>
<PARA><EMPHASIS>Colname</EMPHASIS> gives the name of the column,
which is used
to specify the position in a row, or the start or end of a
horizontal span of columns (SpanSpec). There is no default;
omit if SpanName is present. The implied value is either
the first column of the Row, or, if already in a Row,
the next column after the end of the prior Entry or
EntryTbl.
</PARA>
<PARA><EMPHASIS>Colsep</EMPHASIS> determines column separators.
If its value
is 1 (yes), display the internal column rulings to
the right of each Entry; if 0 (no), do not
display it. It is ignored for the last column, where the
Frame setting applies. (In CALS,
Yes is expressed as 1 and No as 0.)
There is no default; if no value is given the
value is inherited from ColSpec or SpanSpec.
</PARA>
<PARA><EMPHASIS>Morerows</EMPHASIS> is the number of
additional rows in a
vertical straddle. The default is 0.
</PARA>
<PARA><EMPHASIS>Nameend</EMPHASIS> is the name of the rightmost
column of a span. Names are identified in the
ColSpec of the current TGroup. There is no default.
</PARA>
<PARA><EMPHASIS>Namest</EMPHASIS> or Name Start,
is the name of the leftmost column
of a span. Names are identified in the
ColSpec of the current TGroup.
</PARA>
<PARA><EMPHASIS>Rotate</EMPHASIS>
governs rotations, which are not additive to
those specified in the FOSI.
Values may be 1 (yes) or 0 (no).
0 (no) specifies no rotation; 1 (yes) specifies
90 degrees rotation counterclockwise
to table orientation. No other values are
supported!
</PARA>
<PARA><EMPHASIS>Rowsep</EMPHASIS>
determines row separators. If its content is
1 (yes), display the internal vertical row ruling
below each item; if 0 (no), do not display it. It is
ignored for the last row of the table, where
the frame value applies. There is no default.
The value is inherited from Row, if used there.
</PARA>
<PARA><EMPHASIS>Spanname</EMPHASIS> is the name of a horizontal span.
No default.
</PARA>
<PARA><EMPHASIS>VAlign</EMPHASIS> governs the vertical
positioning of text within an Entry.
Allowed values are Top, Middle, and Bottom
(no default).
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>EntryTbl</EMPHASIS></TERM>
<LISTITEM>
<PARA>A form of subtable. It
may occur in Row, along with Entry.
Several EntryTbls of differing formats
may occur in the same Row of a
TBody, but EntryTbl may not contain itself. Aside
from that restriction, EntryTbl contains one or
more sets of these elements, in order:
any number of ColSpecs, any number of SpanSpecs,
an optional THead, and a required TBody.
There is no implication
of alignment of subrows in different EntryTbls.
Default attribute values come instead from those
of like-named attributes on enclosing
elements: Table, TGroup,
ColSpec, SpanSpec, THead, TFoot, TBody, or
Row. EntryTbl has common, Align,
Char, Charoff, ColName, Cols, Colsep, Nameend, Namest,
Rowsep, Spanname, and TGroupStyle attributes.
</PARA>
<PARA><EMPHASIS>Align</EMPHASIS> controls the horizontal position
of text within the column.
The value of Align may be Left (quad flush left),
Center (centered), Right (quad flush right),
Justify (both quad left and right), or Char (align to
the
left of Char, positioned by Charoff). There is
no default; the value may be inherited from ColSpec
or SpanSpec.
</PARA>
<PARA><EMPHASIS>Char</EMPHASIS> contributes to Align. If the
value of Align is &ldquo;char&rdquo;, the value of Char
should be a character on the first occurrance
of which the entry is to be aligned. If that
character does not occur in the entry, the entry
is aligned to the left (the original doc incorrectly
specifies &ldquo;right&rdquo;) of the position determined
by Charoff. There is no default.
</PARA>
<PARA><EMPHASIS>Charoff</EMPHASIS> contributes with Char to Align.
Charoff is the proportion
of the current column width, expressed in percentage,
to be allowed before the left edge of the first occurrence
of the character given as the value of Char, if any.
The default is inherited from the enclosing TGroup.
</PARA>
<PARA><EMPHASIS>Colname</EMPHASIS> gives the name of the
leftmost column of EntryTbl. There is no default.
</PARA>
<PARA><EMPHASIS>Cols</EMPHASIS> is the number of columns in the
EntryTbl. There is no default.
</PARA>
<PARA><EMPHASIS>Colsep</EMPHASIS>
determines column separators. If its value
is 1 (yes), display the internal column rulings to
the right of the EntryTbl,
except if the EntryTbl falls in the the last column, where the siderule (<EMPHASIS>sic</EMPHASIS>)
setting applies; if 0 (no), do not display it.
There is no default. The
value is inherited from the enclosing TGroup.
</PARA>
<PARA><EMPHASIS>Nameend</EMPHASIS> is the name of the rightmost
column of a span. Names are identified in the
ColSpec of the current TGroup. There is no default.
</PARA>
<PARA><EMPHASIS>Namest</EMPHASIS> or Name Start,
is the name of the leftmost column
of a span. Names are identified in the
ColSpec of the current TGroup. There is no default.
</PARA>
<PARA><EMPHASIS>Rowsep</EMPHASIS>
determines row separators. If its content is
1 (yes), display the internal vertical row ruling
below the EntryTbl; if 0 (no), do not display it. It is
ignored for the last row of the table, where
the frame value applies. There is no default.
The value is inherited from the enclosing
TGroup.
</PARA>
<PARA><EMPHASIS>Spanname</EMPHASIS> is the name of a horizontal span.
</PARA>
<PARA><EMPHASIS>TGroupStyle</EMPHASIS> is the name of
a table group style
defined in the FOSI. There is no default.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Epigraph</EMPHASIS></TERM>
<LISTITEM>
<PARA>A brief section of poetry or prose
at the start of a chapter. It contains paragraphs and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Equation</EMPHASIS></TERM>
<LISTITEM>
<PARA>A titled mathematical equation displayed
on a line by itself, rather than in-line. It has an optional
Title and TitleAbbrev, followed by either
an InformalEquation or a Graphic (see <EMPHASIS>Graphic</EMPHASIS>).
Equation has common and Label attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ErrorName</TERM>
<LISTITEM>
<PARA>An error message reported by a computer.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ErrorType</TERM>
<LISTITEM>
<PARA>A classification of an error message
reported by a computer.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Example</EMPHASIS></TERM>
<LISTITEM>
<PARA>Intended for sections of program source code
that are provided as examples in the text.
It contains a required Title and an
optional TitleAbbrev, followed by one or more block-oriented
elements in any combination. It has common and Label
attributes. A simple Example might contain a Title
and a ProgramListing.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Fax</TERM>
<LISTITEM>
<PARA>Part of Address. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Figure</EMPHASIS></TERM>
<LISTITEM>
<PARA>An illustration.
It must have a Title, and may have a
TitleAbbrev, followed by one or more of
BlockQuote,
InformalEquation, Graphic,
InformalTable, Link, LiteralLayout,
OLink, ProgramListing, Screen, Synopsis, and ULink,
in any order. Figure has common,
Label, and Float attributes; Float indicates
whether the Figure is supposed to be rendered
where convenient (yes) or at
the place it occurs in the text (no, the default). To
reference an external file containing graphical
content use the Graphic element within Figure.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Filename</TERM>
<LISTITEM>
<PARA>The
name of a file, including pathname if this
information is present. It may contain members of cptrphrase.gp,
and has common and MoreInfo attributes.
For the MoreInfo
attribute see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>FirstName</TERM>
<LISTITEM>
<PARA>(Western-style) given name
of Author,
Editor, or OtherCredit. It contains
plain text. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>FirstTerm</TERM>
<LISTITEM>
<PARA>First occurrence
of a word in a given context.
It contains plain text and
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Footnote</EMPHASIS></TERM>
<LISTITEM>
<PARA>The contents of a footnote.
The point in the text where the mark for a specific
footnote goes is indicated either by FootnoteRef
or by the actual placement of the Footnote itself
(in which case FootnoteRef may be omitted).
Footnote may contain Para, SimPara, BlockQuote, InformalEquation, InformalTable,
Graphic, Synopsis, LiteralLayout, ProgramListing,
Screen, and any kind of list.
It has optional ID, Label, Lang, Remap, Role, and XRefLabel
attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>FootnoteRef</TERM>
<LISTITEM>
<PARA>Identifies the location for a footnote mark.
It may contain plain text, which is the mark to be displayed, or it may be empty, in which case
you can use the Mark
attribute to indicate the contents of the mark (such as
an asterisk, *, a number, 84, or a dingbat specified by
a name that is to be interpreted by the application).
FootnoteRef has ID, Linkend, and Mark
attributes. The Linkend attribute,
which is required, has as its value the ID of
the associated Footnote. See <emphasis>Footnote.</>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ForeignPhrase</TERM>
<LISTITEM>
<PARA>Any word or words
from a language other than
that of the document which you want to mark off
in some way. In English, <EMPHASIS>inter alia</EMPHASIS> and
<EMPHASIS>c'est la vie</EMPHASIS> are ForeignPhrases.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>FormalPara</EMPHASIS></TERM>
<LISTITEM>
<PARA>A paragraph with a Title.
FormalPara contains a required Title followed
by a required Para, and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>FuncDef</TERM>
<LISTITEM>
<PARA>Part of a FuncSynopsis.
Like Paramdef, it provides
data type information and the name of the
Function (or Parameter, in the case of ParamDef)
this information applies
to. A FuncDef may contain any combination of
plain text, Replaceable, Data, or Function, in any order.
It has common attributes.
</PARA>
<PARA>Separating this information from the rest of
the synopsis avoids messing with data type
information that appears before <EMPHASIS>or after</EMPHASIS>
the item it applies to, such as array
information (&ldquo;[]&rdquo;). It also avoids the issue of
placing the pointer (&ldquo;*&rdquo;) indicator (next to the rest of
the left-hand data type or next to the Parameter or Function
name?). Any spaces that surround the
Parameter or Function must be inserted by the writer.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>FuncParams</TERM>
<LISTITEM>
<PARA>Optional component of ParamDef.
It supplies &ldquo;inner parameters&rdquo; for Paramters that
are pointers to Functions. FuncParams
contains elements from ctprphrase.gp and has
common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>FuncSynopsis</TERM>
<LISTITEM>
<PARA>(contributed Eve Maler, along
with remarks on its subelements.)
A C synopsis that shows a prototype or
definition indicating a function's name. A FuncSynopsis
also indicates the data type of its return value, and
the positions, purposes, and data types of its
parameters. A FuncSynopsis begins with an
optional FuncSynopsisInfo, which contains additional
information about the synopsis that follows; line breaks
and leading white space are significant within a
FuncSynopsisInfo. This is followed by
one or more blocks defining a function (you might
use more than one for connecting related sets of functions).
Each of these blocks consists of a required FuncDef,
followed by a Void, a VarArgs, or one or more ParamDefs.
Void, Varargs, and and ParamDef
are mutually exclusive. <EMPHASIS>Usage Note:</EMPHASIS>
You should supply no specific information on the arguments before the ellipsis that VarArgs should output when
rendered, but if it is necessary
to represent the ellipsis in the source it may
ben enclosed within a final ParamDef.
FuncSynopsis has common and Label attributes.
</PARA>
<PARA>The processing application is expected to
provide all parentheses, semicolons, and the like. The
exceptions are any spaces surrounding function and parameter
names, any parentheses or commas or spacing
inside lists of data types of parameters that are pointers
to functions, and the parentheses around those parameter
names themselves. These exceptions are a bit confusing in
the unusual case (pointers to functions), but they
<EMPHASIS>greatly</EMPHASIS> simplify tagging and still
allow either K&amp;R style or ANSI C style to be produced
(assuming writers have cooperated in supplying enough
information for ANSI).
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>FuncSynopsisInfo</TERM>
<LISTITEM>
<PARA>Information supplementing
the FuncDefs of a FuncSynopsis. It contains elements
of ctprphrase.gp, and within it line breaks
and leading white space are significant.
See <EMPHASIS>FuncSynopsis.</EMPHASIS> It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Function</TERM>
<LISTITEM>
<PARA>A subroutine in a program or external
library. It may contain members of cptrphrase.gp,
and has common and MoreInfo attributes.
For the MoreInfo
attribute see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Glossary</EMPHASIS></TERM>
<LISTITEM>
<PARA>A glossary of terms. Glossary
may occur within a Chapter, Appendix, or Preface,
or may be a book component in its own right.
It contains in order an optional DocInfo, optional
Title, and optional TitleAbbrev, followed by
any number of
block-oriented elements, followed by
one or more GlossEntries or one or more GlossDivs,
and ending with an optional Bibliography.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>GlossDef</EMPHASIS></TERM>
<LISTITEM>
<PARA>The definition attached to a GlossTerm
in a GlossEntry. It may
contain Comments, GlossSeeAlsos,
paragraphs, and other block-oriented
elements, in
any order; it has common and Subject attributes. The Subject attribute may hold a list of subject areas
(<foreignphrase>e.g.</>, DCE RPC
General) as keywords.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>GlossDiv</EMPHASIS></TERM>
<LISTITEM>
<PARA>A division of a Glossary.
It may have a Title and TitleAbbrev, followed by
block-oriented elements, followed by
one or more GlossEntries. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>GlossEntry</EMPHASIS></TERM>
<LISTITEM>
<PARA>An entry in a Glossary.
It contains, in order, a required
GlossTerm, an optional Acronym,
an optional Abbrev, and any number of
GlossSees and GlossDefs, in any order.
It has common and Sortas attributes, the latter
to hold the string by which the GlossTerm is to
be sorted (alphabetized) in lieu of its proper
content.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>GlossList</TERM>
<LISTITEM>
<PARA>GlossList is a wrapper for a set of GlossEntries.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>GlossSee</TERM>
<LISTITEM>
<PARA>A cross-reference from one
GlossEntry to another. It may contain plain
text and inline elements,
or no content, and has common and OtherTerm
attributes. OtherTerm is a reference to the
GlossTerm within the cross-referenced GlossEntry; that
GlossTerm should be displayed at the point of the GlossSee.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>GlossSeeAlso</TERM>
<LISTITEM>
<PARA>A cross-reference from one
GlossDef to another GlossEntry. It may contain plain
text and in-line elements,
or no content, and has common and OtherTerm
attributes. OtherTerm is a reference to the
GlossTerm within the cross-referenced GlossEntry; that
GlossTerm should be displayed at the point of the GlossSee.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>GlossTerm</TERM>
<LISTITEM>
<PARA>A term in the
text of a Chapter (for example) that is glossed in a Glossary; also used for those terms in GlossEntries, in the
Glossary itself. As you may not want to tag all occurrences
of these words outside of Glossaries, you might consider
GlossTerm, when used outside of Glossaries, to be similar
to FirstTerm, except that GlossTerm may contain other
in-line elements. GlossTerm contains in-line elements
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Graphic</TERM>
<LISTITEM>
<PARA>Encloses graphical data or
points via an attribute to an external file containing such data,
and is to be rendered as an object, not in-line.
It has Format,
Fileref, Entityref, SrcCredit, and ID attributes.
The format attribute may have the value of
any of the formats defined at the head of the DTD:
CGM-BINARY,
CGM-CHAR, CGM-CLEAR, DITROFF, DVI, EPS,
EQN, FAX, GIF, IGES, PIC, PS, TBL, TEX,
TIFF.
</PARA>
<PARA>The value of
Fileref should be a filename, qualified by a pathname
if desired; the value of Entityref should be that of an
external data entity. If data is given as the
content of Graphic, both Entityref and Fileref,
if present at all, should
be ignored, but a Format value should be supplied.
if no data is given as the content of
Graphic and a value for Entityref
is given, Fileref, if present, should be ignored
but no Format value should be supplied.
Finally, if there is no content for Graphic and
Entityref is absent or null, Fileref must be
given the appropriate value, and again no
Format value should be supplied.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Group</TERM>
<LISTITEM>
<PARA>A group of constituent parts of a
CmdSynopsis. A Group consists of one or more Args, Groups,
SynopFragmentrefs,
and Replaceables, in any order. See <EMPHASIS>CmdSynopsis.</EMPHASIS>
Group has common, grpchcatt, and repatt attributes.
</PARA>
<PARA><EMPHASIS>argchcatt</EMPHASIS> or &ldquo;argument choice attribute&rdquo;
resolves to the attribute
Choice, with allowed values Opt (the Arg is
optional; the default), Req (it is required), and Plain (neither
optional nor required).
</PARA>
<PARA><EMPHASIS>repatt</EMPHASIS> or &ldquo;repetition attribute&rdquo;
resolves to the attribute Rep, with allowed
values Norepeat (the Arg may be repeated; the default)
and Repeat (the Arg does not repeat).
</PARA>
<PARA><EMPHASIS>grpchcatt</EMPHASIS> or &ldquo;group choice attribute&rdquo;
is a parameter entity that
resolves to the the Choice attribute for the element Group.
The allowed values are Opt (the Arg is
optional; the
default), Req (it is required), Plain (neither
optional nor required), OptMult (optional and
repeatable), and ReqMult (required
multiple times).
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Hardware</TERM>
<LISTITEM>
<PARA>A physical part of a computer system.
It may contain members of cptrphrase.gp,
and has common and MoreInfo attributes.
For the MoreInfo
attribute see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Highlights</EMPHASIS></TERM>
<LISTITEM>
<PARA>A list of main points discussed
in a book component such as a Chapter. It may contain
paragraphs,
lists, and admonitions, and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Holder</TERM>
<LISTITEM>
<PARA>Part of Copyright; the
holder of the copyright of the document. It contains
plain text. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Honorific</TERM>
<LISTITEM>
<PARA>A person's title, to be used as part of
Author, Editor, or OtherCredit. It contains
plain text. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Important</EMPHASIS></TERM>
<LISTITEM>
<PARA>An admonition set off from the text.
See <EMPHASIS>Caution.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Index</EMPHASIS></TERM>
<LISTITEM>
<PARA>An index to a Chapter,
Appendix, Preface, or Book.
It contains an optional DocInfo, Title, and TitleAbbrev,
followed by
any number of block-oriented elements,
and then one or more IndexEntries or one or more IndexDivs.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>IndexDiv</EMPHASIS></TERM>
<LISTITEM>
<PARA>A division of an Index.
It may have a Title and TitleAbbrev,
some optional introductory matter (block-oriented elements,
Anchors, Comments), and must then
contain one or more IndexEntries or a SegmentedList (use
a SegmentedList for a permuted index).
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>IndexEntry</EMPHASIS></TERM>
<LISTITEM>
<PARA>Part of Index. It contains a
PrimaryIE, which may be followed by any number
of SeeIEs and SeeAlsoIEs;
these may be followed by any number of
sets of
SecondaryIEs followed by
TertiaryIEs, SeeIEs, and SeeAlsoIEs. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>IndexTerm</TERM>
<LISTITEM>
<PARA>A character string to be indexed,
occurring in the text flow but not in the text itself.
(And remember, IndexTerm appears in the text,
not in the Index!)
An IndexTerm must begin with a Primary, which may
be followed by a Secondary, a See, or any number
of SeeAlsos. A Secondary, in turn, may be
followed by a Tertiary, a See, or any number
of SeeAlsos; and a Tertiary may also be followed by
a See or any number.
of SeeAlsos
IndexTerm has common, SpanEnd, PageNum,
Significance, Scope, and Zone attributes.
The SpanEnd attribute may not be used if IndexTerm
has content; it should be used only
to mark the end of a span
of text that begins earlier
at an IndexTerm that does have
content.
The value of SpanEnd must be the
ID of that earlier IndexTerm.
The PageNum attribute may be used to
indicate the page on which the indexed term is found in print. Significance
may have the value Preferred, indicating that the
entry is the most pertinent of the series, or Normal (the
default).
The Scope attribute allows you to indicate what generated
indices the IndexTerm should appear in: All, Global,
or Local (all the indices, only the indices for collections,
such as Sets, or only the index for the work at hand).
The default value is IMPLIED, so you should set your
implementation's default to suit your case.
The Zone attribute takes IDREFs, which should be
the IDs of elements to which the IndexTerm applies.
This attribute allows you to attach indexing or
keyword information to objects rather than just
to points in the text.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>InformalEquation</EMPHASIS></TERM>
<LISTITEM>
<PARA>An untitled mathematical equation
displayed on a line by itself, rather than in-line.
It contains a Graphic, and
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>InformalExample</EMPHASIS></TERM>
<LISTITEM>
<PARA>An untitled Example. See <EMPHASIS>Example.</EMPHASIS> It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>InformalTable</EMPHASIS></TERM>
<LISTITEM>
<PARA>An array of text that has no Title.
Otherwise, it is just like Table except that it lacks the
ShortEntry and ToCEntry attributes. See <EMPHASIS>Table.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>InlineEquation</TERM>
<LISTITEM>
<PARA>An untitled mathematical equation
occurring in-line or as the content of an Equation.
It contains a Graphic, and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>InlineGraphic</TERM>
<LISTITEM>
<PARA>Encloses graphical data or
points via an attribute to an external file containing such data,
and is to be rendered in-line.
InlineGraphic has Format, Fileref, Entityref,
SrcCredit, and
ID attributes.
The format attribute may have the value of
any of the formats defined at the head of the DTD,
under &ldquo;Notations.&rdquo;
If it is desired to point to an external file, a filename may
be supplied as the value of the Fileref attribute, or an
external entity name may be supplied as the value of the
Entityref attribute. SrcCredit can be used to
hold information about the source of the image.
Unlike Graphic,
InlineGraphic should cause no line
break that would not occur for proper line justification.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Interface</TERM>
<LISTITEM>
<PARA>Any part of a graphical user
interface.
It may contain members of cptrphrase.gp,
and has common, Class, and MoreInfo attributes.
Class may have the value Button, Icon, Menu, or MenuItem
(no default). For the MoreInfo
attribute see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>InterfaceDefinition</TERM>
<LISTITEM>
<PARA>A specification for a graphical user
interface. It may contain members of cptrphrase.gp,
and has common and MoreInfo attributes.
For the MoreInfo
attribute see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>InvPartNumber</TERM>
<LISTITEM>
<PARA>An inventory part number. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ISBN</TERM>
<LISTITEM>
<PARA>International
Standard Book Number of a document. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ISSN</TERM>
<LISTITEM>
<PARA>International
Standard Serial Number of a journal. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>IssueNum</TERM>
<LISTITEM>
<PARA>The number of an issue of a journal.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>ItemizedList</EMPHASIS></TERM>
<LISTITEM>
<PARA>A list in which each item is marked with
a bullet, dash, or other dingbat (or no mark at all).
It consists of one or more ListItems. A ListItem in an
ItemizedList contains paragraphs and other
block-oriented elements, which
may in turn contain other lists; an ItemizedList may be
nested within other lists, too.
It has common attributes and
a Mark attribute. Your application might supply the mark to be used
for an ItemizedList, but you can use this attribute to
indicate the mark you desire to be used; there
is no fixed list of these.
<EMPHASIS>Usage Note:</EMPHASIS>
You might want to use one of the ISO text entities
that designates an appropriate dingbat.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>JobTitle</TERM>
<LISTITEM>
<PARA>Part of Affiliation. It contains
plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>JournalInfo</TERM>
<LISTITEM>
<PARA>Information about the journal in
which an Article appears, in that Article's ArtHeader.
It contains, in order, a required Title, optional
TitleAbbrev, Subtitle, ISSN, VolumeNum, IssueNum,
PageNums, PubDate, Publisher, and Copyright.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>KeyCap</TERM>
<LISTITEM>
<PARA>The text printed on a physical key on a
computer keyboard, not necessarily the same thing as a
KeyCode. It may contain members of cptrphrase.gp,
and has common and MoreInfo attributes.
For the MoreInfo
attribute see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Keycode</TERM>
<LISTITEM>
<PARA>The computer's numeric designation of a key on
a computer keyboard. Keycode contains plain text and has common
attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Keysym</TERM>
<LISTITEM>
<PARA>A key symbol name, which is not
necessarily the same thing
as a Keycap. For example, the Keysym for
the H key (Keycap H) might be <EMPHASIS>h.</EMPHASIS>
It contains plain text, and
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>LegalNotice</EMPHASIS></TERM>
<LISTITEM>
<PARA>An
acknowledgement of trademarks, etc. It
may have a Title, followed by paragraphs
and most kinds of block-oriented elements, in any order.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Lineage</TERM>
<LISTITEM>
<PARA>Part of an author's name, such
as &ldquo;Jr.&rdquo; It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>LineAnnotation</TERM>
<LISTITEM>
<PARA>A writer's or editor's comment on
a line of program code within an Example, ProgramListing,
or Screen. LineAnnotations are a document author's
comments on the code, not the comments written
into the code itself by the code's author.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Link</TERM>
<LISTITEM>
<PARA>A hypertext link. At present, all
the link types represented in the DTD are
provisional. Link is less provisional than the
others, however. In Hytime parlance, Link is a
clink. It may contain in-line elements
and has Endterm, Linkend, and Type attributes. The required
Linkend attribute specifies the target of the link,
and the optional Endterm attribute specifies
text that is to be fetched from elsewhere in the document
to appear in the Link. You can also supply this text directly as
the content of the Link, <EMPHASIS>in which case the
Endterm attribute is to be ignored</EMPHASIS>.
You may assign any value to the Type attribute.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>ListItem</EMPHASIS></TERM>
<LISTITEM>
<PARA>A wrapper for the elements of
items in an ItemizedList or OrderedList; it also
occurs within VarListEntry in VariableList.
It may contain just about anything except Sects and book
components.
It has common attributes and an Override attribute, which
may have any of the values of ItemizedList's
Mark attribute; use Override to override the mark
set at the ItemizedList level, when you desire to create
ItemizedLists with varying marks.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Literal</TERM>
<LISTITEM>
<PARA>Any literal string, used in-line, that is part of
data in a computer. This may be as precise as
the value of an argument, but Literal may also be used
as a catch-all element.
It may contain members of cptrphrase.gp,
and has common and MoreInfo attributes.
For the MoreInfo
attribute see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>LiteralLayout</EMPHASIS></TERM>
<LISTITEM>
<PARA>The wrapper for lines set off from
the main text that are not tagged as Screens, Examples,
or ProgramListing, in which line breaks and leading
white space are to be regarded as significant.
It contains in-line elements, and has common
and Width attributes, for
specifying a number representing the maximum width of
the contents.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>LoT</EMPHASIS></TERM>
<LISTITEM>
<PARA>The generic tag for such things as a List
of Figures or List of Tables. An LoT may occur within
a Chapter, or Appendix, or may be a book
component on its own.
It contains, in order, an optional DocInfo, Title, and TitleAbbrev,
followed by one or more LoTentries. It has
common, SrcCredit, and Label attributes; in this case the values of
Label may be Equation, Examples, Figures, or Tables,
with no default.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>LoTentry</EMPHASIS></TERM>
<LISTITEM>
<PARA>An element of LoT. It contains
the text of the thing to be listed,
including, if desired, in-line elements. It has
common, SrcCredit, and PageNum attributes.
SrcCredit can be used to hold information about the
source of the entry in the case of a list of
illustrations, and PageNum
should be used to indicate either the page
on which the entry begins or the pages it covers.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ManVolNum</TERM>
<LISTITEM>
<PARA>Specific to UNIX man pages, it
designates the section of a complete set of
reference pages that a reference page belongs to. It appears
within RefMeta, contains plain text, and has common
attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Markup</TERM>
<LISTITEM>
<PARA>A string of formatting markup in text,
which it is desired to represent literally. See also
<EMPHASIS>SGMLTag.</EMPHASIS>
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>MediaLabel</TERM>
<LISTITEM>
<PARA>The physical medium on or in which
some information is contained.
MediaLabel may contain plain text,
and has common, Class, and MoreInfo attributes.
Class may have the value Cartridge, CDRom, Disk, or Tape
(no default). For the MoreInfo
attribute see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Member</TERM>
<LISTITEM>
<PARA>Part of a SimpleList. It contains
in-line elements and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ModeSpec</TERM>
<LISTITEM>
<PARA>Contains application-specific
information necessary for
the completion of an OLink; see <EMPHASIS> OLink.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Msg</EMPHASIS></TERM>
<LISTITEM>
<PARA>The part of a MsgEntry that contains
the error message and its subparts, along with
explanatory text. A Msg has a required MsgMain,
followed by any number of MsgSubs and MsgRels, in any
order. It has common and Label attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>MsgAud</TERM>
<LISTITEM>
<PARA>Describes the audience
to which a Msg is
relevant. It contains plain text only, and
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>MsgEntry</EMPHASIS></TERM>
<LISTITEM>
<PARA>A wrapper for an entry in a MsgSet.
A MsgEntry
must contain one or more Msgs, followed by an optional
MsgInfo, then any number of MsgExplans.
MsgEntry has common
attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>MsgExplan</TERM>
<LISTITEM>
<PARA>Holder for any kind of explanatory
material relating to the
Msg. MsgExplan begins with an optional Title
(typically something such as
&ldquo;Explanation:&rdquo; or &ldquo;Action:&rdquo;)
and may contain block-oriented elements.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>MsgInfo</EMPHASIS></TERM>
<LISTITEM>
<PARA>Information about the Msg
containing it. It may have any number of MsgLevels,
MsgOrigs, and MsgAuds, in any order, and has common
attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>MsgLevel</EMPHASIS></TERM>
<LISTITEM>
<PARA>The level of importance or severity
of a Msg. It contains only plain text, and has common
attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>MsgMain</EMPHASIS></TERM>
<LISTITEM>
<PARA>The main error message of a
Msg. MsgMain begins with an optional Title and contains
MsgText, which is the text of the message. It
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>MsgOrig</TERM>
<LISTITEM>
<PARA>The origin of a Msg.
It contains only plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>MsgRel</EMPHASIS></TERM>
<LISTITEM>
<PARA>An optional subpart of a Msg, containing
a message that is related to the main message
(MsgMain) but which appears in a
different place. For example, MsgMain
might be a message that appears on a
network client, and MsgRel a related message
that appears at the
server console in response to the same condition or event.
MsgRel begins with an optional Title and contains
MsgText. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>MsgSet</EMPHASIS></TERM>
<LISTITEM>
<PARA>A list of error messages produced
by a system, with various additional information.
MsgSet contains one or more MsgEntries, and has
common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>MsgSub</EMPHASIS></TERM>
<LISTITEM>
<PARA>An optional subpart of a Msg, which
might contain messages that appear in various contexts. It
contains a an optional Title followed by
MsgText. MsgSub has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>MsgText</TERM>
<LISTITEM>
<PARA>Contents of the parts of Msg.
It may contain block-oriented elements,
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Note</EMPHASIS></TERM>
<LISTITEM>
<PARA>A message to the user, set off from the text.
See <EMPHASIS>Caution.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>OLink</TERM>
<LISTITEM>
<PARA>A link that may perform some operation to
find its target. In contrast to Link, OLink has no
Linkend attribute, but rather a TargetDocEnt, the value of
which is the name of a text or data entity already
defined by the user. The LinkMode attribute points by
ID to a ModeSpec; for convenience, ModeSpecs
located in the BookInfo. ModeSpec contains
instructions (probably application-specific) for operating
on the entity named by TargetDocEnt, <foreignphrase>e.g.</>, the
TargetDocEnt is another Book, and the ModeSpec specifies
that all the second-level headings should be searched
for a phrase. The LocalInfo attribute may be used to
hold such a phrase, which may be thought of as a
replacement for some variable in ModeSpec.
OLink may contain in-line elements
and has a Type attribute, to which you may assign any
value.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Option</TERM>
<LISTITEM>
<PARA>An option for a computer program command.
It may have members of cptrphrase.gp, and has common
attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Optional</TERM>
<LISTITEM>
<PARA>For use in Synopsis, as in a
RefEntry, where optional parameters
conventionally are shown in square
brackets; may also appear in-line.
Optional should replace those brackets. It may contain
elements from cptrphrase.gp, and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>OrderedList</EMPHASIS></TERM>
<LISTITEM>
<PARA>A numbered or lettered list, consisting of
ListItems. A ListItem in an
OrderedList contains paragraphs and other
block-oriented elements, which
may in turn contain other lists; an OrderedList may be
nested within other lists, too.
OrderedList has common attributes, along with
a Numeration attribute, which
may have the value Arabic, Upperalpha, Loweralpha,
Upperroman, or Lowerroman. If no value is supplied,
the processing expectation should be that Arabic
numbering (1, 2, 3, ...) is to be used.
It has an InheritNum attribute, for which the
value Inherit specifies for a
nested list that the numbering of ListItems should include the
number of the item within which they are nested (2a, 2b, etc.,
rather than a, b, etc.); the default value is Ignore.
It has a Continuation attribute, with values
Continues or Restarts (the default),
which may be used to
indicate whether the numbering of a list begins afresh (default)
or continues that of the immediately preceding list (Continues).
You need supply the Continuation attribute only
if your list continues the numbering of the preceding list.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>OrgDiv</TERM>
<LISTITEM>
<PARA>Part of an organization.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>OrgName</TERM>
<LISTITEM>
<PARA>An organization that is not
a corporation (<EMPHASIS>cf.</EMPHASIS> CorpName)
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>OtherAddr</TERM>
<LISTITEM>
<PARA>(Formerly Other.) An escape hatch for information given in Address
that doesn't fit in any other element.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>OtherCredit</TERM>
<LISTITEM>
<PARA>Supplements
Author and Editor; you could use it to credit a contributor,
a contributing editor, or some deserving production person.
Contents are as for <EMPHASIS>Author.</EMPHASIS> It has common
attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>OtherName</TERM>
<LISTITEM>
<PARA>An alternative to Firstname and
Surname, for use in Author, Editor, or OtherCredit.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>PageNums</TERM>
<LISTITEM>
<PARA>The numbers of the pages contained
in a Book, for use in its BookBiblio.
It contains plain text (<foreignphrase>e.g.</>, ix, 292)
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Para</EMPHASIS></TERM>
<LISTITEM>
<PARA>A paragraph. A Para may not
have a Title: to attach a Title to a Para use
FormalPara. Para
may contain any in-line element and almost
any block-oriented element. Abstract, AuthorBlurb, Caution,
Important, Note, and
Warning are excluded, as are Sects and higher-level
elements. Para has common attributes.
See also <emphasis>FormalPara</> and <emphasis>SimPara</>.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Paragraphs</EMPHASIS></TERM>
<LISTITEM>
<PARA>See <EMPHASIS>Para.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ParamDef</TERM>
<LISTITEM>
<PARA>Part of a FuncSynopsis, providing
data type information and the name of the
Parameter this information applies
to. A ParamDef may contain any combination of
plain text, Replaceable, Data, or Parameter, in any order.
It has common attributes. See <EMPHASIS>FuncDef,</EMPHASIS>
<EMPHASIS>FuncSynopsis.</EMPHASIS> Parameter has common and Class attributes,
the latter with the possible values Command, Function, and Option
(no default).
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Parameter</TERM>
<LISTITEM>
<PARA>Part of an instruction to a computer.
It may contain members of cptrphrase.gp,
and has common, Class, and MoreInfo attributes.
Class may have the value Command, Function, or Option
(no default). For the MoreInfo
attribute see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Part</EMPHASIS></TERM>
<LISTITEM>
<PARA>A section of a Book containing
book components.
Part contains an optional DocInfo, a required Title, an optional TitleAbbrev,
an optional PartIntro,
followed by one or more book components.
It has common and Label attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>PartIntro</EMPHASIS></TERM>
<LISTITEM>
<PARA>Introduction to the contents
of a Part;
may also appear in
Reference. It has optional Title and TitleAbbrev,
and then may contain anything that can appear in a Chapter.
PartIntro has common and Label attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Phone</TERM>
<LISTITEM>
<PARA>Part of Address. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>POB</TERM>
<LISTITEM>
<PARA>Part of Address. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Postcode</TERM>
<LISTITEM>
<PARA>Part of Address. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Preface</EMPHASIS></TERM>
<LISTITEM>
<PARA>Any introductory matter in a Book.
Preface may occur more than once in Book, before
any Chapter, Part, or Reference: for example,
you might have two Prefaces, one titled &ldquo;Preface&rdquo;
and the other &ldquo;Introduction.&rdquo;
Preface may begin with a DocInfo, followed by
a required Title, optional TitleAbbrev, and anything
found in the body of a Chapter.
Preface has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Primary</TERM>
<LISTITEM>
<PARA>A word or phrase occurring in
the text that is to
appear in the index under as a primary entry. It must be
nested within IndexTerm tags. Primary may contain in-line
elements. It has SortAs and common attributes.
SortAs can be used to provide
an alternate string for alphabetizing the index: if Primary
has the content &ldquo;14&rdquo;
one might give Primary the attribute
Sortas=&ldquo;fourteen&rdquo;.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>PrimaryIE</EMPHASIS></TERM>
<LISTITEM>
<PARA>A primary entry in an Index, not in the
text. It may contain plain text and inline elements.
It has common
attributes and an optional Linkends attribute, which
may have the
value of some list of element IDs.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>PrintHistory</EMPHASIS></TERM>
<LISTITEM>
<PARA>The printing history of
a Book. It contains paragraphs and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Procedure</EMPHASIS></TERM>
<LISTITEM>
<PARA>A list of operations to
be performed. Procedure may have a Title and
TitleAbbrev, followed by block-oriented elements,
such as paragraphs, followed by one or more Steps.
A Step may have a SubSteps wrapper for Steps nested
within it, and this nesting may continue indefinitely
(contrast the methods of nesting lists and Sects).
This construction is intended to maximize the reusability
of subsections of Procedures.
Procedure has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ProductName</TERM>
<LISTITEM>
<PARA>Formal name for any product.
It contains in-line elements, and has common and
Class attributes. The Class attribute may have the
values Service, Trade (the default), Registered, or Copyright.
Thus a trademark can be marked up as Trademark
or as a Productname with the
default Class attribute value.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ProductNumber</TERM>
<LISTITEM>
<PARA>A number assigned to a product.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>ProgramListing</EMPHASIS></TERM>
<LISTITEM>
<PARA>A listing of a program.
Line breaks and leading
white space are significant in a ProgramListing, which
may contain in-line elements, including LineAnnotations.
(LineAnnotations are a document author's
comments on the code, not the comments written
into the code itself by the code's author.)
ProgramListing has common and Width attributes, the
latter for specifying a number representing the maximum
width of the contents.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Property</TERM>
<LISTITEM>
<PARA>A defined set of data
associated with a window. It may contain members of cptrphrase.gp,
and has common and MoreInfo attributes.
For the MoreInfo
attribute see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>PubDate</TERM>
<LISTITEM>
<PARA>The date of publication of a document.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Publisher</TERM>
<LISTITEM>
<PARA>The publisher of a document. It contains a PublisherName and any number of Addresses.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>PublisherName</TERM>
<LISTITEM>
<PARA>The name of a publisher of a document. It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>PubsNumber</TERM>
<LISTITEM>
<PARA>A number assigned to a publication,
other than an ISBN or ISSN or InvPartNumber.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Quote</TERM>
<LISTITEM>
<PARA>An in-line quotation. For block quotes
use BlockQuote. Quote may contain plain text
and in-line elements,
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>RefClass</TERM>
<LISTITEM>
<PARA>An element of RefNameDiv, in which the
applicability or scope of the topic of a RefEntry may be
indicated. It may contain
plain text or Application, and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>RefDescriptor</TERM>
<LISTITEM>
<PARA>A substitute for RefName to be used
when a
RefEntry covers more than one topic and none of the topic names
is to be used as the sort name. It contains plain
text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>RefEntry</EMPHASIS></TERM>
<LISTITEM>
<PARA>A reference page. It contains,
in order, an optional DocInfo and optional RefMeta;
any number of Comments and members of links.gp, in any order;
a required RefNameDiv, an optional RefSynopsisDiv,
and one or more RefSect1s.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Reference</EMPHASIS></TERM>
<LISTITEM>
<PARA>A collection of RefEntries,
formin a book component.
Reference has an optional DocInfo,
a required Title,
an optional TitleAbbrev, an optional PartIntro, and
one or more RefEntries.
It has common and Label attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>RefEntryTitle</TERM>
<LISTITEM>
<PARA>Primary name given to a
reference page for
sorting and indexing. It may be the same as the first of
the RefNames, or it may be the same as the RefDescriptor.
It may contain in-line elements, and has common
attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>RefMeta</EMPHASIS></TERM>
<LISTITEM>
<PARA>The first major division of a reference page,
in which metainformation about the reference page is supplied.
RefMeta contains, in order, a required RefEntryTitle,
an optional ManVolNum, and any number of
RefMiscInfos. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>RefMiscInfo</TERM>
<LISTITEM>
<PARA>Marks information in
RefMeta that may be
supplied by vendors, such as copyright, release date, revision
date, print status, operating system, hardware architecture,
or a descriptive phrase for use in a print header.
It contains plain text, and has common and Class attributes.
The Class attribute can be used to distinguish categories of
RefMiscInfos; it has no defined values.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>RefName</TERM>
<LISTITEM>
<PARA>The subject or subjects of a
reference page. It appears within RefNameDiv.
It may contain plain text and in-line elements, and
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>RefNameDiv</EMPHASIS></TERM>
<LISTITEM>
<PARA>The second major division of a reference page.
It contains, in order, an optional RefDescriptor, one or more
RefNames, a required RefPurpose, and
any number of optional RefClass,
followed by any number of Comments and links, in any order.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>RefPurpose</TERM>
<LISTITEM>
<PARA>A short phrase describing the
subject of
the reference page. It may contain in-line elements
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>RefSect1</EMPHASIS></TERM>
<LISTITEM>
<PARA>Equivalent to a Sect1 in the DocBook DTD.
It contains a Title, followed by any of the allowable contents
of a Sect, except that only two levels of subsection
are allowed, RefSect2 and RefSect3. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>RefSect2</EMPHASIS></TERM>
<LISTITEM>
<PARA>Equivalent to a Sect2 in the DocBook DTD, and may
occur within RefSect1 or RefSynopsisDiv. It may contain any of the
allowable contents of a Sect, except that only RefSect3
is allowed as a further subsections. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>RefSect3</EMPHASIS></TERM>
<LISTITEM>
<PARA>Subdivision of RefSect2. No further
subdivisions allowed; contents otherwise as for RefSect2.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>RefSynopsisDiv</EMPHASIS></TERM>
<LISTITEM>
<PARA>The third major division of a reference page,
in which the syntax of the subject of the reference page is
indicated. It contains, in order,
an optional Title and TitleAbbrev, followed by either one or more
synopses (Synopsis, CmdSynopsis, or FuncSynopsis) succeeded
by any number of RefSect2s, or simply one or more RefSect2s.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>ReleaseInfo</EMPHASIS></TERM>
<LISTITEM>
<PARA>Information about a particular version of a
document. It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Replaceable</TERM>
<LISTITEM>
<PARA>Part of a synopsis or command line,
indicating that its contents may be replaced.
It may contain basic in-line elements (not cptrphrase.gp)
and has common and Class attributes.
Class may have the value
Command, Function, Option, or Parameter
(no default).
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ReturnValue</TERM>
<LISTITEM>
<PARA>A value returned by a function.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>RevHistory</EMPHASIS></TERM>
<LISTITEM>
<PARA>A section of BookInfo or DocInfo
recording revisions to the document. It
consists of any number of Revisions, and
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Revision</EMPHASIS></TERM>
<LISTITEM>
<PARA>An entry in RevHistory,
describing some
revision made to the text. It contains, in order,
a required RevNumber and required Date, then, optionally,
one or more sets of AuthorInitials, and
a RevRemark. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>RevNumber</TERM>
<LISTITEM>
<PARA>The number of a Revision.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>RevRemark</TERM>
<LISTITEM>
<PARA>An element
of Revision, describing the Revision.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Row</EMPHASIS></TERM>
<LISTITEM>
<PARA>A row in a TBody, THead, or TFoot.
It contains one or more Entries or
EntryTbls, in any order.
It has common, Rowsep, and VAlign attributes.
</PARA>
<PARA><EMPHASIS>Rowsep</EMPHASIS> determines Row separators. If its content is
1 (yes), display the internal vertical row ruling
below each Row; if 0 (no), do not display it. It is
ignored for the last Row of the TGroup, THead,
or TFoot, where
the frame value applies. There is no default.
The value is inherited from TGroupStyle, if used.
</PARA>
<PARA><EMPHASIS>Valign</EMPHASIS> governs the vertical
positioning of text within a Row.
Allowed values are Top, Middle, and Bottom
(no default).
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Screen</EMPHASIS></TERM>
<LISTITEM>
<PARA>Intended to represent what the user sees or
might see on a computer screen. It
consists of in-line elements, in which line breaks
and leading white space are considered
significant. It has common attributes and a Width
attribute for specifying a number representing the maximum width of
the contents.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ScreenInfo</TERM>
<LISTITEM>
<PARA>Part of ScreenShot
(see <EMPHASIS>ScreenShot</EMPHASIS>). A ScreenInfo
indicates how the Graphic with which it is paired was created,
as a guide for future revisions. It may contain only plain
text, and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>ScreenShot</EMPHASIS></TERM>
<LISTITEM>
<PARA>Like Screen,
intended to represent what the user sees or
might see on a computer screen. It
consists of an optional ScreenInfo
and a required Graphic.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Secondary</TERM>
<LISTITEM>
<PARA>A word or phrase in the text that is to
appear in the index beneath a Primary entry. It must be
nested within IndexTerm tags and must follow a Primary element.
It may contain in-line elements, and has
SortAs and common attributes. See <EMPHASIS>Primary.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>SecondaryIE</TERM>
<LISTITEM>
<PARA>Part of IndexEntry,
like PrimaryIE (see <EMPHASIS>PrimaryIE</EMPHASIS>).
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Sect1</EMPHASIS></TERM>
<LISTITEM>
<PARA>A top-level section of a book component,
including the Title of that section. Sect2&ndash;5 nest
in order within Sect1. Anything may occur
within a Sect1 except a DocInfo, Preface,
Chapter, Appendix, or
another Sect1, including a Glossary, Bibliography, RefEntry, ToC, Index,
or LoT. A Sect must have a Title, which is the text
of the heading itself, and may have a TitleAbbrev; it must
include some content, whether paragraphs or other block-oriented elements, including
a Sect2. Sect1&ndash;5 have common,
Label, and Renderas attributes. The Renderas attribute may
have the value Sect1 through Sect5, and may be used to
specify that the Sect (particularly its heading) is to be
presented in the format defined for a Sect of some other level. The default is IMPLIED.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Sect2</EMPHASIS></TERM>
<LISTITEM>
<PARA>A section beginning with a second-level
heading; must be nested within a Sect1.
Allowable and required contents
for Sect2, and its attributes, are like those for Sect1.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Sect3</EMPHASIS></TERM>
<LISTITEM>
<PARA>See <EMPHASIS>Sect1, Sect2</EMPHASIS>.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Sect4</EMPHASIS></TERM>
<LISTITEM>
<PARA>See <EMPHASIS>Sect1, Sect2</EMPHASIS>.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Sect5</EMPHASIS></TERM>
<LISTITEM>
<PARA>See <EMPHASIS>Sect1, Sect2</EMPHASIS>. Sect5 may
not contain Sects of any level, and
no further subdivisions are supplied in the DocBook DTD.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>See</TERM>
<LISTITEM>
<PARA>Part of IndexTerm, indicating, for
a word or phrase in the text, the index entry to
which the reader is to be directed when he consults
the stub index entry for another element within
the IndexTerm.
See must be nested within IndexTerm tags and must
follow a Primary or Secondary element.
It may contain in-line
elements, and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>SeeAlso</TERM>
<LISTITEM>
<PARA>Like See, but indicates
the index entries to which the reader is <EMPHASIS>also</EMPHASIS>
to be directed when he consults a full index entry.
SeeAlso must be nested within IndexTerm tags and must
follow a Primary or Secondary element.
It may contain in-line
elements, and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>SeeAlsoIE</TERM>
<LISTITEM>
<PARA>A &ldquo;see also&rdquo; entry in an Index, not
in the text, occurring
unnested within IndexEntry at the PrimaryIE or
SecondaryIE level.
It may contain plain text and in-line elements.
It has common
attributes and an optional Linkends attribute, which
may have the
value of some list of IndexEntry IDs.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>SeeIE</EMPHASIS></TERM>
<LISTITEM>
<PARA>A &ldquo;see&rdquo; entry in an Index, not in the
text, occurring
unnested within IndexEntry at the PrimaryIE or
SecondaryIE level.
It may contain plain text and in-line elements.
It has common
attributes and an optional Linkend attribute, which
may have the
value of some IndexEntry ID.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Seg</TERM>
<LISTITEM>
<PARA>A component of a SegmentedList. Segs are the
only content of a SegmentedList's
SegListItems. Seg may contain in-line
elements. It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>SegListItem</EMPHASIS></TERM>
<LISTITEM>
<PARA>A list item in a SegmentedList.
It consists
of two or more Segs, and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>SegmentedList</EMPHASIS></TERM>
<LISTITEM>
<PARA>A list of sets of units.
It may be used to represent
sets of information often presented as simple tables.
SegmentedList may have a Title and TitleAbbrev, followed by any number
of SegTitles, and one or more SegListItems.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>SegTitle</TERM>
<LISTITEM>
<PARA>A title that pertains to one Seg in each
SegListItem: the first SegTitle to the first Seg, the second SegTitle
to the second Seg, and so on. It may contain in-line elements.
SegTitles
are grouped at the beginning of a SegmentedList, before the SegListItems.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>SeriesInfo</TERM>
<LISTITEM>
<PARA>Part of BookInfo or BiblioEntry,
containing information about the publication series of
which the book is a part. SeriesInfo contains,
in order, a
required Title, optional TitleAbbrev and Subtitle;
any number of AuthorGroups, optional ISBN,
VolumeNum, and IssueNum; a required SeriesVolNums,
any number of PubDates and Publishers, and finally
an optional Copyright.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>SeriesVolNums</TERM>
<LISTITEM>
<PARA>The numbers of all the volumes
in a Series, for use in SeriesInfo. It contains plain text
(<foreignphrase>e.g.</>, 1&ndash;5)
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Set</EMPHASIS></TERM>
<LISTITEM>
<PARA>Two or more Books. Set may have,
in order, a
Title, TitleAbbrev, SetInfo, and ToC, followed by
the Books, followed by an optional SetIndex. Note that
a SetIndex may appear in a Book, too.
Set has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>SetIndex</EMPHASIS></TERM>
<LISTITEM>
<PARA>Index to a Set. It may
occur within a Set or one of the Books in a Set.
It contains an optional DocInfo, Title, and TitleAbbrev,
followed by any number of block-oriented elements
and then one or more IndexEntries or one
or more IndexDivs.
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>SetInfo</EMPHASIS></TERM>
<LISTITEM>
<PARA>Metainformation for a Set,
in which it may appear. It may contain, in any order,
any number of: Author, AuthorInitials,
Copyright, CorpAuthor, CorpName, Date,
Editor, Edition, InvPartNumber, ISBN, LegalNotice,
OrgName, OtherCredit,
PrintHistory, ProductName, ProductNumber,
Publisher, PubsNumber, ReleaseInfo, RevHistory,
Title, Subtitle, and VolumeNum.
SetInfo has common attributes and a Contents attribute.
Contents is partly a stub for future development; at the
moment its values should be the IDs of the ToC, Books,
and SetIndex that comprise the Set, in the order of
their appearance.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>SGMLTag</TERM>
<LISTITEM>
<PARA>An element tag in SGML. This
element contains plain text, and should not include
delimiting angle brackets, ampersands,
percent signs, or semicolons: those should be
supplied by the renderer if appropriate. It has common and Class
attributes. Class may be Attribute, Element,
GenEntity, or ParamEntity; there is no default.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ShortAffil</TERM>
<LISTITEM>
<PARA>Brief version of of Affiliation, in
which it may appear. It contains
plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Sidebar</EMPHASIS></TERM>
<LISTITEM>
<PARA>Segment of a book component
that is isolated from the narrative flow
of the main text, typically boxed and floating.
Sidebar may have
a Title and a TitleAbbrev, followed by
paragraphs, lists, and other block-oriented
elements. No Sects allowed.
Sidebar has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>SimPara</EMPHASIS></TERM>
<LISTITEM>
<PARA>A paragraph that is only a text block,
without included block-oriented elements. It
may contain InlineGraphic, InlineEquation, and synopses.
SimPara has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>SimpleList</EMPHASIS></TERM>
<LISTITEM>
<PARA>Intended for long lists of single words
or short phrases. It consists of one or more Members, and
has common, Columns, and Type attributes. The value of
the Type attribute may be Inline, Horiz, or Vert (the
default), indicating that the list should be formatted
as part of a regular paragraph, as an array reading L to R
then top to bottom, or
as an array reading top to bottom then L to R.
The Columns attribute value must be a number, the number
of columns the array should contain. Further details
on rendering may be found in the comment in the DTD,
but these details may required some revision in the
future.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>SpanSpec</TERM>
<LISTITEM>
<PARA>Formatting information for a
spanned column in a TGroup (part of Table).
SpanSpec is an empty element, bearing common, Align,
Char, Charoff, Colsep, Nameend (required),
Namest (required), Rowsep, and Spanname,
(required) attributes.
SpanSpec identifies a horizontal span of
columns and associated attributes that can
subsequently be referenced by its SpanName to
provide attributes repeatedly used in the Entries or
EntryTbls in the Rows of the TGroup that is
nested within the THead, TFoot, or TBody in which the
SpanSpec occurs.
</PARA>
<PARA>The reason Colname is used rather than Colnum
in identifying
SpanSpec is that the names are independent of revisions that
may change the number of inserted/deleted columns, as
long as Namest remains to the left of (has a smaller colnum
than) Nameend. SpanSpecs set on THead or TFoot override
those on the containing TGroup and apply to just the THead
or TFoot. SpanSpecs from the containing TGroup apply to
TBody.
</PARA>
<PARA><EMPHASIS>Align</EMPHASIS> controls the horizontal position
of text within the column.
The value of Align may be Left (quad flush left),
Center (centered), Right (quad flush right),
Justify (both quad left and right), or Char (align to the
left of Char, positioned by Charoff). The default
is Center.
</PARA>
<PARA><EMPHASIS>Char</EMPHASIS> contributes to Align. If the
value of Align is &ldquo;char&rdquo;, the value of Char
should be a character on the first occurrance
of which the entry is to be aligned. If that
character does not occur in the entry, the entry
is aligned to the left of the position determined
by Charoff. The default is inherited
from the ColSpec of the column named by Namest.
</PARA>
<PARA><EMPHASIS>Charoff</EMPHASIS> contributes with Char to Align.
Charoff is the proportion
of the current column width, expressed in percentage,
to be allowed before the left edge of the first occurrence
of the character given as the value of Char, if any.
The default is inherited from the ColSpec of
the column named by Namest.
</PARA>
<PARA><EMPHASIS>Colsep</EMPHASIS> determines column separators. If its value
is 1 (yes), display the internal column rulings to
the right of each item; if 0 (no), do not
display it. It is ignored for the last column, where the
Frame setting applies. (In CALS,
1 (yes) is expressed as 1 and No as 0.)
The default is inherited from the ColSpec of
the column named by Namest.
</PARA>
<PARA><EMPHASIS>Nameend</EMPHASIS> is the name of the rightmost
column of the span. Names are identified in the
Colspec of the current TGroup.
</PARA>
<PARA><EMPHASIS>Namest</EMPHASIS> or Name Start,
is the name of the leftmost column
of the span. Names are identified in the
Colspec of the current TGroup.
</PARA>
<PARA><EMPHASIS>Rowsep</EMPHASIS> determines Row separators. If its content is
1 (yes), display the internal vertical Row ruling
below each item; if 0 (no), do not display it. It is
ignored for the last Row of the table, where
the frame value applies. There is no default.
The value is inherited from the ColSpec of
the column named by Namest.
</PARA>
<PARA><EMPHASIS>Spanname</EMPHASIS> is the name of the
horizontal span.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>State</TERM>
<LISTITEM>
<PARA>Part of Address. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Step</EMPHASIS></TERM>
<LISTITEM>
<PARA>Part of a Procedure. After its
optional Title, Step may contain
block-oriented elements
mixed with occurrences of the SubSteps element.
SubSteps then contains one or more
Steps&mdash;it is a wrapper.
Step has common attributes
and a Performance attribute, which indicates whether
the step must be performed: the values are Optional
and Required (the default).
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Street</TERM>
<LISTITEM>
<PARA>Part of Address. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>StructField</TERM>
<LISTITEM>
<PARA>A field in a Structure.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>StructName</TERM>
<LISTITEM>
<PARA>The name of a Structure. It contains
plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>SubSteps</TERM>
<LISTITEM>
<PARA>A wrapper for Steps within Steps.
See <EMPHASIS>Procedure, Step.</EMPHASIS> Note that SubSteps, like
Step, has a Performance attribute, the values of which
may be Optional or Required (the default).
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Subscript</TERM>
<LISTITEM>
<PARA>A subscript.
It may contain basic in-line elements and Replaceable,
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Subtitle</TERM>
<LISTITEM>
<PARA>Subtitle of a document.
It may contain in-line elements.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Superscript</TERM>
<LISTITEM>
<PARA>A superscript.
It may contain basic in-line elements and Replaceable,
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Surname</TERM>
<LISTITEM>
<PARA>(Western-style) family name
of an author. It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Symbol</TERM>
<LISTITEM>
<PARA>A name that is replaced by a value before
processing. It contains plain text and has common
attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Synopsis</TERM>
<LISTITEM>
<PARA>The
syntax of a command or function. It appears
within RefSynopsisDiv, and may occur elsewhere in
a document, too.
Synopsis has an optional title, followed by one or more
in-line elements and Graphics; within it,
line breaks and white space are significant.
It has common attributes. CmdSynopsis and FuncSynopsis
are alternates to Synopsis, but they may not contain
Graphics and within them line breaks and white space are
not significant. Synopsis should be displayed as
a block-oriented element, not in-line.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>SynopFragment</TERM>
<LISTITEM>
<PARA>Part of CmdSynopsis. It contains
one or more Args or Groups, in any order, and has
the attributes ID (the only required attribute),
Lang, Remap, Role, and XRefLabel.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>SynopFragmentRef</TERM>
<LISTITEM>
<PARA>Part of a CmdSynopsis. It
contains RCDATA (characters, in which entity
references and character references are
recognized in parsing) rather than elements.
It has common and Linkend (required) attributes.
Linkend should point to SynopFragment.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>SystemItem</TERM>
<LISTITEM>
<PARA>Any system-related item.
It may contain members of cptrphrase.gp,
and has common, Class, and MoreInfo attributes.
Class may have
the value Constant, EnvironVar, Macro, OSname, Prompt,
Resource, or SystemName
(no default). For the MoreInfo
attribute see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Table</EMPHASIS></TERM>
<LISTITEM>
<PARA>An array of text. Table is modelled on CALS
tables.
The present Table element has a required Title,
an optional TitleAbbrev, and either one or more Graphics
or one or more TGroups. Tables may not contain
either Tables or InformalTables.
Table has common, Colsep, Frame, Label, Orient, Pgwide, Rowsep, Shortentry,
Tabstyle, and Tocentry attributes.
elements that may be contained within
TGroup are specified as having omissible
end tags, except for EntryTbl. Who said the military
isn't thoughtful?
</PARA>
<PARA><EMPHASIS>Colsep</EMPHASIS> determines column separators. If its value
is 1 (yes), display the internal column rulings to
the right of each item; if 0 (no), do not
display it. It is ignored for the last column, where the
value of Frame applies. There is no default; the
value may be inherited from Tabstyle in the FOSI.
</PARA>
<PARA><EMPHASIS>Frame</EMPHASIS> describes the positioning of
framing rules around the Table. The allowed values are
Sides (left and right), Top (below title),
Bottom (after last Row, possibly the last Row of
TFoot), Topbot (both top and bottom), All
(all of the aforementioned), and None.
There is no default. The value may be
inherited from Tabstyle in the FOSI.
</PARA>
<PARA><EMPHASIS>Label</EMPHASIS> is just the same as DocBook's
Label attribute: a reference string, such as a
number, to be prefixed to the Title.
</PARA>
<PARA><EMPHASIS>Orient</EMPHASIS> determines the orientation of the
Table. The allowed values are Port (the orientation
of the rest of the text of the Book, that is, upright)
and Land (90 degrees counterclockwise from the
orientation of the rest of the text of the Book).
If you assume that the page is taller than
it is wide, tables that take up a whole page and
are wider than they are tall should be given the Land value.
There is no default, the value may be
inherited from the FOSI.
</PARA>
<PARA><EMPHASIS>Pgwide</EMPHASIS> constrains the table to
or liberates it from the boundaries of its
column. If the value is
1 (yes), the table runs
across the entire page; if 0 (no), the table &ldquo;runs
across just the (galley) width of the
current column of the page, regardless
of the value of Orient. If the
value is 0 (no), it has no meaning for the case when
Orient is set to Land.
The value may be inherited from Tabstyle in
the FOSI, if available.
</PARA>
<PARA><EMPHASIS>Rowsep</EMPHASIS> determines row separators. If its content is
1 (yes), display the internal vertical row ruling
below each item; if 0 (no), do not display it. It is
ignored for the last row of the table, where
the value of Frame applies. There is no default.
The value may be inherited from TabStyle.
</PARA>
<PARA><EMPHASIS>Shortentry</EMPHASIS> determines whether value of ShortEntry is be used
in the an Index or ToC or LoT. If the value is 0 (no),
the TitleAbbrev is not used; if 1 (yes), the ShortEntry
is used.
<EMPHASIS>Usage Note:</EMPHASIS> Be aware that
this mechanism duplicates the DocBook element
TitleAbbrev. It would be better, for any given
work, to choose one mechanism
or the other, rather than mix them.
</PARA>
<PARA><EMPHASIS>Tabstyle</EMPHASIS> is the name of
a table style defined in the FOSI. There is no default.
</PARA>
<PARA><EMPHASIS>Tocentry</EMPHASIS> determines whether the
Table's Title should be included in an LoT.
The value may be 1 (yes) (include) or No (exclude).
The default is 1 (yes) (include).
should be ignored if the optional Title is
omitted; that would be the case if you were using Table,
instead of InformalTable, for a Table that has no
Title; presumably only a reference string could then
appear in an LoT.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Term</TERM>
<LISTITEM>
<PARA>The hanging term attached to a ListItem
within a VarListEntry in a
VariableList; visually, a VariableList
is a set of Terms with attached items such as paragraphs. Each
ListItem may be associated with a set of Terms. Term may contain
in-line elements or synopses. It has
common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Tertiary</TERM>
<LISTITEM>
<PARA>A word or phrase that is to
appear in the index under a Secondary entry. It must be
nested within IndexTerm tags and must follow a Secondary
element. It may contain in-line elements, and has SortAs
and common attributes. See <EMPHASIS>Primary.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>TertiaryIE</TERM>
<LISTITEM>
<PARA>Part of IndexEntry, like PrimaryIE
see <EMPHASIS>PrimaryIE</EMPHASIS>).
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>TBody</EMPHASIS></TERM>
<LISTITEM>
<PARA>Wrapper for the Rows of a Table or
InformalTable. It contains simply one or more Rows,
and has common and VAlign attributes.
VAlign governs the vertical
positioning of text within a Row.
Allowed values are Top (the default), Middle, and Bottom.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>TFoot</EMPHASIS></TERM>
<LISTITEM>
<PARA>TFoot is a optional part of TGroup
(part of Table), identifying the footer information in a
Table, which is displayed after the TBody and also at the
bottom of any TBody Rows before a page break.
TFoot must have one or
more Rows. It has common and VAlign attributes, the latter
with the allowed values of Top (the default), Middle
(approximately centered vertically), and Bottom.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>TGroup</EMPHASIS></TERM>
<LISTITEM>
<PARA>The part of a Table that is
contains an array along with its formatting information.
In order, a TGroup has any number of ColSpecs,
any number of SpanSpecs, an optional THead,
a required TBody,
and an optional TFoot.
Each TGroup effectively identifies a new
portion of a Table. If a new ColSpec is provided, it
replaces a previous one. If both ColSpec and SpanSpec
are new, that SpanSpec should refer to columns in the most
recent ColSpec. If only a new SpanSpec is provided, it
should refer to columns defined by the most immediately
prior ColSpecs in a TGroup of the
Table. On the other hand, a new ColSpec to
either a THead or TFoot replaces all prior column
definitions. TGroup has common, Align, Char, Charoff, Cols,
Colsep, Rowsep, and TGroupStyle attributes.
</PARA>
<PARA><EMPHASIS>Align</EMPHASIS> controls the horizontal position
of text within the column.
The value of Align may be Left (quad flush left),
Center (centered), Right (quad flush right),
Justify (both quad left and right), or Char (align to the
left of Char, positioned by Charoff). The default
is Left, unless overridden by TGroupStyle.
</PARA>
<PARA><EMPHASIS>Char</EMPHASIS> contributes to Align. If the
value of Align is &ldquo;char&rdquo;, the value of Char
should be a character on the first occurrance
of which the entry is to be aligned. If that
character does not occur in the entry, the entry
is is aligned to the left (the original doc incorrectly
specifies &ldquo;right&rdquo;) of that character.
The default is &ldquo;&rdquo;, unless inherited
from TGroupStyle.
</PARA>
<PARA><EMPHASIS>Charoff</EMPHASIS> contributes with Char to Align.
Charoff is the proportion
of the current column width, expressed in percentage,
to be allowed before the left edge of the first occurrence
of the character given as the value of Char, if any.
The default is 50 unless overridden by TGroupStyle.
</PARA>
<PARA><EMPHASIS>Cols</EMPHASIS> is the number of columns in the table
(required).
</PARA>
<PARA><EMPHASIS>Colsep</EMPHASIS>
determines column separators. If its value
is 1 (yes), display the internal column rulings to
the right of each item; if 0 (no), do not
display it. It is ignored for the last column, where the
value of Frame applies. There is no default. The
value is inherited from TGroupStyle, if used.
</PARA>
<PARA><EMPHASIS>Rowsep</EMPHASIS>
determines row separators. If its content is
1 (yes), display the internal vertical row ruling
below each item; if 0 (no), do not display it. It is
ignored for the last row of the table, where
the value of Frame applies. There is no default.
The value is inherited from TGroupStyle, if used.
</PARA>
<PARA><EMPHASIS>TGroupStyle</EMPHASIS> is a unique table group
style defined in a FOSI (no default).
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>THead</EMPHASIS></TERM>
<LISTITEM>
<PARA>THead is a optional part of TGroup
(part of Table). THead may have any
number of ColSpecs, followed by one or more required
Rows. It has common and VAlign attributes, the latter
with the allowed values of Top, Middle, and Bottom
(the default).
THead identifies the heading information in a Table,
which is displayed at the top of
the Table and again at the top of any continuation after a
page break between Rows in TBody.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Tip</EMPHASIS></TERM>
<LISTITEM>
<PARA>A suggestion to the user, set off from
the text. See <EMPHASIS>Caution.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Title</EMPHASIS></TERM>
<LISTITEM>
<PARA>The text of a heading or the title of a
block-oriented element. Title may contain
in-line elements, and has common and PageNum attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>TitleAbbrev</TERM>
<LISTITEM>
<PARA>An optional, abbreviated
version of any Title.
You may want to use this element when a
title is so long that it might be truncated in
some part of an online display, such as a title bar.
TitleAbbrev may contain
in-line elements and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>ToC</EMPHASIS></TERM>
<LISTITEM>
<PARA>A Table of Contents, which may be
a book component on its own or may
occur within other book components. It may
have a DocInfo, Title, and TitleAbbrev.
ToC
is subdivided to follow the divisions of a book:
following the optional Title and
TitleAbbrev, a ToC may have any number of ToCFronts, which
are the entries for the front matter. Following the
ToCFronts, if any, ToC
must have either
one or more ToCParts (entries for Parts)
or ToCChaps (entries for Chapters and Appendices),
and may have any number of ToCBacks
(entries for back matter).
A ToCPart must begin with one or more ToCEntries,
then contains
any number of ToCChaps. A ToCChap
must begin with one or more ToCEntries,
then may have any number of ToCLevel1s,
which are entries for Sect1s.
ToCLevel1s must begin with one or more ToCEntries,
then may have
any number of ToCLevel2s, and so on down to ToCLevel5,
which may have only ToCEntries. Thus if you have a
Table of Contents that shows section headings, the second-level entries
are nested within the first-level entries, and so on.
ToC has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>ToCBack</EMPHASIS></TERM>
<LISTITEM>
<PARA>Entry for back matter in a ToC.
See <EMPHASIS>ToC.</EMPHASIS>
It has common, Pagenum, and Label attributes.
The Label attribute might take the value of Bib, Gloss, or
Index, depending on the identity of the
piece of front matter concerned, but these are not
defined.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>ToCChap</EMPHASIS></TERM>
<LISTITEM>
<PARA>See <EMPHASIS>ToC.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>ToCEntry</EMPHASIS></TERM>
<LISTITEM>
<PARA>Component of other ToC elements.
See <EMPHASIS>ToC.</EMPHASIS>
It has common, Linkend, and Pagenum attributes.
PageNum is for indicating the page numbers on which
the Table of Contents entries appear in a printed book. Linkend,
should you choose to use it,
should have the value of the ID of the relevant book part.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>ToCFront</EMPHASIS></TERM>
<LISTITEM>
<PARA>Entry for introductory matter in a ToC.
See <EMPHASIS>ToC.</EMPHASIS>
It has common, Pagenum, and Label attributes.
The Label attribute might take the value of Equations, Examples,
Figures, Preface, or Tables, depending on the identity of the
piece of front matter concerned, but these are not defined.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>ToCLevel1</EMPHASIS></TERM>
<LISTITEM>
<PARA>The top-level tag for entries within a ToCChap.
See <EMPHASIS>ToCChap.</EMPHASIS>
ToCLevel2&ndash;5 may be nested within it, in order. All
have common attributes.
Aside from nested ToCLevels, ToCLevel1&ndash;5
must contain one or more ToCEntries.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>ToCPart</EMPHASIS></TERM>
<LISTITEM>
<PARA>See <EMPHASIS>ToC.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Token</TERM>
<LISTITEM>
<PARA>A unit of information in the context of
lexical analysis. It contains plain text and
has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Trademark</TERM>
<LISTITEM>
<PARA>A trademark.
It may contain members of cptrphrase.gp,
and has common and Class attributes.
Class may have the values Service, Trade, Registered,
or Copyright; the default is Trade.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Type</TERM>
<LISTITEM>
<PARA>Indicates the classification of a value.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>ULink</TERM>
<LISTITEM>
<PARA>A link employing a URL. ULink may contain
in-line elements.
A URL is a Uniform Resource Locator, as used with the
World Wide Web. Very generally,
a URL is a string specifying, according to a defined
protocol, a method,
a path to a target, and possibly some additional information.
The URL should be given as the value
of the URL attribute; there is also a Type attribute,
to which you may assign any value.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>UserInput</TERM>
<LISTITEM>
<PARA>Data entered by the user.
It may contain elements from cptrphrase.gp,
and has common and
MoreInfo attributes. For the MoreInfo attribute
see <EMPHASIS>Application.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>VarArgs</TERM>
<LISTITEM>
<PARA>An empty element, part of FuncSynopsis,
indicating that the Function in question
has a variable number of arguments. The string
&ldquo;(...)&rdquo; should be output.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>VariableList</EMPHASIS></TERM>
<LISTITEM>
<PARA>An optionally
titled list of VarListEntries, which are
composed of sets of one or more Terms with associated
ListItems; ListItems contain paragraphs and other block-oriented
elements in any order. Inclusions
are as for OrderedList (see <EMPHASIS>OrderedList</EMPHASIS>).
VariableList has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>VarListEntry</EMPHASIS></TERM>
<LISTITEM>
<PARA>A component of VariableList (see <EMPHASIS>VariableList</EMPHASIS>). It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Void</TERM>
<LISTITEM>
<PARA>An empty element, part of FuncSynopsis,
that indicates that the Function in question
takes no arguments. The string &ldquo;(void)&rdquo;
should be output. See <EMPHASIS>VarArgs.</EMPHASIS>
It has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>VolumeNum</TERM>
<LISTITEM>
<PARA>The number of a Book in
relation to Set, or of a journal, when Book
is used to represent a journal by containing
Articles. It contains plain text
and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM><EMPHASIS>Warning</EMPHASIS></TERM>
<LISTITEM>
<PARA>An admonition set off from the text.
See <EMPHASIS>Caution.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>WordAsWord</TERM>
<LISTITEM>
<PARA>A word (or letter or
number) used not to represent the thing or idea it usually
represents, but merely as the word itself. For example,
&ldquo;The term <SGMLTAG>WORDASWORD</SGMLTAG>Gothic<SGMLTAG>/WORDASWORD</SGMLTAG> means different
things to art historians and typographers,&rdquo; or for a single
character, &ldquo;the
letter <SGMLTAG>WORDASWORD</SGMLTAG>X<SGMLTAG>/WORDASWORD</SGMLTAG>&rdquo;.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>XRef</TERM>
<LISTITEM>
<PARA>Cross reference link to another part of the
document.
It has Linkend and Endterm attributes, just like Link,
but like Anchor, it may have no content.
XRef must have a Linkend, but the Endterm is optional.
If it is used, the content of the element it points
to is displayed as the text of the cross reference;
if it is absent, the XRefLabel of the cross-referenced
object is displayed. XRef also has common attributes.
See <EMPHASIS>Link.</EMPHASIS>
</PARA></LISTITEM></VARLISTENTRY>
<VARLISTENTRY><TERM>Year</TERM>
<LISTITEM>
<PARA>Year of publication, for use in Copyright.
It contains plain text and has common attributes.
</PARA></LISTITEM></VARLISTENTRY>
</VARIABLELIST>
</SECT1>
</chapter>
</book>
Reference in New Issue View Git Blame Copy Permalink