# HG changeset patch # User Paul Boddie # Date 1497625570 -7200 # Node ID e565cc05d5d22be1d98b8dc37c96b148369d1820 # Parent 11e412862d4515a5305c8e6689827645bfd8f720 Tidying, adding note about PYTHONPATH. diff -r 11e412862d45 -r e565cc05d5d2 README.txt --- a/README.txt Mon Feb 02 15:18:19 2015 +0100 +++ b/README.txt Fri Jun 16 17:06:10 2017 +0200 @@ -1,5 +1,5 @@ Introduction ------------- +============ ConfluenceConverter is a distribution of software that converts exported data from Confluence wiki instances, provided in the form of an XML file, to a @@ -27,8 +27,10 @@ * Installation of scripts and identifier mappings * Filesystem permission adjustments + + Prerequisites -------------- +============= ConfluenceConverter requires a library called xmlread that can be found at the following location: @@ -39,7 +41,9 @@ ConfluenceConverter directory. ConfluenceConverter also requires access to the MoinMoin.wikiutil module found -in the MoinMoin distribution. +in the MoinMoin distribution. Setting the PYTHONPATH environment variable to +the location of the MoinMoin package should be sufficient for access to this +module. The moinsetup program is highly recommended for the installation of page packages and the management of MoinMoin wiki instances: @@ -89,8 +93,10 @@ http://hgweb.boddie.org.uk/MoinSupport + + Additional Software -------------------- +=================== PDF export support requires the ExportPDF action: @@ -116,8 +122,10 @@ (On Debian systems, the docbook-xsl package provides these resources.) + + Quick Start ------------ +=========== (!) The acquisition of Confluence wiki content and its conversion can be performed from any location, not necessarily on the server. @@ -387,8 +395,10 @@ sufficient privileges. However, the easiest solution is to apply ACLs, thus allowing the user who created the wiki to retain write access to it. + + Contact, Copyright and Licence Information ------------------------------------------- +========================================== The current Web page for ConfluenceConverter at the time of release is: