XWiki to Confluence converter - phase 1

Skip to end of metadata
Go to start of metadata

Overview

Leverage the UWC tool and framework to create a converter for Xwiki to Confluence.

There are 8 converters for other wikis already written, so there are plenty of examples to look at, reference and learn from.

Tasks (these don't need to be done in order and are not all dependent on each other)

  • Read through the UWC documentation, watch the videos, look through the regular expressions for the Twiki, TikiWiki, PmWiki and MediaWiki converters which are all good examples.
  • Install the UWC (eventually you'll want probably want to grab the source code too and build it, but you don't need that for developing the regular expressions.)
  • Download and install XWiki
  • run the XWiki export utility to get the exported files
  • Download and install Confluence (you'll need to get an evaluation license and then ask for a developers license which might take a little longer to process)
  • develop the necessary regular expressions within the UWC to convert xwiki exported pages to Confluence syntax.

Project output:

A property file containing a set of regular expressions formatted to work with the UWC which convert basic XWiki syntax to Confluence syntax.

The property file will be in the same type of format as the property files for the other wiki converters - for example: uwc/conf/converter.mediawiki.properties or uwc/conf/converter.twiki.properties
This file should be named converter.xwiki.properties

Acceptance Criteria

Convert the exported version of an XWiki syntax page to the equivalent Confluence syntax page.

Input: xwiki-input-syntax-v1.txt

Expected Output: xwiki-output-expected-syntax-v1.txt

The input can basically be seen here or here as wiki syntax

Skills needed:

  • Ability to create regular expressions
  • System admin type skills to install Java, run Xwiki and Confluence. Ability to understand how XWiki's export tool works.

Suggestions

  • Make use of the Java Regulard Expression test tool that can be launced from the UWC. This saves loads of time.

Phase 2 of this project will require some Java development. Please be well versed or willing to become well versed with guidance in Java.

Other comments

Send any questions to brendan.patterson@gmail.com

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