# HG changeset patch
# User Paul Boddie <paul@boddie.org.uk>
# Date 1355954314 -3600
# Node ID a69fd61ec059b7bb4fc1956fff376e961c3c7b1b
# Parent  1d1cc4d70e1204aeb448dd9882aa350de1dc6efb
Added an explanation of the output of the converter.

diff -r 1d1cc4d70e12 -r a69fd61ec059 README.txt
--- a/README.txt	Wed Dec 19 00:34:10 2012 +0100
+++ b/README.txt	Wed Dec 19 22:58:34 2012 +0100
@@ -51,6 +51,36 @@
 
 This requires a suitable moinsetup.cfg file in the working directory.
 
+Output Structure
+----------------
+
+The structure of a converted workspace is a directory hierarchy containing the
+following directories:
+
+  * pages     (a collection of directories defining each page or content item,
+               corresponding to Page, Comment and BlogPost elements in the XML
+               exported from Confluence)
+
+  * versions  (a collection of files, each defining a revision or version of
+               some content, corresponding to BodyContent elements in the XML
+               exported from Confluence)
+
+Each page directory contains the following things:
+
+  * manifest  (a list of version entries in a format similar to the MoinMoin
+               page package manifest format)
+
+  * pagetitle (an optional page title imposed on the page by another content
+               item)
+
+  * children  (a list of child page names defined for the page)
+
+In the output structure, content items such as comments are represented as
+pages and each reference a content version. Since comments will ultimately be
+represented as subpages of some parent page, they will have a pagetitle file
+in their directory with an appropriate subpage name written according to the
+parent page's name and comment details.
+
 Troubleshooting
 ---------------