Metadata-Version: 2.4
Name: moinlight
Version: 0.4.6
Summary: Parse and convert MoinMoin markup documents
Author: Paul Boddie, Morten Kjeldgaard
Author-email: Paul Boddie <paul@boddie.org.uk>, Morten Kjeldgaard <mok0@mailbox.org>
License-Expression: GPL-2.0-or-later
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Wiki
Requires-Python: >=3.11.2
Project-URL: Homepage, https://projects.boddie.org.uk/MoinLight/
Project-URL: Repository, https://salsa.debian.org/mok0/moinlight.git
Description-Content-Type: text/markdown


# Table of Contents

1.  [Introduction](#orga2a8383)
2.  [Getting Started with `moinconvert`](#orgb764bb0)
3.  [Test Suite](#org2e66854)
4.  [Contact, Copyright and Licence Information](#org42e706f)


<a id="orga2a8383"></a>

# Introduction

MoinLight is a distribution of libraries and tools for interpreting document content in the MoinMoin wiki format together with other formats employed in wiki content.

MoinLight consists of a Python module called `moinformat` and a Python script `moinconvert`. For documentation on the `moinformat` module, check the `doc/` directory of the source distribution.

To add `moinlight` to your project, you can

    pip install moinlight

or (better)

    uv add moinlight

This will allow import access to the `moinformat` package from your Python programs.


<a id="orgb764bb0"></a>

# Getting Started with `moinconvert`

The moinconvert tool provides a convenient way of converting content from Moin format to other formats. For example, the supplied documentation can be converted as follows:

    ./moinconvert --input-dir docs/wiki \
                  --output-dir docs/html \
                  --root MoinLight \
                  --document-index index.html \
                  --theme mercurial \
                  --macros --all

This converts all documents in the indicated input directory to HTML format, storing the converted documents in the indicated output directory, evaluating all macros embedded in the input documents. A document index filename is specified for filesystem browsing of the output documents.

The result of the above command is a collection of documents in `docs/html` that can be viewed using a Web browser, with the `docs/html/index.html` file being the front page of this collection. These documents do not need to be served using a Web browser.

By omitting the `--document-index` option (and accompanying filename), a version of the documents can be produced that is more appropriate for serving by a Web browser, featuring links that do not include the index.html filename.

See the bundled documentation for more details of the software and how it can be used:

-   `docs/wiki/MoinLight` (and accompanying files) are the documentation files in `Moin format`
-   `docs/html/index.html` is the front page of the documentation converted  to `HTML format`

A more convenient way of generating the documentation is to use the following command:

    ./makedoc.py

For Web server deployment, add the `--web` option for cleaner links:

    docs/tools/make_docs.sh --web


<a id="org2e66854"></a>

# Test Suite

A test suite is provided to exercise the toolchain and expose regressions. More information is available by running the `test_parser.py` script (found in the tests directory) with the appropriate option:

    tests/test_parser.py --help

Running it with the `--quiet` option provides a quick way of verifying the tested behaviour of the software.


<a id="org42e706f"></a>

# Contact, Copyright and Licence Information

See the following Web pages for more information about this work:

<http://projects.boddie.org.uk/MoinLight>

The author can be contacted at the following e-mail address:

paul@boddie.org.uk

Copyright and licence information can be found in the docs directory - see docs/COPYING.txt and docs/gpl-3.0.txt for more information.

