1.1 --- a/README.txt Wed Dec 19 00:34:10 2012 +0100
1.2 +++ b/README.txt Wed Dec 19 22:58:34 2012 +0100
1.3 @@ -51,6 +51,36 @@
1.4
1.5 This requires a suitable moinsetup.cfg file in the working directory.
1.6
1.7 +Output Structure
1.8 +----------------
1.9 +
1.10 +The structure of a converted workspace is a directory hierarchy containing the
1.11 +following directories:
1.12 +
1.13 + * pages (a collection of directories defining each page or content item,
1.14 + corresponding to Page, Comment and BlogPost elements in the XML
1.15 + exported from Confluence)
1.16 +
1.17 + * versions (a collection of files, each defining a revision or version of
1.18 + some content, corresponding to BodyContent elements in the XML
1.19 + exported from Confluence)
1.20 +
1.21 +Each page directory contains the following things:
1.22 +
1.23 + * manifest (a list of version entries in a format similar to the MoinMoin
1.24 + page package manifest format)
1.25 +
1.26 + * pagetitle (an optional page title imposed on the page by another content
1.27 + item)
1.28 +
1.29 + * children (a list of child page names defined for the page)
1.30 +
1.31 +In the output structure, content items such as comments are represented as
1.32 +pages and each reference a content version. Since comments will ultimately be
1.33 +represented as subpages of some parent page, they will have a pagetitle file
1.34 +in their directory with an appropriate subpage name written according to the
1.35 +parent page's name and comment details.
1.36 +
1.37 Troubleshooting
1.38 ---------------
1.39