revhistory

revhistory — A history of the revisions to a document

Synopsis

revhistory ::=

Sequence of:
- One of:
  - Sequence of:
    
    Interleave of:
    
    title?
    
    titleabbrev?
    
    info? (db.titleforbidden.info)
  - info (db.titleonly.info)
- One or more of:
  - revision

Attributes

Common attributes and common linking attributes.

Description

A 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

Parents

These elements contain revhistory: acknowledgements, annotation, answer, appendix, article, bibliodiv, biblioentry, bibliography, bibliolist, bibliomixed, bibliomset, biblioset, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, colophon, constraintdef, cover, dedication, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, html:fieldset, html:form, important, index, indexdiv, info (db.info), info (db.titleforbidden.info), info (db.titleonly.info), info (db.titleonlyreq.info), info (db.titlereq.info), informalexample, informalfigure, itemizedlist, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, variablelist, warning.

Children

The following elements occur in revhistory: info (db.titleforbidden.info), info (db.titleonly.info), revision, title, titleabbrev.

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example revhistory</title>

<revhistory>

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

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

</revhistory>

</article>

Revision History
Revision 0.91	1996-12-11	ndw
Bug fixes
Revision 0.90	1996-11-30	ndw
First beta release

ChangeLog

This alpha reference page is $Revision: 7120 $ published Sun, 22 Jul 2007.


revdescription		revision