Search the Catalog
DocBook: The Definitive Guide

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

%*.class; Parameter Entities

Name

%*.class; Parameter Entities -- Parameter entities which define the DocBook classes

Synopsis

Classes group elements of a similar type, for example all the lists are in the %list.class;

If you want to add a new kind of something (a new kind of list or a new kind of verbatim environment, for example), you generally want to add the name of the new element to the appropriate class.

Description

The following classes are defined in DocBook:

%admon.class;

Elements which are admonitions.

  Caution | Important | Note | Tip | Warning
%appendix.class;

Elements which are appendixes.

  Appendix 
%article.class;

Elements which are articles.

  Article 
%base.char.class;

Elements which are in the base character class. These elements are part of every character class.

  Anchor 
%book.class;

Elements which are books.

  Book 
%chapter.class;

Elements which are chapters.

  Chapter 
%compound.class;

Elements which are compound objects (objects with internal structure).

  MsgSet | Procedure | Sidebar
%descobj.class;

Elements which are descriptive in nature.

  Abstract | AuthorBlurb | Epigraph
%docinfo.char.class;

Elements which provide information about a document. (Not to be confused with elements which are part of the DocInfo element.) While %docinfo.char.class; is part of the content model of DocInfo, it has nothing directly to do with the similarity of their names.)

  Author | AuthorInitials | CorpAuthor | ModeSpec
  | OtherCredit | ProductName | ProductNumber
  | RevHistory
%formal.class;

Formal objects (objects with titles).

  Equation | Example | Figure | Table
%gen.char.class;

The class of general inline elements.

  Abbrev | Acronym | Citation | CiteRefEntry | CiteTitle
  | Emphasis | FirstTerm | ForeignPhrase | GlossTerm
  | Footnote | Phrase | Quote | Trademark
  | WordAsWord
%genobj.class;

The general class of objects.

  Anchor | BridgeHead | Comment | Highlights
%index.class;

Elements which are indexes.

  Index | SetIndex
%informal.class;

Elements which are informal objects.

  Address | BlockQuote | Graphic | GraphicCO
  | InformalEquation | InformalExample
  | InformalTable
%inlineobj.char.class;

Elements which are inline objects.

  InlineGraphic | InlineEquation
%linespecific.class;

Elements which are "line specific". Spaces and line breaks are significant in line specific elements.

  LiteralLayout | ProgramListing | ProgramListingCO
  | Screen | ScreenCO
  | ScreenShot
%link.char.class;

Elements which are hyperlinks.

  Link | OLink | ULink
%list.class;

Elements which are lists.

  CalloutList | GlossList | ItemizedList | OrderedList
  | SegmentedList | SimpleList
  | VariableList
%nav.class;

Elements which provide navigational information about a document (tables of contents, indexes, etc.).

  ToC | LoT | Index | Glossary | Bibliography
%ndxterm.class;

Elements which are index terms.

  IndexTerm 
%notation.class;

The notations defined by DocBookk.

  BMP | CGM-CHAR | CGM-BINARY | CGM-CLEAR | DITROFF | DVI | EPS
  | EQN | FAX | GIF | GIF87a | GIF89a | IGES | PCX | PIC | PS | SGML
  | TBL | TEX | TIFF | WMF | WPG
  | linespecific
%other.char.class;

The other character classes (inline elements which don't obviously fall into one of the other classes).

  Comment | Subscript | Superscript
%otherinfo.class;
  DocInfo | Sect1Info | Sect2Info | Sect3Info | Sect4Info
  | Sect5Info | RefSect1Info | RefSect2Info | RefSect3Info
  | Refsect2Info
%para.class;
  FormalPara | Para | SimPara
%refentry.class;
  RefEntry 
%synop.class;
  Synopsis | CmdSynopsis | FuncSynopsis
%tech.char.class;
  Action | Application | ClassName | Command
  | ComputerOutput | Database | Email | EnVar | ErrorCode
  | ErrorName | ErrorType | Filename | Function | GUIButton
  | GUIIcon | GUILabel | GUIMenu | GUIMenuItem | GUISubmenu
  | Hardware | Interface | InterfaceDefinition | KeyCap
  | KeyCode | KeyCombo | KeySym | Literal | Markup | MediaLabel
  | MenuChoice | MouseButton | MsgText | Option | Optional
  | Parameter | Prompt | Property | Replaceable | ReturnValue
  | SGMLTag | StructField | StructName | Symbol | SystemItem
  | Token | Type
  | UserInput
%xref.char.class;
  FootnoteRef | XRef

Back to: DocBook: The Definitive Guide


oreilly.com Home | O'Reilly Bookstores | How to Order | O'Reilly Contacts
International | About O'Reilly | Affiliated Companies | Privacy Policy

© 2001, O'Reilly & Associates, Inc.