revhistory
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# revhistory

## Name

revhistory — A history of the revisions to a document

##

# Synopsis

### Content Model

    revhistory ::=
    (revision+)

### Attributes

Common attributes

### Parameter Entities

The following parameter entities contain revhistory:

Parameter Entities
`%bibliocomponent.mix;` | `%docinfo.char.class;` | `%ndxterm.char.mix;`
`%para.char.mix;` | `%refinline.char.mix;` | `%tbl.entry.mdl;`
`%title.char.mix;` |  |

## Description

`RevHistory` is a structure for documenting a history of changes, specifically, a history of changes to the document or section in which it occurs.

### Processing expectations

Formatted as a displayed block. A tabular or list presentation is most common.

### Future Changes

Due to a parameterization oversight in the DTD, `RevHistory` is allowed in some outlandish places. Still, it is not an inline, so it should not be used inside `LineAnnotation`s, `Link`s, or `Quote`s. (Not to mention the truly outlandish places like `Title` and `SeeAlso`!)

In a future version of DocBook, `RevHistory` will be removed from these inline contexts.

The original intent for `RevHistory` was simply to document the history of changes to the document that contains it. In keeping with this meaning, you are advised to limit its use to places where bibliographic meta-information is allowed (the ‘info’ elements).

One can argue that `RevHistory` has broader applicability for documenting changes to other systems as well, and in light of this, it may become available in more contexts, but that has not yet been decided.

### Parents

These elements contain revhistory: `appendixinfo`, `application`, `articleinfo`, `attribution`, `biblioentry`, `bibliographyinfo`, `bibliomisc`, `bibliomixed`, `bibliomset`, `biblioset`, `bookinfo`, `bridgehead`, `chapterinfo`, `citation`, `citetitle`, `emphasis`, `entry`, `foreignphrase`, `glossaryinfo`, `glossentry`, `glosssee`, `glossseealso`, `glossterm`, `indexinfo`, `lineannotation`, `link`, `literallayout`, `lotentry`, `member`, `msgaud`, `objectinfo`, `olink`, `para`, `partinfo`, `phrase`, `prefaceinfo`, `primary`, `primaryie`, `productname`, `programlisting`, `qandaentry`, `quote`, `refentryinfo`, `refentrytitle`, `referenceinfo`, `refpurpose`, `refsect1info`, `refsect2info`, `refsect3info`, `refsynopsisdivinfo`, `remark`, `screen`, `screeninfo`, `secondary`, `secondaryie`, `sect1info`, `sect2info`, `sect3info`, `sect4info`, `sect5info`, `sectioninfo`, `see`, `seealso`, `seealsoie`, `seeie`, `seg`, `segtitle`, `setindexinfo`, `setinfo`, `sidebarinfo`, `simpara`, `subtitle`, `synopsis`, `term`, `tertiary`, `tertiaryie`, `title`, `titleabbrev`, `tocback`, `tocentry`, `tocfront`, `ulink`.

### Children

The following elements occur in revhistory: `revision`.

## See Also

`date`, `edition`, `printhistory`, `pubdate`, `releaseinfo`.

## Examples

    <!DOCTYPE revhistory PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
              "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    <revhistory>

    <revision>
      <revnumber>0.91</revnumber>
      <date>11 Dec 1996</date>
      <authorinitials>ndw</authorinitials>
      <revremark>Bug fixes</revremark>
    </revision>

    <revision>
      <revnumber>0.90</revnumber>
      <date>30 Nov 1996</date>
      <authorinitials>ndw</authorinitials>
      <revremark>First beta release</revremark>
    </revision>

    </revhistory>

For additional examples, see also `article` .

Prev | Home | Next
revdescription | Up | revision

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