revhistory

$Revision: 1.5 $

$Date: 2002/06/12 11:18:33 $

revhistory — A history of the revisions to a document

Synopsis

Content Model

revhistory ::=
(revision+)

Attributes

Common attributes

DocBook NG “Bourbon” Content Model

revhistory ::=

Sequence of:

One of:

Sequence of:

Interleave of:

title?
titleabbrev?

info? (db.info.titleforbidden)

info (db.info.titleonly)

One or more of:

revision

DocBook NG “Bourbon” Attributes

Common attributes and common linking attributes.

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.

DocBook does not mandate an order for revisions: ascending order by date, descending order by date, and orders based on some other criteria are all equally acceptable.

Processing expectations

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

The order of revisions within a revhistory (ascending or descending date order, for example) is not mandated by DocBook

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 LineAnnotations, Links, or Quotes. (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, blockinfo, bookinfo, bridgehead, chapterinfo, citation, citetitle, emphasis, entry, firstterm, 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, refsectioninfo, refsynopsisdivinfo, remark, screen, screeninfo, secondary, secondaryie, sect1info, sect2info, sect3info, sect4info, sect5info, sectioninfo, see, seealso, seealsoie, seeie, seg, segtitle, setindexinfo, setinfo, sidebarinfo, simpara, subtitle, synopsis, td, term, tertiary, tertiaryie, th, title, titleabbrev, tocback, tocentry, tocfront, ulink.

Children

The following elements occur in revhistory: revision.

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.


revdescription		revision