1 Introduction
2 ============
3
4 MoinLight is a distribution of libraries and tools for interpreting document
5 content in the MoinMoin wiki format together with other formats employed in
6 wiki content.
7
8 Getting Started
9 ===============
10
11 The moinconvert tool provides a convenient way of converting content from Moin
12 format to other formats. For example, the supplied documentation can be
13 converted as follows:
14
15 ./moinconvert --all --input-dir docs/wiki --format html \
16 --output-dir docs/html --macros --document-index index.html
17
18 This converts all documents in the indicated input directory to HTML format,
19 storing the converted documents in the indicated output directory, evaluating
20 all macros embedded in the input documents. A document index filename is
21 specified for filesystem browsing of the output documents.
22
23 The result of the above command is a collection of documents in docs/html that
24 can be viewed using a Web browser, with the docs/html/index.html file being
25 the front page of this collection. These documents do not need to be served
26 using a Web browser.
27
28 By omitting the --document-index option (and accompanying filename), a version
29 of the documents can be produced that is more appropriate for serving by a Web
30 browser, featuring links that do not include the index.html filename.
31
32 See the bundled documentation for more details of the software and how it can
33 be used:
34
35 * docs/wiki/FrontPage (and accompanying files) are the documentation files in
36 Moin format
37
38 * docs/html/index.html is the front page of the documentation converted to HTML
39 format
40
41 Test Suite
42 ==========
43
44 A test suite is provided to exercise the toolchain and expose regressions.
45 More information is available by running the test_parser.py script (found in
46 the tests directory) with the appropriate option:
47
48 tests/test_parser.py --help
49
50 Running it with the --quiet option provides a quick way of verifying the
51 tested behaviour of the software.
52
53 Contact, Copyright and Licence Information
54 ==========================================
55
56 See the following Web pages for more information about this work:
57
58 http://projects.boddie.org.uk/MoinLight
59
60 The author can be contacted at the following e-mail address:
61
62 paul@boddie.org.uk
63
64 Copyright and licence information can be found in the docs directory - see
65 docs/COPYING.txt and docs/gpl-3.0.txt for more information.
