Most of our documents are closely tied to individual software products, and display the software version prominently in the subtitle. In addition to this, each document has its own revision number, which can be found at the end of the front matter in PDF documents.

The document revision number is made up of the current software version number, followed by a dash, followed by an integer. For example, the Cascade Connect document revision number looks like this:

3.4-1

In this number,3.4 is the software version number, and 1 represents the first revision of the document for that version of the software.

For easy access and editing, these numbers are maintained as entities in the doc/i/common/entities.sgml file, under the headings Software Version numbers and Document Revision numbers. To keep things simple, each revision number in this file is the single revision digit, stored separately from the software version number. (They are joined together in the SGML output.) Here are what the version and revision entities for the Cascade Connect manual look like:

<!-- Software Version numbers -->
...
<!entity vsn-cc-book "3.4">
...


<!-- Document Revision numbers -->
...
<!entity rev-cc-book "1">
...

Making an update