article
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# article

## Name

article — An article

##

# Synopsis

### Content Model

    article ::=
    ((title,subtitle?,titleabbrev?)?,
     articleinfo?,tocchap?,lot*,
     (((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)|
      (appendix)|
      ackno)*)

### Attributes

Common attributes

Name | Type | Default
status | CDATA | None
parentbook | IDREF | None
class | Enumeration:
faq
journalarticle
productsheet
specification
techreport
whitepaper
| None

### Parameter Entities

The following parameter entities contain article:

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.

### 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`, `articleinfo`, `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

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 XML V4.1.2//EN"
              "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    <article>
    <articleinfo>
      <author><firstname>Norman</firstname><surname>Walsh</surname></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>
    </articleinfo>
    <para>
    The body of the article &hellip;
    </para>
    </article>

For additional examples, see also `ackno`, `contractsponsor`, `qandaset` .

Prev | Home | Next
arg | Up | articleinfo

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