UWC Tikiwiki Notes

Added by Laura Kolker, last edited by Laura Kolker on Aug 20, 2008  (view change) show comment

Overview

This is the documentation page for the Tikiwiki Conversion module of the Universal Wiki Converter.

Table of Contents

Status

The Tikiwiki Converter module is an alpha release. If you find problems, please help us improve it by submitting a Bug Report.

Supported Conversions

  • Basic Syntax
    • noformat
    • monospace
    • bold
    • italics
    • bold and italics
    • colored text
    • underlines
  • links
  • explicit anchors
  • headings
  • lists
  • images, attached to page
  • images, attached from gallery
  • attachments
  • table of contents
  • tables
  • preformatted
  • code
  • panels
  • page histories
Developed with 1.9.5

The Tikiwiki Converter was developed with Tikiwiki version 1.9.5
If you find that earlier versions of tikiwiki do not convert as you would expect, please indicate which version you were using in your bug report

Usage

Steps:

  1. Get the wiki data from Tikiwiki
  2. Launch the UWC
  3. Convert to Confluence pages

Get the wiki data from Tikiwiki

For each page you wish to convert to Confluence syntax, you will need a file, with:

  • filename - the title of the page
  • contents - the tikiwiki syntax of that page

Launch the UWC

UWC Gui v2 Documentation

Converting

Confluence Settings

Attachment Directory

Make sure you set the attachment directory setting to the location of your tikiwiki.

Example: If your tikiwiki directory is /My/tikiwiki-1.9.5, then set the attachment directory setting to that directory.

settings.tikiwiki.properties and Gallery Images

If you wish to be able to convert gallery images, with tikiwiki syntax that looks like this:

{img src=show_image.php?id=1 }

Then, you need to configure the settings.tikiwiki.properties file, found in the conf/ directory.

property required default Notes
Tikiwiki.gallery-conversion-on.switch false Gallery Images will be converted if this is true.
Tikiwiki.output-dir.setting   This is the directory that gallery images will be saved to before attaching
Tikiwiki.dbname.dbSetting   Database Settings: The name of your database
Tikiwiki.login.dbSetting   Database Settings: Your login to that database
Tikiwiki.password.dbSetting   Database Settings: Your password for that login
Tikiwiki.connection-url.dbSetting   Database Settings: The connection url for your database. Example: jdbc:mysql://localhost:3306
Tikiwiki.driver.dbSetting   Database Settings: The driver to be used for your connection. Note: if you do not use mysql and this driver: com.mysql.jdbc.Driver, you will most likely have to add the driver to the classpath yourself (try just plopping the jar in the lib directory)

If you don't want to use this, just leave the settings file alone.

Choose pages to convert

Choose files containing your tikiwiki syntax.

See UWC Gui v2 Documentation for more info on converting.

How are page titles determined?

UWC Version Behavior
44 Page titles are based on the filenames of the pages you convert
45 Page titles are based on the metadata in a tikiwiki exported page

not yet released

If you are using the UWC version 45 or later, and would rather use the filename than the metadata to determine page titles, comment out the following converter in your tikiwiki converter properties file:
Tikiwiki.0005-title-from-metadata.class=com.atlassian.uwc.converters.tikiwiki.MetadataTitle

What about an exporter?

You can export your wiki using Tikiwiki's export feature:
Log in as an administrator.
Click Admin Home.
Click Wiki.
Look for the Export link. It's probably about half way down the page.
Click export, and save the tar to your local file system.
You should create a directory to expand the tar in, as the files in the tar are not contained within a directory.
The files in the tar will be text files, with names the same as the page names.
These files are in a format that the Tikiwiki Converter can use.

Page Histories

The Tikiwiki Converter, as of version 40, now supports page history conversion.
In order to take advantage of this, make a file for each version of a page that you wish to preserve.
The contents of the file should be the tikiwiki syntax representing one version of the page
The filename of the page should be the pagename plus the suffix -[version number].txt

So for example, if the page name was HelloTikiwiki and you had two versions, you would have two files:

  • HelloTikiwiki-1.txt
  • HelloTikiwiki-2.txt

The first would be the first version of the page, and the second would be the most recent version of the page.

See UWC Page History Framework for further examples and developer doc.

Bug/Feature Reports

If you run into a syntax that doesn't convert the way you wish it would:

Submit a bug report/feature request to UWC JIRA.
Set the Component to 'Tikiwiki Converter'. (This will ensure faster response.)

Please provide the following information, so that we can best respond to your request:

  • Before: An example of the tikiwiki syntax that did not convert as you wished.
  • Current: An example of the Confluence syntax that is currently being created. (The undesired behavior). This helps us create a test case.
  • Desired: An example of the Confluence syntax that would be ideal.

Thank you!

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

Comments (3)

 

  1. Mar 31, 2007

    Byalpel says:

    Hi,  The tikiwiki export feature generates pages with a lot of details at ...

    Hi,

     The tikiwiki export feature generates pages with a lot of details at the beginning of the file that is interpreted by UWC but should not.

    Example :

    Date: Thu, 29 Mar 2007 11:11:56+00:00
    Mime-Version: 1.0 (Produced by Tiki)
    Content-Type: multipart/mixed;
      boundary="=_multipart_boundary_3"

    --=_multipart_boundary_3
    Content-Type: application/x-tikiwiki;
      pagename=AA;
      flags="";
      author=lci;
      version=31;
      lastmodified=1108979811;
      author_id=192.168.2.98;
      summary="";
      hits=1826;
      description=HomePage_AA;
      charset=utf-8
    Content-Transfer-Encoding: binary

    Too bad. For the moment the only way I've found to export from tiki to confluence is :

    • Dump (not EXPORT) wiki : it generates HTML pages
    • Convert HTML to dokuwiki syntax (using html2wiki perl package)
    • Use some regexp to convert specific or useless wiki tags
    • Import with UWC

    If you have a better solution or can help me on this point, it would be great.

    1. Apr 02, 2007

      Laura Kolker says:

      Hi Byalpel, Thanks for your comment. I'm not entirely sure, however, what's no...

      Hi Byalpel,

      Thanks for your comment.

      I'm not entirely sure, however, what's not working for you.
      The thing is, when I run the UWC with the tikiwiki converter on tikiwiki exported files, it does what I expect, which is:

      1. Get rid of headers
      2. Convert first tikiwiki version of the page to Confluence Syntax

      I can't tell if the above isn't happening for you, or if it is, but you weren't expecting that.

      I'd love to have your concerns in a JIRA issue (or several). Can you help me out by making JIRA issues here:
      http://developer.atlassian.com/jira/browse/UWC

      for each syntax conversion you're not happy with. Assume that the input will be the exported tikiwiki file. Set the component to tikiwiki, and in the description, tell me:

      1. The tikiwiki syntax from the file that's not converting the way you'd like
      2. What the Confluence conversion is currently
      3. and what would be the ideal Confluence syntax that you can come up with

      Also, in case you haven't, grab the most recent copy of the UWC. (Which was updated last Friday)
      You can get it here:
      http://svn.atlassian.com/svn/public/contrib/confluence/universal-wiki-converter/dist/uwc.zip

      Thanks
      Laura

  2. May 24, 2007

    Mark says:

    Just wanted to let you know that I found an easier way to manage the Tikiwiki co...

    Just wanted to let you know that I found an easier way to manage the Tikiwiki content after you migrate it over is to use a Webdav client.

    For me the wiki pages all come through with CamelCase and a group of children pages all come out flat, next to the parent page.  So I used webdav (with NetDrive) to quickly rename pages and then drag a bunch of children inside of a parent folder (in webdav). I found this much quicker work than using the confluence page editor to place and rearrange all the pages.

    Still a bear but doable.