Power Feature: Versioning

Doco supports versioning in an unusual but useful way.

To start at the beginning, the directive for versioning is of the form

 // version <version> //

..where <version> is completely up to you, e.g. "1.0", "draft" etc.

For the purposes of this explanation, we will assume a document called "func_spec", with a version of "1.0". When a versioned source is processed by Doco, the following things happen:

• The original (func_spec.txt) is copied to func_spec_v1.0.txt in the source hierarchy. This means you have a copy of the 1.0 source when you move to a new version.
• This versioned source (func_spec_v1.0.txt) is copied across to the output hierarchy (in the usual manner).
• The outputs of the source document become versioned. The outputs for the example document source func_spec.txt may include:
• func_spec_v1.0.html (the vanilla output location, or the first page of a split document).
• func_spec_v1.0_<pageNumber>.html (for documents that have been split into pages).
• func_spec_v1.0_full.html (for the printable version of a page-split document).
• The vanilla output name (func_spec.html) will comprise a navigable table of versions, ordered by last-generated date.
• All non-versioned links to vanilla outputs will be repointed to their versioned equivalents.

It is worth noting that if a non-versioned document becomes versioned, any referring pages' links will thenceforce take you to a table of versions rather than the document itself (useful, as the referring document cannot know which version is pertinent to the viewer).