1 Introduction
2 ------------
3
4 ConfluenceConverter is a distribution of software that converts exported data
5 from Confluence Wiki instances, provided in the form of an XML file, to a
6 collection of Wiki pages and resources that can be imported into a MoinMoin
7 instance as a page package.
8
9 Prerequisites
10 -------------
11
12 ConfluenceConverter requires a library called xmlread that can be found at the
13 following location:
14
15 http://hgweb.boddie.org.uk/xmlread
16
17 The xmlread.py file from the xmlread distribution can be copied into the
18 ConfluenceConverter directory.
19
20 ConfluenceConverter also requires access to the MoinMoin.wikiutil module found
21 in the MoinMoin distribution.
22
23 The moinsetup program is highly recommended for the installation of page
24 packages and the management of MoinMoin Wiki instances:
25
26 http://moinmo.in/ScriptMarket/moinsetup
27
28 If moinsetup is not being used, the page package installer documentation
29 should be consulted:
30
31 http://moinmo.in/HelpOnPackageInstaller
32
33 Wiki Content Prerequisites
34 --------------------------
35
36 For the output of the converter, the following MoinMoin extensions are
37 required:
38
39 http://moinmo.in/ParserMarket/ImprovedTableParser
40 http://hgweb.boddie.org.uk/MoinSupport
41
42 Quick Start
43 -----------
44
45 Given an XML file for a Confluence Wiki instance (in the example below, the
46 file is called com_entities.xml), the following command can be used to prepare
47 a page package for MoinMoin:
48
49 python convert.py com_entities.xml COM attachments
50
51 In addition to the filename, a workspace name is required. Confluence appears
52 to require a workspace as a container for collections of pages, but this also
53 permits us to selectively import parts of a Wiki into MoinMoin. If a directory
54 of attachments is also specified, these will be imported into the page
55 package.
56
57 The result of the above command will be a directory having the same name as
58 the chosen workspace, together with a zip archive for that directory's
59 contents. Thus, the above command would produce a directory called COM and an
60 archive called COM.zip.
61
62 To import the result, use moinsetup as follows:
63
64 python moinsetup.py -m install_page_package COM.zip
65
66 This requires a suitable moinsetup.cfg file in the working directory.
67
68 Output Structure
69 ----------------
70
71 The structure of a converted workspace is a directory hierarchy containing the
72 following directories:
73
74 * pages (a collection of directories defining each page or content item,
75 corresponding to Page, Comment and BlogPost elements in the XML
76 exported from Confluence)
77
78 * versions (a collection of files, each defining a revision or version of
79 some content, corresponding to BodyContent elements in the XML
80 exported from Confluence)
81
82 Each page directory contains the following things:
83
84 * manifest (a list of version entries in a format similar to the MoinMoin
85 page package manifest format)
86
87 * attachments (a list of attachment version entries in a format similar to
88 the MoinMoin page package manifest format)
89
90 * pagetitle (an optional page title imposed on the page by another content
91 item)
92
93 * children (a list of child page names defined for the page)
94
95 In the output structure, content items such as comments are represented as
96 pages and each reference a content version. Since comments will ultimately be
97 represented as subpages of some parent page, they will have a pagetitle file
98 in their directory with an appropriate subpage name written according to the
99 parent page's name and comment details.
100
101 Troubleshooting
102 ---------------
103
104 The page package import activity in particular can be a source of problems.
105 Generally, any error occurring when attempting to import a package is likely
106 to be due to insufficient privileges when writing to the pages directory of a
107 Wiki or to its edit-log file.
108
109 The moinsetup software can generate scripts that set the ownership of Wiki
110 files or apply ACLs (access control lists) to those files in order to make
111 access to Wiki data more convenient. Where the ownership of the files must be
112 set (to www-data or nobody), the import step can be run as that user given
113 sufficient privileges. However, the easiest solution is to apply ACLs, thus
114 allowing the user who created the Wiki to retain write access to it.
115
116 Contact, Copyright and Licence Information
117 ------------------------------------------
118
119 The current Web page for ConfluenceConverter at the time of release is:
120
121 http://hgweb.boddie.org.uk/ConfluenceConverter
122
123 Copyright and licence information can be found in the docs directory - see
124 docs/COPYING.txt and docs/LICENCE.txt for more information.