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 --input-dir docs/wiki \
16 --output-dir docs/html \
17 --root MoinLight \
18 --document-index index.html \
19 --theme mercurial \
20 --macros --all
21
22 This converts all documents in the indicated input directory to HTML format,
23 storing the converted documents in the indicated output directory, evaluating
24 all macros embedded in the input documents. A document index filename is
25 specified for filesystem browsing of the output documents.
26
27 The result of the above command is a collection of documents in docs/html that
28 can be viewed using a Web browser, with the docs/html/index.html file being
29 the front page of this collection. These documents do not need to be served
30 using a Web browser.
31
32 By omitting the --document-index option (and accompanying filename), a version
33 of the documents can be produced that is more appropriate for serving by a Web
34 browser, featuring links that do not include the index.html filename.
35
36 See the bundled documentation for more details of the software and how it can
37 be used:
38
39 * docs/wiki/MoinLight (and accompanying files) are the documentation files in
40 Moin format
41
42 * docs/html/index.html is the front page of the documentation converted to
43 HTML format
44
45 A more convenient way of generating the documentation is to use the following
46 command:
47
48 docs/tools/make_docs.sh
49
50 For Web server deployment, add the --web option for cleaner links:
51
52 docs/tools/make_docs.sh --web
53
54 Test Suite
55 ==========
56
57 A test suite is provided to exercise the toolchain and expose regressions.
58 More information is available by running the test_parser.py script (found in
59 the tests directory) with the appropriate option:
60
61 tests/test_parser.py --help
62
63 Running it with the --quiet option provides a quick way of verifying the
64 tested behaviour of the software.
65
66 Contact, Copyright and Licence Information
67 ==========================================
68
69 See the following Web pages for more information about this work:
70
71 http://projects.boddie.org.uk/MoinLight
72
73 The author can be contacted at the following e-mail address:
74
75 paul@boddie.org.uk
76
77 Copyright and licence information can be found in the docs directory - see
78 docs/COPYING.txt and docs/gpl-3.0.txt for more information.