DocBook: The Definitive Guide By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide
Prev		Next

---

Appendix

Name

Appendix -- An appendix in a Book or Article

Synopsis

Content Model

Appendix ::=
((DocInfo?,Title,Subtitle?,TitleAbbrev?),
 ToCchap?,
 (((CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList|
    SimpleList|VariableList|Caution|Important|Note|Tip|Warning|
    LiteralLayout|ProgramListing|ProgramListingCO|Screen|ScreenCO|
    ScreenShot|Synopsis|CmdSynopsis|FuncSynopsis|FormalPara|Para|
    SimPara|Address|BlockQuote|Graphic|GraphicCO|MediaObject|
    MediaObjectCO|InformalEquation|InformalExample|InformalFigure|
    InformalTable|Equation|Example|Figure|Table|MsgSet|Procedure|
    Sidebar|QandASet|Anchor|BridgeHead|Comment|Highlights|
    Abstract|AuthorBlurb|Epigraph|IndexTerm)+,
   (Sect1*|
    (RefEntry)*|
    SimpleSect*|Section*))|
  (Sect1+|
   (RefEntry)+|
   SimpleSect+|Section+)))

Attributes

Common attributes

Name	Type	Default
Label	CDATA	None
Status	CDATA	None

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

Parameter Entities

%appendix.class;

%partcontent.mix;

Description

Appendixes usually occur at the end of a document.

Processing expectations

Formatted as a displayed block. Usually introduces a forced page break and often starts on the next recto page. Sometimes restarts page numbering. Typically, appendixes are lettered rather than numbered, and appear in the table of contents.

Parents

These elements contain Appendix: Article, Book, Part.

Children

The following elements occur in Appendix: Abstract, Address, Anchor, AuthorBlurb, BlockQuote, BridgeHead, CalloutList, Caution, CmdSynopsis, Comment, DocInfo, Epigraph, Equation, Example, Figure, FormalPara, FuncSynopsis, GlossList, Graphic, GraphicCO, Highlights, Important, IndexTerm, InformalEquation, InformalExample, InformalFigure, InformalTable, ItemizedList, LiteralLayout, MediaObject, MediaObjectCO, MsgSet, Note, OrderedList, Para, Procedure, ProgramListing, ProgramListingCO, QandASet, RefEntry, Screen, ScreenCO, ScreenShot, Sect1, Section, SegmentedList, Sidebar, SimPara, SimpleList, SimpleSect, Subtitle, Synopsis, Table, Tip, Title, TitleAbbrev, ToCchap, VariableList, Warning.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

Attributes

Label

Label specifies an identifying string for presentation purposes. The second Appendix might be labeled "B", for example.

Generally, an explicit Label attribute is used only if the processing system is incapable of generating the label automatically. If present, the Label is normative; it will used even if the processing system is capable of automatic labelling.

Status

Status identifies the editorial or publication status of the Appendix.

Publication status might be used to control formatting (for example, printing a "draft" watermark on drafts) or processing (perhaps a document with a status of "final" should not include any components that are not final).

See Also

Article, Book, Chapter, Colophon, Dedication, Part, PartIntro, Preface, Set

Examples

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<book>
<chapter><title>Required Chapter</title>
<para>
At least one chapter, reference, part, or article is required in a book.
</para>
</chapter>
<appendix><title>Demonstration Appendix</title>
<para>
This appendix demonstrates an appendix in a book.  It has the
same broad content model as a chapter.
</para>
</appendix>
</book>

For additional examples, see also Book.

---

Prev	Home	Next
Answer	Up	Application

Back to: DocBook: The Definitive Guide