1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/README.txt Tue Apr 09 16:30:39 2019 +0200
1.3 @@ -0,0 +1,65 @@
1.4 +Introduction
1.5 +============
1.6 +
1.7 +MoinLight is a distribution of libraries and tools for interpreting document
1.8 +content in the MoinMoin wiki format together with other formats employed in
1.9 +wiki content.
1.10 +
1.11 +Getting Started
1.12 +===============
1.13 +
1.14 +The moinconvert tool provides a convenient way of converting content from Moin
1.15 +format to other formats. For example, the supplied documentation can be
1.16 +converted as follows:
1.17 +
1.18 +./moinconvert --all --input-dir docs/wiki --format html \
1.19 + --output-dir docs/html --macros --document-index index.html
1.20 +
1.21 +This converts all documents in the indicated input directory to HTML format,
1.22 +storing the converted documents in the indicated output directory, evaluating
1.23 +all macros embedded in the input documents. A document index filename is
1.24 +specified for filesystem browsing of the output documents.
1.25 +
1.26 +The result of the above command is a collection of documents in docs/html that
1.27 +can be viewed using a Web browser, with the docs/html/index.html file being
1.28 +the front page of this collection. These documents do not need to be served
1.29 +using a Web browser.
1.30 +
1.31 +By omitting the --document-index option (and accompanying filename), a version
1.32 +of the documents can be produced that is more appropriate for serving by a Web
1.33 +browser, featuring links that do not include the index.html filename.
1.34 +
1.35 +See the bundled documentation for more details of the software and how it can
1.36 +be used:
1.37 +
1.38 + * docs/wiki/FrontPage (and accompanying files) are the documentation files in
1.39 + Moin format
1.40 +
1.41 + * docs/html/index.html is the front page of the documentation converted to HTML
1.42 + format
1.43 +
1.44 +Test Suite
1.45 +==========
1.46 +
1.47 +A test suite is provided to exercise the toolchain and expose regressions.
1.48 +More information is available by running the test_parser.py script (found in
1.49 +the tests directory) with the appropriate option:
1.50 +
1.51 +tests/test_parser.py --help
1.52 +
1.53 +Running it with the --quiet option provides a quick way of verifying the
1.54 +tested behaviour of the software.
1.55 +
1.56 +Contact, Copyright and Licence Information
1.57 +==========================================
1.58 +
1.59 +See the following Web pages for more information about this work:
1.60 +
1.61 +http://projects.boddie.org.uk/MoinLight
1.62 +
1.63 +The author can be contacted at the following e-mail address:
1.64 +
1.65 +paul@boddie.org.uk
1.66 +
1.67 +Copyright and licence information can be found in the docs directory - see
1.68 +docs/COPYING.txt and docs/gpl-3.0.txt for more information.