DocBook: The Definitive Guide

docbook: the definitive guide
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
PrevNext

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.

(5.0) 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: Application, ArtHeader, Attribution, BiblioEntry, BiblioMisc, BiblioMixed, BiblioMSet, BiblioSet, BookBiblio, BookInfo, BridgeHead, Citation, CiteTitle, Comment, DocInfo, Emphasis, entry, ForeignPhrase, GlossEntry, GlossSee, GlossSeeAlso, GlossTerm, LineAnnotation, Link, LiteralLayout, LoTentry, Member, MsgAud, ObjectInfo, OLink, Para, Phrase, Primary, PrimaryIE, ProductName, ProgramListing, Quote, RefEntryTitle, RefPurpose, RefSect1Info, RefSect2Info, RefSect3Info, RefSynopsisDivInfo, Screen, ScreenInfo, Secondary, SecondaryIE, Sect1Info, Sect2Info, Sect3Info, Sect4Info, Sect5Info, SectionInfo, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, SeriesInfo, SetInfo, SimPara, Subtitle, Synopsis, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, ULink.

Children

The following elements occur in RevHistory: Revision.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

See Also

Date, Edition, PrintHistory, PubDate, ReleaseInfo

Examples

<!DOCTYPE revhistory PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <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.


PrevHomeNext
ReturnValueUpRevision

Back to: DocBook: The Definitive Guide


O'Reilly Home | O'Reilly Bookstores | How to Order | O'Reilly Contacts
International | About O'Reilly | Affiliated Companies

© 1999, O'Reilly & Associates, Inc.



DocBook. The Definitive Guide
DocBook 5: The Definitive Guide
ISBN: 0596805020
EAN: 2147483647
Year: 1999
Pages: 412
Authors: Walsh Norman, Richard L. Hamilton
BUY ON AMAZON

Similar book on Amazon
DocBook XSL: The Complete Guide (4th Edition)
DocBook XSL: The Complete Guide (4th Edition)
XSLT, 2nd Edition
XSLT, 2nd Edition
XSLT Cookbook: Solutions and Examples for XML and XSLT Developers, 2nd Edition
XSLT Cookbook: Solutions and Examples for XML and XSLT Developers, 2nd Edition
XML: Visual QuickStart Guide (2nd Edition)
XML: Visual QuickStart Guide (2nd Edition)

flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net