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