UWC Jspwiki 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 Jspwiki Conversion module for the Universal Wiki Converter

Status

The Jspwiki Converter module is an alpha release. Please help us improve it by submitting Bug Reports.

Supported Conversions

  • Basic Syntax
    • bold
    • italics
    • underline
    • jspwiki newlines
  • headers
  • links
    • Note: Most link syntax is the same
    • convert links with whitespace to aliased links
    • basic interwiki links (WikiWikiWeb and JSPWiki)
  • lists
    • Note: Most list syntax is the same
    • convert definition lists to something comparable in Confluence
  • images and attachments
  • basic tables
  • plugins
    • recent pages
    • index
    • table of contents
    • undefined pages
  • footnote
  • escaping Confluence syntax that isn't syntax in JSPWiki
  • code blocks
  • styles
    • inline css
    • sub
    • super
    • strike
    • commentbox
    • information
    • warning
    • error

JIRA Issues:

Atlassian Developer Network JIRA (36 issues)
T Key Summary Assignee Reporter Pr Status Res Created Updated Due
Sub-task UWC-45 JSPWiki italics syntax Laura Kolker Laura Kolker Major Resolved FIXED Mar 16, 2007 Mar 16, 2007
Sub-task UWC-47 JSPWiki lists syntax Laura Kolker Laura Kolker Major Resolved FIXED Mar 16, 2007 Mar 16, 2007
Sub-task UWC-48 JSPWIki attachments and images syntax Laura Kolker Laura Kolker Major Resolved FIXED Mar 16, 2007 Mar 20, 2007
Sub-task UWC-44 JSPWiki bold syntax Laura Kolker Laura Kolker Major Resolved FIXED Mar 16, 2007 Mar 16, 2007
Sub-task UWC-42 Create JSPWiki Syntax Page for Testing Laura Kolker Laura Kolker Major Resolved FIXED Mar 16, 2007 Mar 16, 2007
Sub-task UWC-51 JSPWiki newlines syntax Laura Kolker Laura Kolker Major Resolved FIXED Mar 16, 2007 Mar 16, 2007
New Feature UWC-54 Converts from filename to correct pagename Laura Kolker Laura Kolker Major Resolved FIXED Mar 21, 2007 Mar 23, 2007
Sub-task UWC-65 convert code blocks Laura Kolker Laura Kolker Major Resolved FIXED Mar 22, 2007 Mar 23, 2007
Sub-task UWC-73 convert footnote Laura Kolker Laura Kolker Major Resolved FIXED Mar 22, 2007 Mar 26, 2007
Sub-task UWC-50 JSPWiki headers syntax Laura Kolker Laura Kolker Major Resolved FIXED Mar 16, 2007 Mar 19, 2007
Sub-task UWC-59 convert links that refer to JSPWiki:somepage Laura Kolker Laura Kolker Major Resolved FIXED Mar 21, 2007 Mar 23, 2007
Sub-task UWC-69 convert index plugin Laura Kolker Laura Kolker Major Resolved FIXED Mar 22, 2007 Mar 23, 2007
Sub-task UWC-46 JSPWiki links syntax Laura Kolker Laura Kolker Major Resolved FIXED Mar 16, 2007 Mar 16, 2007
Sub-task UWC-70 convert date plugin Laura Kolker Laura Kolker Major Resolved WON'T FIX Mar 22, 2007 Mar 26, 2007
Sub-task UWC-52 JSPWiki underline syntax Laura Kolker Laura Kolker Major Resolved FIXED Mar 16, 2007 Mar 22, 2007
Sub-task UWC-68 convert interwiki links to wikiwikiweb Laura Kolker Laura Kolker Major Resolved FIXED Mar 22, 2007 Mar 23, 2007
Task UWC-77 Javadoc Jspwiki Converter Laura Kolker Laura Kolker Major Resolved FIXED Mar 28, 2007 Mar 29, 2007
Sub-task UWC-76 write test suite Laura Kolker Laura Kolker Major Resolved FIXED Mar 23, 2007 Apr 02, 2007
New Feature UWC-53 JSPWiki Exporter Laura Kolker Laura Kolker Major Resolved WON'T FIX Mar 21, 2007 Mar 21, 2007
Sub-task UWC-60 convert * to escaped * Laura Kolker Laura Kolker Major Resolved FIXED Mar 21, 2007 Mar 23, 2007
Sub-task UWC-41 Install a JSPWiki locally Laura Kolker Laura Kolker Major Resolved FIXED Mar 16, 2007 Mar 16, 2007
Sub-task UWC-56 recover spaces in pagename Laura Kolker Laura Kolker Major Resolved FIXED Mar 21, 2007 Mar 23, 2007
Sub-task UWC-66 convert definition lists Laura Kolker Laura Kolker Major Resolved FIXED Mar 22, 2007 Mar 23, 2007
Sub-task UWC-49 JSPWiki table syntax Laura Kolker Laura Kolker Major Resolved FIXED Mar 16, 2007 Mar 20, 2007
Sub-task UWC-62 convert escaped brackets Laura Kolker Laura Kolker Major Resolved FIXED Mar 21, 2007 Mar 23, 2007
Sub-task UWC-72 convert table of contents plugin Laura Kolker Laura Kolker Major Resolved FIXED Mar 22, 2007 Mar 26, 2007
New Feature UWC-38 Jspwiki Converter - basic syntax Laura Kolker Laura Kolker Major Resolved FIXED Mar 15, 2007 Mar 20, 2007
Sub-task UWC-55 remove .txt Laura Kolker Laura Kolker Major Resolved FIXED Mar 21, 2007 Mar 21, 2007
Sub-task UWC-61 convert curly brace number Laura Kolker Laura Kolker Major Resolved FIXED Mar 21, 2007 Mar 23, 2007
Sub-task UWC-63 convert pipes within tables Laura Kolker Laura Kolker Major Resolved FIXED Mar 21, 2007 Mar 23, 2007
Task UWC-57 Test Jspwiki Converter using Jspwiki Core Files Laura Kolker Laura Kolker Major Resolved FIXED Mar 21, 2007 Mar 28, 2007
Sub-task UWC-64 convert escaped dashes in tables Laura Kolker Laura Kolker Major Resolved FIXED Mar 21, 2007 Mar 23, 2007
Sub-task UWC-74 convert css syntax Laura Kolker Laura Kolker Major Resolved FIXED Mar 22, 2007 Mar 28, 2007
Sub-task UWC-71 convert wiki variables Laura Kolker Laura Kolker Minor Resolved WON'T FIX Mar 22, 2007 Mar 26, 2007
Sub-task UWC-67 convert recent pages plugin Laura Kolker Laura Kolker Minor Resolved FIXED Mar 22, 2007 Mar 26, 2007
Sub-task UWC-75 convert undefined pages plugin Laura Kolker Laura Kolker Minor Resolved FIXED Mar 22, 2007 Mar 26, 2007

Usage

See the UWC Gui v2 Documentation page, for info on converting

Attachment Directory

As of UWC v41, this should be set to the directory defined in jspwiki.properties under the jspwiki.basicAttachmentProvider.storageDir property

Bug/Feature Reports

Place for information about how to submit bug reports and feature requests to the UWC

You support my wiki, but the syntax conversion didn't work

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.
    • Please set the Component.
      • If we are supporting your wiki, there should be a component by the name of your wiki. (Tikiwiki Converter, Mediawiki, etc.)
      • This will ensure faster response, as the lead developer for that conversion will be notified.
  • Please provide the following information, so that we can best respond to your request:
    • Before: An example of the syntax that did not convert as you wished. (Tikiwiki syntax, Mediawiki syntax, etc.)
    • 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.
As an example:

Before conversion:
   '''This should be bold text'''
Current UWC conversion:
   *__This should be bold text__*
Desired:
   *This should be bold text*
Use the code macro

JIRA has its own set of syntax that it renders specially. So, sometimes a described syntax will not show up in JIRA they way you'd like. You can be sure that the syntax you describe is as you typed it in if you surround your syntax quotes with code macros. Like so:

Before conversion:
{code}
'''This should be bold text'''
{code}
Desired syntax:
{code}
*This should be bold text*
{code}

The conversion didn't work but the problem was something other than syntax conversion:

As mentioned above please submit an issue with as much detail as possible. If possible please comment on the desired outcome. Keep in mind you will frequently have the most developed intimate knowledge of the wiki your department has been using for months or years so explicit guidance on how the feature should work is helpful

(as mentioned above)

  • Submit a bug report/feature request to UWC JIRA.
    • Please set the Component.
      • If we are supporting your wiki, there should be a component by the name of your wiki. (Tikiwiki Converter, Mediawiki, etc.)
      • This will ensure faster response, as the lead developer for that conversion will be notified.

When will a conversion bug be fixed?

We don't currently have an issue fix schedule for the UWC. If a particular set of syntax conversions are not working and are a high priority for you to move forward you can engage our Custom Plugin Pack Team - special UWC engagement pricing is detailed.

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

Comments (4)

 

  1. May 15, 2007

    Matt Doar says:

    I downloaded the latest uwc.zip and tried to use the jspwiki converter. All seem...

    I downloaded the latest uwc.zip and tried to use the jspwiki converter. All seems fine until "Organize your Wiki" when I get all sorts of messages about "non-functional prototype"

    What's up?

    ~Matt

    1. Nov 01, 2007

      Brendan Patterson says:

      Just saw this comment. That feature is not yet implemented.

      Just saw this comment. That feature is not yet implemented.

  2. Nov 22, 2007

    ak says:

    I am trying to do a test conversion and created a space with the Space key "Test...

    I am trying to do a test conversion and created a space with the Space key "Test" to transfer some pages to. I have got to stage 2 of the conversion and when I press the tab "Test Settings" I am given the message below:

     This user was authenticated on the server, but had no permisiions on the space with the space key: 'Test'

     I checked the permissions for my test page and all seems to be in order.

    In the "Attachment directory" I have entered the following as this is what is shown in the jpsiwiki properties that I am trying to convert. (although I have a feeling there should be more to this)

     /work/ateam-wiki

     Can somebody tell me where I am going wrong?









  3. Feb 23, 2008

    Matt Doar says:

    Time for my second annual test of the Wiki converter, particularly for jspwiki. ...

    Time for my second annual test of the Wiki converter, particularly for jspwiki. The new v3 GUI is nicer and seems to convert a couple of pages correctly, but how do I specify the 1000+ pages I want to convert. For sure I'm not going to add each one to the list of files!

    ~Matt