revhistory

revhistory — A history of the revisions to a document.

Synopsis

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

Parents

This element occurs in 82 elements.

Children

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

Examples

  1 <article xmlns='http://docbook.org/ns/docbook'>
  2 <title>Example revhistory</title>
    
  4 <revhistory>
    
  6 <revision>
      <revnumber>0.91</revnumber>
  8   <date>1996-12-11</date>
      <authorinitials>ndw</authorinitials>
 10   <revremark>Bug fixes</revremark>
    </revision>
 12 
    <revision>
 14   <revnumber>0.90</revnumber>
      <date>1996-11-30</date>
 16   <authorinitials>ndw</authorinitials>
      <revremark>First beta release</revremark>
 18 </revision>
    
 20 </revhistory>
    
 22 </article>

Revision History
0.91	11 Dec 1996	ndw	Bug fixes
0.90	30 Nov 1996	ndw	First beta release


revdescription		revision