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