UWC Illegal Pagenames Framework - Disabling

As of v.48

This feature will become available as of Version 48.

Overview

Confluence has requirements for pagenames to be legal. Other wikis have different requirements for page titles, and the fact that pages are going to be saved to the file system adds another layer of complexity.

This means we need to make sure that the pagenames are valid before they are uploaded to Confluence. Further, if we have to change any pagenames, then we need to update any links to those pagenames as well.

This framework provides a way to turn off the default enforcement of valid Confluence pagenames and links so that you can implement it yourself via an exporter or converter.

Use at your own risk!

If you turn off the default illegal name handling, and try converting illegally named pages into a production server, I cannot promise you that your database won't get munged. As always, we recommend:

  • running the UWC on a test Confluence, and using Confluence's export/import process to move data to sensitive production systems.
  • backing up your important data before running the UWC.

Usage

Using the default illegal name handling converters

By default, illegal names are handled by the following two converters which are run at the very end of the conversion process:

  • IllegalPageNameConverter - fixes illegal page names
  • IllegalLinkNameConverter - fixes links to fixed pages

If you do nothing, these converters will be run.

Turning off the default illegal name handling converters

Please! Do this only if you are planning to develop a different solution. Do no just turn this feature off. Your database could get completely hosed!

That being said: To turn it off, use the following converter in your conf/converter.mywiki.properties file

Mywiki.0001.illegal-handling=false

Non-converter properties should always be at the beginning of your converter properties file.

What converters use this feature?

Currently, only the Sharepoint Converter handles illegal names on its own.

Labels

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