DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

Article

Name

Article -- An article

Synopsis

Content Model

Article ::=
((Title,Subtitle?,TitleAbbrev?)?,
 ArtHeader?,ToCchap?,LoT*,
 (((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+)),
 ((ToC|LoT|Index|Glossary|Bibliography)|
  (Appendix)|
  Ackno)*)

Attributes

Common attributes

Name

Type

Default

StatusCDATANone
ParentBookIDREFNone
Class

Enumeration:

FAQ
JournalArticle
ProductSheet
TechReport
WhitePaper

None

Tag Minimization

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

Parameter Entities

%article.class;%partcontent.mix;

Description

The Article element is a general-purpose container for articles. The content model is both quite complex and rather loose in order to accommodate the wide range of possible Article structures. Although changes to the Article element have been discussed on several occasions, no better model has been presented.

An Article is composed of a header and a body. The body may include a table of contents and multiple lists of tables, figures, and so on, before the main text of the article and may include a number of common end-matter components at the end.

Processing expectations

Formatted as a displayed block. Frequently causes a forced page break in print media. May be numbered separately and presented in the table of contents.

(4.0) Future Changes

The ToC element in the content model may be replaced by TocChap. This change may be delayed if the DocBook technical committee decides to review the whole ToC/LoT apparatus.

Parents

These elements contain Article: Book, Part.

Children

The following elements occur in Article: Abstract, Ackno, Address, Anchor, Appendix, ArtHeader, AuthorBlurb, Bibliography, BlockQuote, BridgeHead, CalloutList, Caution, CmdSynopsis, Comment, Epigraph, Equation, Example, Figure, FormalPara, FuncSynopsis, Glossary, GlossList, Graphic, GraphicCO, Highlights, Important, Index, IndexTerm, InformalEquation, InformalExample, InformalFigure, InformalTable, ItemizedList, LiteralLayout, LoT, 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, ToC, ToCchap, VariableList, Warning.

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

Attributes

Class

Class identifies the type of article.

ParentBook

ParentBook holds the ID of an enclosing Book, if applicable.

Status

Status identifies the editorial or publication status of the Article.

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

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

Examples

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<article>
<artheader>
  <author><firstname>Norman</><surname>Walsh</></author>
  <authorinitials>ndw</authorinitials>
  <artpagenums>339-343</artpagenums>
  <volumenum>15</volumenum>
  <issuenum>3</issuenum>
  <publisher><publishername>The TeX User's Group</publishername></publisher>
  <pubdate>1994</pubdate>
  <title>A World Wide Web Interface to CTAN</title>
  <titleabbrev>CTAN-Web</titleabbrev>
  <revhistory>
     <revision>
        <revnumber>1.0</revnumber>
        <date>28 Mar 1994</date>
        <revremark>Submitted.</revremark>
     </revision>
     <revision>
        <revnumber>0.5</revnumber>
        <date>15 Feb 1994</date>
        <revremark>First draft for review.</revremark>
     </revision>
  </revhistory>
</artheader>
<para>
The body of the article &hellip;
</para>
</article>

For additional examples, see also Ackno, ContractSponsor, QandASet.

PrevHomeNext
ArtHeaderUpArtPageNums

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