ConfluenceToTWikiAddOn

Introduction Features/What is converted? What is not converted? How does it Work? Add-On Installation and Usage Instructions Modification of ConfluenceConfig.conf File Modification of ConverterConfig.conf File Add-On Info

Contributed by TWIKI.NET

Introduction

The ConfluenceToTWikiAddOn helps to convert the Confluence Wiki Site into TWiki Wiki Site. It converts Confluence workspaces into the TWiki webs. It converts the Confluence Pages and News articles into the TWiki topics into the respective TWiki webs.

Features/What is converted? What is not converted?

• Please note that - the tool depends on RPC-XMLRPC ( http://CONFLUNECE_URL/rpc/xmlrpc/) service, the tool works only when the service is up/running.
• Converts regular wiki markups including table of content - {toc} to appropriate syntax in TWiki
• Confluence tables are converted to TWiki tables.
• Confluence spaces are converted to TWiki webs. If webs have spaces/special characters, those are converted into the "_" characters. If Confluence have spaces called "Main", "TWiki", "Sandbox" - those webs are converted into ConfluenceMain, ConfluenceTWiki, ConfluenceSanbox, respectively.

• The comments on Confluence pages/news are also added into the TWiki topics.
• The Pages/News are converted into the topics; if any name/news has special characters/spaces, they are replaced with "_" (underscore).
• Does not carry the complete history meta-data in current version.
• The attachments of Pages/News from the confluence are attached to the respective topics in TWiki.

The tool will be improved over time to handle more syntax conversions.

How does it Work?

• The tool depends on the RPC-XMLRPC service installed with Confluence to fetch the data from Confluence.
• The tool use the Perl Modules/Open Source Libraries developed to convert the XML data to TWiki topics.
• The tool use the TWiki's Func.pm to create the corresponding TWiki webs and topics, and to attach the attachments.
• The tool is command line interface, is expected to run on the server where TWiki is already installed. If you have not installed TWiki please consult the installation documents at http://www.twiki.org/ or contact TWIKI.NET (http://www.twiki.net/) which can provide you with services related to TWiki including the installation of the TWiki.

Add-On Installation and Usage Instructions

Note: You do not need to install anything on the browser to use this add-on. The following instructions are for the administrator who installs the add-on on the server where TWiki is running.

1. Download the ZIP file from the Add-on Home (see below)
2. Content of the zip file:

1. Unzip ConfluenceToTWikiAddOn.zip into any directory where root/admin user of the system has write permission.
   • Why root/admin user? - You need to have write permission in {TWIKI_ROOT} directory for creating webs/topics, have write permission into the TWiki's working area.
2. copy data/TWiki/ConfluenceToTWikiAddOn.txt, pub/TWiki/ConfluenceToTWikiAddOn/twikinet145x66d-t.gif into respective areas of your TWiki installation, this can be used as help document for this converter.
3. Edit the configuration files called ConfluenceConfig.conf and ConverterConfig.conf
4. Run the command line tool getTWikiWeb.pl, for example:
   perl -I ../lib -I /var/www/twiki/lib genTWikiWeb.pl

Modification of ConfluenceConfig.conf File

• Specify ServerURL - example :

  ServerURL=http://www.example.com:8080

• Specify User - example:

  User=admin

  You can specify any user who has administration level access to Confluence Wiki.
• Specify Password You need to write the password, make sure to destroy once you are done with the conversion.

Modification of ConverterConfig.conf File

• Specify LogFile example

  LogFile=run.log

  This can be useful when you face issues, will be useful while debugging.
• Specify Debug example

  Debug=on

• Specify User Example

  User=admin

  This is TWiki Admin user - yes we have admin user for TWiki 4.2.0 and onwords...
• Specify Password - You need to write the password, make sure to destroy once you are done with the conversion.
• Specify ApacheGroup example

  ApacheGroup=apache

  The topics ownership is changed to this user/group.
• Specify TwikiPath example

  TwikiPath=/var/www/twiki

  This is TWiki installation root.

Add-On Info

• Set SHORTDESCRIPTION = Convert a Confluence wiki site into a TWiki site

Related Topic: TWikiAddOns

-- SopanShewale - 05 Aug 2008