appendix
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# appendix

appendix — An appendix in a `Book` or `Article`

## Synopsis

### Content Model

    appendix ::=
    (beginpage?,appendixinfo?,
     (title,subtitle?,titleabbrev?),
     (toc|lot|index|glossary|bibliography)*,
     tocchap?,
     (((calloutlist|glosslist|itemizedlist|orderedlist|segmentedlist|
        simplelist|variablelist|caution|important|note|tip|warning|
        literallayout|programlisting|programlistingco|screen|screenco|
        screenshot|synopsis|cmdsynopsis|funcsynopsis|classsynopsis|
        fieldsynopsis|constructorsynopsis|destructorsynopsis|
        methodsynopsis|formalpara|para|simpara|address|blockquote|
        graphic|graphicco|mediaobject|mediaobjectco|informalequation|
        informalexample|informalfigure|informaltable|equation|example|
        figure|table|msgset|procedure|sidebar|qandaset|productionset|
        constraintdef|anchor|bridgehead|remark|highlights|abstract|
        authorblurb|epigraph|indexterm|beginpage)+,
       (sect1*|
        (refentry)*|
        simplesect*|
        (section)*))|
      (sect1+|
       (refentry)+|
       simplesect+|
       (section)+)),
     (toc|lot|index|glossary|bibliography)*)

### Attributes

Common attributes

Name | Type | Default
status | CDATA | None
label | CDATA | None

## 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`, `appendixinfo`, `authorblurb`, `beginpage`, `bibliography`, `blockquote`, `bridgehead`, `calloutlist`, `caution`, `classsynopsis`, `cmdsynopsis`, `constraintdef`, `constructorsynopsis`, `destructorsynopsis`, `epigraph`, `equation`, `example`, `fieldsynopsis`, `figure`, `formalpara`, `funcsynopsis`, `glossary`, `glosslist`, `graphic`, `graphicco`, `highlights`, `important`, `index`, `indexterm`, `informalequation`, `informalexample`, `informalfigure`, `informaltable`, `itemizedlist`, `literallayout`, `lot`, `mediaobject`, `mediaobjectco`, `methodsynopsis`, `msgset`, `note`, `orderedlist`, `para`, `procedure`, `productionset`, `programlisting`, `programlistingco`, `qandaset`, `refentry`, `remark`, `screen`, `screenco`, `screenshot`, `sect1`, `section`, `segmentedlist`, `sidebar`, `simpara`, `simplelist`, `simplesect`, `subtitle`, `synopsis`, `table`, `tip`, `title`, `titleabbrev`, `toc`, `tocchap`, `variablelist`, `warning`.

## 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 XML V4.1.2//EN"
              "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    <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 | appendixinfo

Copyright© 1999, 2000, 2001 O'Reilly & Associates, Inc. All rights reserved.