We relaunched the TWiki.org project with an expanded TWiki charter, and we invite you to participate! The TWiki.org Code of Conduct agreement took effect on 27 Oct 2008. We ask existing twiki.org users to opt-in. You need to opt-in to participate in the Blog, Codev, Plugins and TWiki webs. -- PeterThoeny - 27 Oct 2008
You are here: TWiki> Plugins Web>AddOnPackage>ConfluenceToTWikiAddOn (05 Aug 2008, SopanShewale)
Tags:
import2Add my vote for this tag create new tag
, view all tags

ConfluenceToTWikiAddOn

Contributed by TWIKI.NET
twikinet145x66d-t.gif

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:
File: Description:
data/TWiki/ConfluenceToTWikiAddOn.txt Add-on topic
pub/TWiki/ConfluenceToTWikiAddOn/ Add-on topic, attachment(logo)
src/getTWikiWeb.pl command line tool
xml/ this directory is used to download the data from Confluence, store zip files before converting the data into TWiki
lib/ holds the libraries/code required to do processing
conf/ConfluenceConf.conf for adding information regarding confluence
conf/ConvertorConfig.conf for adding information about TWiki
lib/Confluence.pm This is work form Confluence community-thanks to the Confluence community
lib/WikiText and lib/WikiText.pm This is actually part of CPAN's WikiText module. Thanks to Ingy dot Net for creating wonderful module
readme.txt has help information
Pre-requisites.txt describes the prerequisites
  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

Add-on Author: TWiki:Main.SopanShewale
Copyright: © 2008, TWIKI.NET, Inc.
License: GPL (GNU General Public License)
Add-on Version: 06 Aug 2008 (V1.000)
Change History:
06 Aug 2008: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.2 (TWiki 4.2)
CPAN Dependencies: CPAN:Log::Log4perl, CPAN:HTTP::Lite, CPAN:RPC::XML, CPAN:Error, CPAN:XML::LibXML, CPAN:XML::LibXML::Common, CPAN:Algorithm::Diff, CPAN:XMLRPC::Lite, CPAN:Getopt::Std, CPAN:Cwd, CPAN:Archive::Extract, CPAN:Archive::Zip
Other Dependencies: Confluence 2.8.1 - with working RPC-XMLRPC services
Perl Version: 5.8.8
Add-on Home: http://TWiki.org/cgi-bin/view/Plugins/ConfluenceToTWikiAddOn
Feedback: http://TWiki.org/cgi-bin/view/Plugins/ConfluenceToTWikiAddOnDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/ConfluenceToTWikiAddOnAppraisal

Related Topic: TWikiAddOns

-- SopanShewale - 05 Aug 2008

WebForm
TopicClassification AddOnDevelopment
TopicSummary Confluence to TWiki Converter
InterestedParties

RelatedTopics

Attachments Attachments
Topic attachments
I Attachment Action Size Date Who Comment
zipzip ConfluenceToTWikiAddOn.zip manage 41.7 K 05 Aug 2008 - 11:10 SopanShewale Confluence to TWiki Converter
gifgif twikinet145x66d-t.gif manage 3.5 K 05 Aug 2008 - 10:47 SopanShewale TWIKI.NET LOGO
Edit | Attach | Print version | History: r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r2 - 05 Aug 2008 - 17:44:59 - SopanShewale
 
TWIKI.NET
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback