The tags covered in this section are listed below.
BookInfo - Metainformation for a Book |
Title - Text of a heading or the title of a block-oriented element |
AuthorGroup - Wrapper for Author information |
Author - Author of a document |
AuthorInitials - Initials or other identifier for the author of a Revision or Comment |
FirstName - Given name |
OtherName - Name component that is not a Firstname, Surname, or Lineage |
Surname - Family name |
KeywordSet - Set of terms describing the content of a document |
Keyword - Term describing the content of a document |
ReleaseInfo - Information about a particular version of a document |
RevHistory - Revisions to a document |
Revision - Entry in RevHistory, describing some revision made to the text |
RevNumber - Number of a Revision |
RevRemark - Description of a Revision |
Abstract - Document summary |
Date - Date of publication or revision of a document |
Example 3-2. Example of DocBook Headers
<bookinfo> <title>The Kapp Handbook</title> <authorgroup> <author> <firstname>George</firstname> <othername>N.</othername> <surname>Ugnacious</surname> </author> </authorgroup> <keywordset> <keyword>KDE application</keyword> </keywordset> <releaseinfo>1.1.0</releaseinfo> <date>03/04/1999</date> <revhistory> <revision> <revnumber>1.0 </revnumber> <date>3.4.1999</date> <authorinitials>G.N.U.</authorinitials> <revremark>Initial release. </revremark> </revision> </revhistory> <abstract> <para> Kapp is an application specially designed to do nothing you would ever want. </para> </abstract> </bookinfo> |
The <BookInfo> tag contains all of the meta information for your document. In most cases the examples in the template should provide all of the tags you need to describe the content of your document. Most of the tags are fairly self-explanatory, but there are a few important details that need to be addressed:
You should always provide the <ReleaseInfo> and the <Date> tags. This is very important at KDE for translation update management. Please use alwayse the same format for the date (DD/MM/YYYY) and for the version (major.minor.lesser).
<RevHistory>, <ReleaseInfo> and <Date> contain the revision history of the documentation, not of the application. Of course, nothings prevents you from using the same revision numbers for both the application and the documentation.