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