This server will be upgraded at 3pm Sydney time on December 3rd (December 2nd, 8pm PST) and will be down for up to 30 minutes.

UWC Page History Framework

Place to discuss and describe how to maintain page histories when converting wikis with the Universal Wiki Converter

Steps

If you want your converter module to handle page histories, here's what you need to do:

  1. Turn on the page history preservation switch in the converter properties
  2. Set a suffix in the converter properties which you will use to name your wiki files so they can be differentiated
  3. Make each version of a page have the contents of one page, and the filename using the defined suffix.

An Example

You have 3 files, each is a version of the same page. The page was most recently called PageHistoryTest. Each file contains the contents of one version.
The file that contains the contents of the first version is called:
PageHistoryTest-1.txt
The file that contains the second version is called:
PageHistoryTest-2.txt
The file that contains the third version is called:
PageHistoryTest-3.txt

In order to convert these into one Confluence page with the preserved history in the correct order, you would add these 2 properties to the wiki's converter.wiki.properties file. And you would add them at the beginning of the file.
Like so:

MyWiki.0001.switch.page-history-preservation=true
MyWiki.0002.suffix.page-history-preservation=-#.txt
Must be at the beginning

You must add the page history preservation properties to the beginning of the properties file before anything else.

The Suffix

The suffix has to have a numerical component so that the pages can be sorted correctly. In order to indicate that in your suffix you use the "#" symbol. Examples:

  • -#.txt
  • -v#

Modules that currently use this framework

The Tikiwiki Module uses this framework.

What happens if two versions have the same content?

So, if you have two versions of a page in two files, and they are "next to each other" in the sort order, and their content is the same, then they will not be considered different versions by Confluence.
For example,
Lets say you have a page that is described as three versions by three files:
page-1.txt
page-2.txt
page-3.txt

and the confluence syntax that is the output of the conversion for page-1.txt and page-2.txt is the same content.
Then, when you go to view the page history for the newly created Confluence page, you will see only two versions of the page, the one that is represented by page-1.txt and page-2.txt, and then the one represented by page-3.txt

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.