By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM
DocBook: The Definitive Guide
Prev
Next
Name
RevHistory -- A history of the revisions to a document
Synopsis
Content Model
RevHistory ::= (Revision+)
Attributes
Common attributes
Tag Minimization
Both the start- and end-tags are required for this element.
Parameter Entities
%bibliocomponent.mix;
%docinfo.char.class;
%ndxterm.char.mix;
%para.char.mix;
%programlisting.content;
%refinline.char.mix;
%screen.content;
%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 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.
Future Changes