moinlight 0.4.5__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- moinlight-0.4.5/.gitignore +24 -0
- moinlight-0.4.5/PKG-INFO +111 -0
- moinlight-0.4.5/README.md +97 -0
- moinlight-0.4.5/README.txt +78 -0
- moinlight-0.4.5/docs/COPYING.txt +48 -0
- moinlight-0.4.5/docs/gpl-3.0.txt +674 -0
- moinlight-0.4.5/docs/tools/make_docs.sh +39 -0
- moinlight-0.4.5/docs/tools/make_releases.sh +39 -0
- moinlight-0.4.5/docs/tools/sign_releases.sh +48 -0
- moinlight-0.4.5/docs/wiki/Changelog +94 -0
- moinlight-0.4.5/docs/wiki/Downloads +98 -0
- moinlight-0.4.5/docs/wiki/Input +39 -0
- moinlight-0.4.5/docs/wiki/Macros +23 -0
- moinlight-0.4.5/docs/wiki/Metadata +139 -0
- moinlight-0.4.5/docs/wiki/MoinLight +129 -0
- moinlight-0.4.5/docs/wiki/MoinSyntax +157 -0
- moinlight-0.4.5/docs/wiki/Output +49 -0
- moinlight-0.4.5/docs/wiki/Parsers +20 -0
- moinlight-0.4.5/docs/wiki/Prerequisites +31 -0
- moinlight-0.4.5/docs/wiki/Roadmap +126 -0
- moinlight-0.4.5/docs/wiki/Serialisers +25 -0
- moinlight-0.4.5/docs/wiki/Themes +16 -0
- moinlight-0.4.5/docs/wiki/moinconvert +11 -0
- moinlight-0.4.5/makedoc.py +107 -0
- moinlight-0.4.5/moinconvert +650 -0
- moinlight-0.4.5/moinformat/__init__.py +30 -0
- moinlight-0.4.5/moinformat/errors.py +33 -0
- moinlight-0.4.5/moinformat/imports.py +88 -0
- moinlight-0.4.5/moinformat/input/__init__.py +39 -0
- moinlight-0.4.5/moinformat/input/common.py +167 -0
- moinlight-0.4.5/moinformat/input/directory.py +175 -0
- moinlight-0.4.5/moinformat/input/dummy.py +64 -0
- moinlight-0.4.5/moinformat/input/manifest.py +33 -0
- moinlight-0.4.5/moinformat/input/moindirectory.py +165 -0
- moinlight-0.4.5/moinformat/input/standalone.py +55 -0
- moinlight-0.4.5/moinformat/io.py +43 -0
- moinlight-0.4.5/moinformat/links/__init__.py +42 -0
- moinlight-0.4.5/moinformat/links/common.py +118 -0
- moinlight-0.4.5/moinformat/links/html.py +263 -0
- moinlight-0.4.5/moinformat/links/manifest.py +33 -0
- moinlight-0.4.5/moinformat/links/mediawiki.py +159 -0
- moinlight-0.4.5/moinformat/macros/__init__.py +30 -0
- moinlight-0.4.5/moinformat/macros/anchor.py +45 -0
- moinlight-0.4.5/moinformat/macros/attachlist.py +88 -0
- moinlight-0.4.5/moinformat/macros/br.py +41 -0
- moinlight-0.4.5/moinformat/macros/common.py +59 -0
- moinlight-0.4.5/moinformat/macros/footnote.py +195 -0
- moinlight-0.4.5/moinformat/macros/include.py +163 -0
- moinlight-0.4.5/moinformat/macros/mailto.py +70 -0
- moinlight-0.4.5/moinformat/macros/manifest.py +33 -0
- moinlight-0.4.5/moinformat/macros/navigation.py +71 -0
- moinlight-0.4.5/moinformat/macros/pagelist.py +66 -0
- moinlight-0.4.5/moinformat/macros/toc.py +274 -0
- moinlight-0.4.5/moinformat/macros/verbatim.py +41 -0
- moinlight-0.4.5/moinformat/metadata.py +263 -0
- moinlight-0.4.5/moinformat/output/__init__.py +39 -0
- moinlight-0.4.5/moinformat/output/common.py +128 -0
- moinlight-0.4.5/moinformat/output/directory.py +230 -0
- moinlight-0.4.5/moinformat/output/dummy.py +68 -0
- moinlight-0.4.5/moinformat/output/manifest.py +33 -0
- moinlight-0.4.5/moinformat/output/moindirectory.py +72 -0
- moinlight-0.4.5/moinformat/output/standalone.py +75 -0
- moinlight-0.4.5/moinformat/parsers/__init__.py +44 -0
- moinlight-0.4.5/moinformat/parsers/common.py +558 -0
- moinlight-0.4.5/moinformat/parsers/graphviz.py +97 -0
- moinlight-0.4.5/moinformat/parsers/html.py +81 -0
- moinlight-0.4.5/moinformat/parsers/manifest.py +33 -0
- moinlight-0.4.5/moinformat/parsers/moin.py +1321 -0
- moinlight-0.4.5/moinformat/parsers/pretty.py +79 -0
- moinlight-0.4.5/moinformat/parsers/table.py +163 -0
- moinlight-0.4.5/moinformat/resources/__init__.py +20 -0
- moinlight-0.4.5/moinformat/resources/fixlinks.xsl +86 -0
- moinlight-0.4.5/moinformat/resources/notugly.xsl +594 -0
- moinlight-0.4.5/moinformat/serialisers/__init__.py +51 -0
- moinlight-0.4.5/moinformat/serialisers/common.py +240 -0
- moinlight-0.4.5/moinformat/serialisers/html/__init__.py +20 -0
- moinlight-0.4.5/moinformat/serialisers/html/graphviz.py +191 -0
- moinlight-0.4.5/moinformat/serialisers/html/html.py +72 -0
- moinlight-0.4.5/moinformat/serialisers/html/moin.py +451 -0
- moinlight-0.4.5/moinformat/serialisers/html/table.py +34 -0
- moinlight-0.4.5/moinformat/serialisers/manifest.py +46 -0
- moinlight-0.4.5/moinformat/serialisers/mediawiki/__init__.py +20 -0
- moinlight-0.4.5/moinformat/serialisers/mediawiki/moin.py +513 -0
- moinlight-0.4.5/moinformat/serialisers/mediawiki/table.py +33 -0
- moinlight-0.4.5/moinformat/serialisers/moin/__init__.py +20 -0
- moinlight-0.4.5/moinformat/serialisers/moin/graphviz.py +45 -0
- moinlight-0.4.5/moinformat/serialisers/moin/moin.py +271 -0
- moinlight-0.4.5/moinformat/serialisers/moin/table.py +64 -0
- moinlight-0.4.5/moinformat/serialisers/pretty/__init__.py +20 -0
- moinlight-0.4.5/moinformat/serialisers/pretty/common.py +36 -0
- moinlight-0.4.5/moinformat/serialisers/pretty/graphviz.py +45 -0
- moinlight-0.4.5/moinformat/serialisers/pretty/html.py +63 -0
- moinlight-0.4.5/moinformat/serialisers/pretty/moin.py +184 -0
- moinlight-0.4.5/moinformat/serialisers/pretty/pretty.py +36 -0
- moinlight-0.4.5/moinformat/serialisers/pretty/table.py +33 -0
- moinlight-0.4.5/moinformat/themes/__init__.py +39 -0
- moinlight-0.4.5/moinformat/themes/common.py +119 -0
- moinlight-0.4.5/moinformat/themes/debian/__init__.py +20 -0
- moinlight-0.4.5/moinformat/themes/debian/css/all-admonitions.css +52 -0
- moinlight-0.4.5/moinformat/themes/debian/css/all-footnote.css +4 -0
- moinlight-0.4.5/moinformat/themes/debian/css/all-navigation.css +10 -0
- moinlight-0.4.5/moinformat/themes/debian/css/all-smileys.css +105 -0
- moinlight-0.4.5/moinformat/themes/debian/css/all-toc.css +10 -0
- moinlight-0.4.5/moinformat/themes/debian/css/all.css +71 -0
- moinlight-0.4.5/moinformat/themes/debian/css/print-revisions.css +3 -0
- moinlight-0.4.5/moinformat/themes/debian/css/screen-revisions.css +33 -0
- moinlight-0.4.5/moinformat/themes/debian/html.py +31 -0
- moinlight-0.4.5/moinformat/themes/debian/revisions_template.html +9 -0
- moinlight-0.4.5/moinformat/themes/debian/template.html +12 -0
- moinlight-0.4.5/moinformat/themes/default/__init__.py +20 -0
- moinlight-0.4.5/moinformat/themes/default/css/all-admonitions.css +34 -0
- moinlight-0.4.5/moinformat/themes/default/css/all-footnote.css +4 -0
- moinlight-0.4.5/moinformat/themes/default/css/all-navigation.css +10 -0
- moinlight-0.4.5/moinformat/themes/default/css/all-smileys.css +105 -0
- moinlight-0.4.5/moinformat/themes/default/css/all-toc.css +9 -0
- moinlight-0.4.5/moinformat/themes/default/css/all.css +21 -0
- moinlight-0.4.5/moinformat/themes/default/css/print-revisions.css +3 -0
- moinlight-0.4.5/moinformat/themes/default/css/screen-revisions.css +33 -0
- moinlight-0.4.5/moinformat/themes/default/html.py +31 -0
- moinlight-0.4.5/moinformat/themes/default/revisions_template.html +9 -0
- moinlight-0.4.5/moinformat/themes/default/template.html +12 -0
- moinlight-0.4.5/moinformat/themes/html.py +189 -0
- moinlight-0.4.5/moinformat/themes/manifest.py +41 -0
- moinlight-0.4.5/moinformat/themes/mercurial/__init__.py +20 -0
- moinlight-0.4.5/moinformat/themes/mercurial/css/all-admonitions.css +34 -0
- moinlight-0.4.5/moinformat/themes/mercurial/css/all-footnote.css +4 -0
- moinlight-0.4.5/moinformat/themes/mercurial/css/all-navigation.css +10 -0
- moinlight-0.4.5/moinformat/themes/mercurial/css/all-smileys.css +105 -0
- moinlight-0.4.5/moinformat/themes/mercurial/css/all-toc.css +9 -0
- moinlight-0.4.5/moinformat/themes/mercurial/css/all.css +82 -0
- moinlight-0.4.5/moinformat/themes/mercurial/css/print-revisions.css +3 -0
- moinlight-0.4.5/moinformat/themes/mercurial/css/print.css +13 -0
- moinlight-0.4.5/moinformat/themes/mercurial/css/screen-revisions.css +33 -0
- moinlight-0.4.5/moinformat/themes/mercurial/css/screen.css +12 -0
- moinlight-0.4.5/moinformat/themes/mercurial/html.py +31 -0
- moinlight-0.4.5/moinformat/themes/mercurial/revisions_template.html +9 -0
- moinlight-0.4.5/moinformat/themes/mercurial/template.html +12 -0
- moinlight-0.4.5/moinformat/tree/__init__.py +20 -0
- moinlight-0.4.5/moinformat/tree/graphviz.py +45 -0
- moinlight-0.4.5/moinformat/tree/html.py +24 -0
- moinlight-0.4.5/moinformat/tree/moin.py +1056 -0
- moinlight-0.4.5/moinformat/tree/pretty.py +65 -0
- moinlight-0.4.5/moinformat/tree/table.py +35 -0
- moinlight-0.4.5/moinformat/utils/__init__.py +20 -0
- moinlight-0.4.5/moinformat/utils/copying.py +61 -0
- moinlight-0.4.5/moinformat/utils/directory.py +214 -0
- moinlight-0.4.5/moinformat/utils/file.py +32 -0
- moinlight-0.4.5/moinformat/utils/graphviz.py +342 -0
- moinlight-0.4.5/moinformat/utils/htmlparse/__init__.py +22 -0
- moinlight-0.4.5/moinformat/utils/htmlparse/lex.py +232 -0
- moinlight-0.4.5/moinformat/utils/htmlparse/parse.py +110 -0
- moinlight-0.4.5/moinformat/utils/htmlparse/token.py +158 -0
- moinlight-0.4.5/moinformat/utils/htmlparse/tree.py +100 -0
- moinlight-0.4.5/moinformat/utils/links.py +222 -0
- moinlight-0.4.5/moinformat/utils/markup.py +60 -0
- moinlight-0.4.5/moinformat/utils/moindirectory.py +268 -0
- moinlight-0.4.5/moinformat/utils/patterns.py +158 -0
- moinlight-0.4.5/pyproject.toml +42 -0
- moinlight-0.4.5/test_suite/test_anchors.tree +44 -0
- moinlight-0.4.5/test_suite/test_anchors.txt +22 -0
- moinlight-0.4.5/test_suite/test_continuation.tree +26 -0
- moinlight-0.4.5/test_suite/test_continuation.txt +6 -0
- moinlight-0.4.5/test_suite/test_deflists.tree +37 -0
- moinlight-0.4.5/test_suite/test_deflists.txt +15 -0
- moinlight-0.4.5/test_suite/test_directives.tree +19 -0
- moinlight-0.4.5/test_suite/test_directives.txt +18 -0
- moinlight-0.4.5/test_suite/test_encoding.tree +9 -0
- moinlight-0.4.5/test_suite/test_encoding.txt +3 -0
- moinlight-0.4.5/test_suite/test_encoding.txt.iso-8859-1 +3 -0
- moinlight-0.4.5/test_suite/test_formatting.tree +115 -0
- moinlight-0.4.5/test_suite/test_formatting.txt +27 -0
- moinlight-0.4.5/test_suite/test_headings.tree +15 -0
- moinlight-0.4.5/test_suite/test_headings.txt +9 -0
- moinlight-0.4.5/test_suite/test_links.tree +115 -0
- moinlight-0.4.5/test_suite/test_links.txt +29 -0
- moinlight-0.4.5/test_suite/test_lists.tree +59 -0
- moinlight-0.4.5/test_suite/test_lists.txt +22 -0
- moinlight-0.4.5/test_suite/test_lists2.tree +87 -0
- moinlight-0.4.5/test_suite/test_lists2.txt +36 -0
- moinlight-0.4.5/test_suite/test_macros.tree +52 -0
- moinlight-0.4.5/test_suite/test_macros.tree-exp +92 -0
- moinlight-0.4.5/test_suite/test_macros.txt +18 -0
- moinlight-0.4.5/test_suite/test_paragraphs.tree +13 -0
- moinlight-0.4.5/test_suite/test_paragraphs.txt +5 -0
- moinlight-0.4.5/test_suite/test_parser.py +242 -0
- moinlight-0.4.5/test_suite/test_region_endings.tree +7 -0
- moinlight-0.4.5/test_suite/test_region_endings.txt +7 -0
- moinlight-0.4.5/test_suite/test_regions.tree +12 -0
- moinlight-0.4.5/test_suite/test_regions.txt +9 -0
- moinlight-0.4.5/test_suite/test_regions_inline.tree +12 -0
- moinlight-0.4.5/test_suite/test_regions_inline.txt +3 -0
- moinlight-0.4.5/test_suite/test_regions_opaque.tree +7 -0
- moinlight-0.4.5/test_suite/test_regions_opaque.txt +10 -0
- moinlight-0.4.5/test_suite/test_rules.tree +12 -0
- moinlight-0.4.5/test_suite/test_rules.txt +6 -0
- moinlight-0.4.5/test_suite/test_smileys.tree +83 -0
- moinlight-0.4.5/test_suite/test_smileys.txt +14 -0
- moinlight-0.4.5/test_suite/test_table_parser.tree +114 -0
- moinlight-0.4.5/test_suite/test_table_parser.txt +59 -0
- moinlight-0.4.5/test_suite/test_tables.tree +166 -0
- moinlight-0.4.5/test_suite/test_tables.txt +30 -0
- moinlight-0.4.5/test_suite/test_variables.tree +13 -0
- moinlight-0.4.5/test_suite/test_variables.txt +4 -0
- moinlight-0.4.5/test_suite/test_wikiwords.tree +32 -0
- moinlight-0.4.5/test_suite/test_wikiwords.txt +24 -0
- moinlight-0.4.5/tests/conftest.py +77 -0
- moinlight-0.4.5/tests/input/test_input.py +22 -0
- moinlight-0.4.5/tests/input/test_input_moindirectory.py +53 -0
- moinlight-0.4.5/tests/input/test_input_standalone.py +52 -0
- moinlight-0.4.5/tests/links/test_html_links.py +84 -0
- moinlight-0.4.5/tests/links/test_linker_resolve.py +64 -0
- moinlight-0.4.5/tests/links/test_mediawiki_links.py +154 -0
- moinlight-0.4.5/tests/links/test_parse_link_target.py +170 -0
- moinlight-0.4.5/tests/links/test_util_linktarget.py +61 -0
- moinlight-0.4.5/tests/output/test_directory_output.py +109 -0
- moinlight-0.4.5/tests/output/test_output_dummy.py +30 -0
- moinlight-0.4.5/tests/output/test_output_standalone.py +73 -0
- moinlight-0.4.5/tests/parsers/test_moin_parser.py +196 -0
- moinlight-0.4.5/tests/serialisers/test_serialisers_mediawiki.py +238 -0
- moinlight-0.4.5/tests/test_metadata.py +69 -0
- moinlight-0.4.5/tests/utils/test_util_directory.py +19 -0
- moinlight-0.4.5/tests/utils/test_util_links.py +38 -0
- moinlight-0.4.5/tests/utils/test_util_wikiword.py +14 -0
- moinlight-0.4.5/uv.lock +108 -0
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
mok-private
|
|
2
|
+
00notes.org
|
|
3
|
+
README.org
|
|
4
|
+
chroot*
|
|
5
|
+
consume.py
|
|
6
|
+
create-xml.py
|
|
7
|
+
do.sh
|
|
8
|
+
docs/html/
|
|
9
|
+
fetch-moinmoin-raw.sh
|
|
10
|
+
imports-for-ipython.ipy
|
|
11
|
+
interwiki-moin-default.json
|
|
12
|
+
languages.py
|
|
13
|
+
logger.py
|
|
14
|
+
make-dummy-moin-page.py
|
|
15
|
+
mediawiki-config.json
|
|
16
|
+
pages/
|
|
17
|
+
pretty_title.py
|
|
18
|
+
tests/parsers/test_moin_parser.py.mok0
|
|
19
|
+
tests/serialisers/test_serialisers_mediawiki.py.mok0
|
|
20
|
+
tests/serialisers/test_serialisers_mediawiki.py.save
|
|
21
|
+
tmp.py
|
|
22
|
+
try2-convert-chroot.py
|
|
23
|
+
try3-simple.py
|
|
24
|
+
try4-simple+serialiser.py
|
moinlight-0.4.5/PKG-INFO
ADDED
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: moinlight
|
|
3
|
+
Version: 0.4.5
|
|
4
|
+
Summary: Parse and convert MoinMoin markup documents
|
|
5
|
+
Project-URL: Homepage, https://projects.boddie.org.uk/MoinLight/
|
|
6
|
+
Project-URL: Repository, https://salsa.debian.org/mok0/moinlight.git
|
|
7
|
+
Author-email: Paul Boddie <paul@boddie.org.uk>, Morten Kjeldgaard <mok0@mailbox.org>
|
|
8
|
+
License-Expression: GPL-2.0-or-later
|
|
9
|
+
Classifier: Programming Language :: Python :: 3
|
|
10
|
+
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Wiki
|
|
11
|
+
Classifier: Topic :: Text Processing :: Markup
|
|
12
|
+
Requires-Python: >=3.11.2
|
|
13
|
+
Description-Content-Type: text/markdown
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
# Table of Contents
|
|
17
|
+
|
|
18
|
+
1. [Introduction](#org84b31e8)
|
|
19
|
+
2. [Getting Started](#org40d49b0)
|
|
20
|
+
3. [Test Suite](#org8a0a7f4)
|
|
21
|
+
4. [Contact, Copyright and Licence Information](#org0d159da)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<a id="org84b31e8"></a>
|
|
25
|
+
|
|
26
|
+
# Introduction
|
|
27
|
+
|
|
28
|
+
MoinLight is a distribution of libraries and tools for interpreting
|
|
29
|
+
document content in the MoinMoin wiki format together with other
|
|
30
|
+
formats employed in wiki content.
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
<a id="org40d49b0"></a>
|
|
34
|
+
|
|
35
|
+
# Getting Started
|
|
36
|
+
|
|
37
|
+
The moinconvert tool provides a convenient way of converting content
|
|
38
|
+
from Moin format to other formats. For example, the supplied
|
|
39
|
+
documentation can be converted as follows:
|
|
40
|
+
|
|
41
|
+
./moinconvert --input-dir docs/wiki \
|
|
42
|
+
--output-dir docs/html \
|
|
43
|
+
--root MoinLight \
|
|
44
|
+
--document-index index.html \
|
|
45
|
+
--theme mercurial \
|
|
46
|
+
--macros --all
|
|
47
|
+
|
|
48
|
+
This converts all documents in the indicated input directory to HTML
|
|
49
|
+
format, storing the converted documents in the indicated output
|
|
50
|
+
directory, evaluating all macros embedded in the input documents. A
|
|
51
|
+
document index filename is specified for filesystem browsing of the
|
|
52
|
+
output documents.
|
|
53
|
+
|
|
54
|
+
The result of the above command is a collection of documents in
|
|
55
|
+
`docs/html` that can be viewed using a Web browser, with the
|
|
56
|
+
`docs/html/index.html` file being the front page of this collection.
|
|
57
|
+
These documents do not need to be served using a Web browser.
|
|
58
|
+
|
|
59
|
+
By omitting the `--document-index` option (and accompanying filename), a
|
|
60
|
+
version of the documents can be produced that is more appropriate for
|
|
61
|
+
serving by a Web browser, featuring links that do not include the
|
|
62
|
+
index.html filename.
|
|
63
|
+
|
|
64
|
+
See the bundled documentation for more details of the software and how
|
|
65
|
+
it can be used:
|
|
66
|
+
|
|
67
|
+
- `docs/wiki/MoinLight` (and accompanying files) are the documentation
|
|
68
|
+
files in `Moin format`
|
|
69
|
+
- `docs/html/index.html` is the front page of the documentation converted
|
|
70
|
+
to `HTML format`
|
|
71
|
+
|
|
72
|
+
A more convenient way of generating the documentation is to use the
|
|
73
|
+
following command:
|
|
74
|
+
|
|
75
|
+
./makedoc.py
|
|
76
|
+
|
|
77
|
+
For Web server deployment, add the `--web` option for cleaner links:
|
|
78
|
+
|
|
79
|
+
docs/tools/make_docs.sh --web
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
<a id="org8a0a7f4"></a>
|
|
83
|
+
|
|
84
|
+
# Test Suite
|
|
85
|
+
|
|
86
|
+
A test suite is provided to exercise the toolchain and expose
|
|
87
|
+
regressions. More information is available by running the
|
|
88
|
+
`test_parser.py` script (found in the tests directory) with the
|
|
89
|
+
appropriate option:
|
|
90
|
+
|
|
91
|
+
tests/test_parser.py --help
|
|
92
|
+
|
|
93
|
+
Running it with the `--quiet` option provides a quick way of verifying
|
|
94
|
+
the tested behaviour of the software.
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<a id="org0d159da"></a>
|
|
98
|
+
|
|
99
|
+
# Contact, Copyright and Licence Information
|
|
100
|
+
|
|
101
|
+
See the following Web pages for more information about this work:
|
|
102
|
+
|
|
103
|
+
<http://projects.boddie.org.uk/MoinLight>
|
|
104
|
+
|
|
105
|
+
The author can be contacted at the following e-mail address:
|
|
106
|
+
|
|
107
|
+
paul@boddie.org.uk
|
|
108
|
+
|
|
109
|
+
Copyright and licence information can be found in the docs directory -
|
|
110
|
+
see docs/COPYING.txt and docs/gpl-3.0.txt for more information.
|
|
111
|
+
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
|
|
2
|
+
# Table of Contents
|
|
3
|
+
|
|
4
|
+
1. [Introduction](#org84b31e8)
|
|
5
|
+
2. [Getting Started](#org40d49b0)
|
|
6
|
+
3. [Test Suite](#org8a0a7f4)
|
|
7
|
+
4. [Contact, Copyright and Licence Information](#org0d159da)
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
<a id="org84b31e8"></a>
|
|
11
|
+
|
|
12
|
+
# Introduction
|
|
13
|
+
|
|
14
|
+
MoinLight is a distribution of libraries and tools for interpreting
|
|
15
|
+
document content in the MoinMoin wiki format together with other
|
|
16
|
+
formats employed in wiki content.
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
<a id="org40d49b0"></a>
|
|
20
|
+
|
|
21
|
+
# Getting Started
|
|
22
|
+
|
|
23
|
+
The moinconvert tool provides a convenient way of converting content
|
|
24
|
+
from Moin format to other formats. For example, the supplied
|
|
25
|
+
documentation can be converted as follows:
|
|
26
|
+
|
|
27
|
+
./moinconvert --input-dir docs/wiki \
|
|
28
|
+
--output-dir docs/html \
|
|
29
|
+
--root MoinLight \
|
|
30
|
+
--document-index index.html \
|
|
31
|
+
--theme mercurial \
|
|
32
|
+
--macros --all
|
|
33
|
+
|
|
34
|
+
This converts all documents in the indicated input directory to HTML
|
|
35
|
+
format, storing the converted documents in the indicated output
|
|
36
|
+
directory, evaluating all macros embedded in the input documents. A
|
|
37
|
+
document index filename is specified for filesystem browsing of the
|
|
38
|
+
output documents.
|
|
39
|
+
|
|
40
|
+
The result of the above command is a collection of documents in
|
|
41
|
+
`docs/html` that can be viewed using a Web browser, with the
|
|
42
|
+
`docs/html/index.html` file being the front page of this collection.
|
|
43
|
+
These documents do not need to be served using a Web browser.
|
|
44
|
+
|
|
45
|
+
By omitting the `--document-index` option (and accompanying filename), a
|
|
46
|
+
version of the documents can be produced that is more appropriate for
|
|
47
|
+
serving by a Web browser, featuring links that do not include the
|
|
48
|
+
index.html filename.
|
|
49
|
+
|
|
50
|
+
See the bundled documentation for more details of the software and how
|
|
51
|
+
it can be used:
|
|
52
|
+
|
|
53
|
+
- `docs/wiki/MoinLight` (and accompanying files) are the documentation
|
|
54
|
+
files in `Moin format`
|
|
55
|
+
- `docs/html/index.html` is the front page of the documentation converted
|
|
56
|
+
to `HTML format`
|
|
57
|
+
|
|
58
|
+
A more convenient way of generating the documentation is to use the
|
|
59
|
+
following command:
|
|
60
|
+
|
|
61
|
+
./makedoc.py
|
|
62
|
+
|
|
63
|
+
For Web server deployment, add the `--web` option for cleaner links:
|
|
64
|
+
|
|
65
|
+
docs/tools/make_docs.sh --web
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
<a id="org8a0a7f4"></a>
|
|
69
|
+
|
|
70
|
+
# Test Suite
|
|
71
|
+
|
|
72
|
+
A test suite is provided to exercise the toolchain and expose
|
|
73
|
+
regressions. More information is available by running the
|
|
74
|
+
`test_parser.py` script (found in the tests directory) with the
|
|
75
|
+
appropriate option:
|
|
76
|
+
|
|
77
|
+
tests/test_parser.py --help
|
|
78
|
+
|
|
79
|
+
Running it with the `--quiet` option provides a quick way of verifying
|
|
80
|
+
the tested behaviour of the software.
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
<a id="org0d159da"></a>
|
|
84
|
+
|
|
85
|
+
# Contact, Copyright and Licence Information
|
|
86
|
+
|
|
87
|
+
See the following Web pages for more information about this work:
|
|
88
|
+
|
|
89
|
+
<http://projects.boddie.org.uk/MoinLight>
|
|
90
|
+
|
|
91
|
+
The author can be contacted at the following e-mail address:
|
|
92
|
+
|
|
93
|
+
paul@boddie.org.uk
|
|
94
|
+
|
|
95
|
+
Copyright and licence information can be found in the docs directory -
|
|
96
|
+
see docs/COPYING.txt and docs/gpl-3.0.txt for more information.
|
|
97
|
+
|
|
@@ -0,0 +1,78 @@
|
|
|
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.
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
Licence Agreement
|
|
2
|
+
-----------------
|
|
3
|
+
|
|
4
|
+
All original work in this distribution is covered by the following copyright
|
|
5
|
+
and licensing information:
|
|
6
|
+
|
|
7
|
+
Copyright (C) 2017-2026 Paul Boddie <paul@boddie.org.uk>
|
|
8
|
+
|
|
9
|
+
This program is free software; you can redistribute it and/or modify it under
|
|
10
|
+
the terms of the GNU General Public License as published by the Free Software
|
|
11
|
+
Foundation; either version 3 of the License, or (at your option) any later
|
|
12
|
+
version.
|
|
13
|
+
|
|
14
|
+
This program is distributed in the hope that it will be useful, but WITHOUT
|
|
15
|
+
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
16
|
+
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
|
17
|
+
details.
|
|
18
|
+
|
|
19
|
+
You should have received a copy of the GNU General Public License along with
|
|
20
|
+
this program. If not, see <http://www.gnu.org/licenses/>.
|
|
21
|
+
|
|
22
|
+
----
|
|
23
|
+
|
|
24
|
+
Other code has been incorporated into this distribution and is covered by the
|
|
25
|
+
following copyrights:
|
|
26
|
+
|
|
27
|
+
moinformat/resources/notugly.xsl:
|
|
28
|
+
|
|
29
|
+
Copyright (c) 2012 Vidar Hokstad <vidar@hokstad.com>
|
|
30
|
+
Copyright (c) 2016, 2019 Paul Boddie <paul@boddie.org.uk>
|
|
31
|
+
|
|
32
|
+
Permission is hereby granted, free of charge, to any person obtaining a
|
|
33
|
+
copy of this software and associated documentation files (the "Software"),
|
|
34
|
+
to deal in the Software without restriction, including without limitation
|
|
35
|
+
the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
36
|
+
and/or sell copies of the Software, and to permit persons to whom the
|
|
37
|
+
Software is furnished to do so, subject to the following conditions:
|
|
38
|
+
|
|
39
|
+
The above copyright notice and this permission notice shall be included
|
|
40
|
+
in all copies or substantial portions of the Software.
|
|
41
|
+
|
|
42
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
43
|
+
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
44
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
|
45
|
+
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
|
|
46
|
+
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
|
|
47
|
+
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
48
|
+
OTHER DEALINGS IN THE SOFTWARE.
|