OOPM:Development:Documentation:HowTos:WikiVersioning
Contents
HowTo: Versioning Wiki Resources
Introduction
TBD information on why to use versioning and why not to simply fall back to revisioning, information on how wiki resources will be versioned using a simple version identifier consisting of a release number and a version number, with the wiki taking over the responsibility for handling revisioning. CONSIDER whether wiki resources require a version state, e.g. draft during the inception phase, or whether that state information is purely informational and not part of the actual release version number.
The following wiki resources must be versioned in order for us to backtrack our work not only by the MediaWiki provided revisioning facility, but also by being able to navigate directly to past versions of all of our resources, for example articles, aka single/multi page documents or article fragments, imagery/illustrations, or templates etc.
- Articles
- Article Fragments
- Media
- Templates
What will not be versioned are the following (special) resources offered by MediaWiki:
- Categories
- User Pages
- Discussion Pages
- Discussion Archive Pages
- FAQs, HowTos
- Media included with the above User Pages, Discussion (Archive) Pages, FAQs, or, HowTos
Versioning Wiki Resources
Release Version Identifier
The release version identifier being used with the individual wiki resources for which we will apply our versioning scheme, is defined as follows
ReleaseVersionIdentifier ::= ReleaseNumber '.' VersionNumber
The identifier is an inherent part of the wiki page name.
Examples
- [[FooBar:1.0]], where version 1.0 of the FooBar document resides in the global namespace
- [[FooBar:1.1]], same as above but version 1.1
- [[OOPM:Development:Documentation:Requirements Analysis:1.0]], where version 1.0 of the RA document resides in the namespace OOPM:Development:Documentation:Requirements Analysis
Instantiating a New Versioned Wiki Resource
In order to create a new versioned document, you will have to either edit an existing page, insert the wiki page link and use the preview function, so that you then may go and create the referenced wiki page.
You may also use your personal page or the discussion page thereof for starting up new pages in the wiki.
Instantiating a New Version From an Existing Versioned Wiki Resource
TBD
