revhistory

revhistory — A history of the revisions to a document.

Synopsis

revhistory ::=

Attributes

Common attributes and common linking attributes.

No additional attributes.

Additional Constraints

  • If this element is the root element, it must have a version attribute.

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 (e.g., ascending or descending date order) is not mandated by DocBook.

Attributes

Common attributes and common linking attributes.

any attribute

Any attribute in any other explicit namespace

Parents

These elements contain revhistory: abstract, acknowledgements, annotation, answer, appendix, article, bibliodiv, biblioentry, bibliography, bibliolist, bibliomixed, bibliomset, biblioset, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, colophon, constraintdef, cover, danger, dedication, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, 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, merge, meta (db.meta.content), msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, result, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, structure, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, topic, variablelist, warning.

Children

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

See Also

Related elements: date, edition, printhistory, pubdate, releaseinfo.

Examples

 1 |<article xmlns='http://docbook.org/ns/docbook'>
   |<title>Example revhistory</title>
   | 
   |<revhistory>
 5 | 
   |<revision>
   |  <revnumber>0.91</revnumber>
   |  <date>1996-12-11</date>
   |  <authorinitials>ndw</authorinitials>
10 |  <revremark>Bug fixes</revremark>
   |</revision>
   | 
   |<revision>
   |  <revnumber>0.90</revnumber>
15 |  <date>1996-11-30</date>
   |  <authorinitials>ndw</authorinitials>
   |  <revremark>First beta release</revremark>
   |</revision>
   | 
20 |</revhistory>
   | 
   |</article>
Revision History
0.9111 Dec 1996ndw

Bug fixes

0.9030 Nov 1996ndw

First beta release