Difference between revisions of "OOPM:Development:Documentation:HowTos:WikiVersioning"

Revision as of 19:47, 16 April 2009

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 page name, for example [[FooBar:1.0]].

Instantiating a New Versioned Wiki Resource

TBD

Instantiating a New Version From an Existing Versioned Wiki Resource

TBD