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