# HG changeset patch # User Paul Boddie # Date 1580665992 -3600 # Node ID d9800aae37f0cffaf7b27d19f4764790eb5095f2 # Parent 5647200b8695d79fef8f013c31c8de53829f6730 Updated and expanded the documentation. diff -r 5647200b8695 -r d9800aae37f0 docs/wiki/Changelog --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/wiki/Changelog Sun Feb 02 18:53:12 2020 +0100 @@ -0,0 +1,4 @@ += Changelog = + +Currently, only an initial release has been made. See the repository history +for change-related information. diff -r 5647200b8695 -r d9800aae37f0 docs/wiki/Downloads --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/wiki/Downloads Sun Feb 02 18:53:12 2020 +0100 @@ -0,0 +1,80 @@ += Downloads = + +Remember that certain [[../Prerequisites|prerequisites]] are needed for the +software to work. + +== Copyright and Licence == + +The MoinLight distribution is made available according to the terms of the +[[http://www.gnu.org/copyleft/gpl.html|GNU GPL (version 3 or later)]]. See +the `docs/COPYING.txt` and `docs/gpl-3.0.txt` files in the source code +distribution for details. + +== Repository == + +The source code repository is located at the following location: + +https://hg.boddie.org.uk/MoinLight + +The repository can be cloned using [[https://www.mercurial-scm.org/|Mercurial]] +as follows: + +{{{ +hg clone https://hg.boddie.org.uk/MoinLight +}}} + +If you are familiar with version control systems and Mercurial in particular, +it can be convenient to use this approach to obtain and update the software, +although you should be aware that updates made available in the repository may, +if deployed, cause the software to not function correctly on occasion, even if +attempts are made to avoid such situations. Therefore, you should choose to +update with care and be prepared to switch to a "known working" revision if +necessary. + +== Releases == + +{{{#!wiki tip +See below for downloadable archives. +}}} + +Releases are tagged in the repository. The currently-supported releases are +listed here for convenience: + +{{{#!table +'''Release''' || '''Details''' +== +0.1 || [[https://hg.boddie.org.uk/MoinLight/rev/rel-0-1|changeset]] + .. [[https://hg.boddie.org.uk/MoinLight/file/rel-0-1|files]] +}}} + +Details of changes introduced in each new release can be found in the +[[../Changelog|changelog]]. + +=== Archives === + +Downloadable archives are provided below. Choose "get" to download the +appropriate file. + +<> +<> + +=== Signatures === + +Downloadable archive signatures are provided below. Choose "get" to download +the appropriate file. + +<> +<> + +To verify an archive, download the archive and accompanying signature file to +the same location and then run a command of the following form: + +{{{ +gpg --verify +}}} + +For example: + +{{{ +gpg --verify MoinLight-0.1.tar.bz2.asc MoinLight-0.1.tar.bz2 +}}} diff -r 5647200b8695 -r d9800aae37f0 docs/wiki/MoinLight --- a/docs/wiki/MoinLight Sun Feb 02 18:53:02 2020 +0100 +++ b/docs/wiki/MoinLight Sun Feb 02 18:53:12 2020 +0100 @@ -1,5 +1,10 @@ = MoinLight = +{{{#!table +[[/Downloads|Downloads]] || [[#GettingStarted|Getting Started]] || +[[#Architecture|Architecture]] || [[/Roadmap|Roadmap]] +}}} + MoinLight is a distribution of programs and libraries for working with content encoded in the [[https://moinmo.in/|MoinMoin]] wiki markup format. This markup format is generally concise and supports many kinds of HTML document features @@ -25,7 +30,7 @@ subgraph { rank=same; tree [label="Document tree",shape=folder,style=filled,fillcolor=cyan]; - evaluation [label="Macro evaluation",shape=ellipse]; + evaluation [label="Macro evaluation",URL="Macros",shape=ellipse]; } serialiser [label="Serialiser",URL="Serialisers"]; @@ -65,6 +70,7 @@ The wiki format is described in the [[/MoinSyntax|syntax documentation]]. +<> == Getting Started == To convert a collection of wiki pages in a directory (with `pages` containing @@ -91,6 +97,7 @@ See [[/moinconvert]] for more information on the `moinconvert` program. +<> == Abstractions and Architecture == MoinLight provides a number of abstractions for working with Moin wiki content: diff -r 5647200b8695 -r d9800aae37f0 docs/wiki/Prerequisites --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/wiki/Prerequisites Sun Feb 02 18:53:12 2020 +0100 @@ -0,0 +1,23 @@ += Prerequisites = + +MoinLight has the following general dependencies or prerequisites: + +{{{#!table +'''Prerequisite''' || '''Suggestions''' +== +Python 2.x +(needed to run tools) || Debian package: python \\ + .. Tested with Debian version 2.7.9-1 \\ + .. [[https://www.python.org/]] +== +Graphviz +(needed for graph content) || Debian package: graphviz \\ + .. Tested with Debian version 2.38.0-7 \\ + .. [[http://graphviz.org/]] +== +xsltproc +(for XSL transformations on +SVG graph output) || Debian package: xsltproc \\ + .. Tested with Debian version 1.1.28-2+deb8u6 \\ + .. [[http://xmlsoft.org/xslt/]] +}}} diff -r 5647200b8695 -r d9800aae37f0 docs/wiki/Roadmap --- a/docs/wiki/Roadmap Sun Feb 02 18:53:02 2020 +0100 +++ b/docs/wiki/Roadmap Sun Feb 02 18:53:12 2020 +0100 @@ -56,3 +56,52 @@ are superfluous or inappropriate to the core HTML representation of the document, but which can be interpreted in order to restore the form of the original document. + +== Configuration Files == + +Instead of configuring the conversion [[Metadata|metadata]] programmatically +or using command line options with the [[moinconvert]] tool, it would be +useful to be able to define settings in configuration files. + +== Externally Available Extensions == + +Currently, the extensions (macros, themes, parsers, and so on) available to +MoinLight are defined within the `moinformat` package. However, it should be +possible to define extra extensions that reside in other locations. + +== Themed Output for Extensions == + +Macros and other extensions should be able to provide specific theme resources +that are referenced in page output and bundled in the deployed content. + +== Pragmas and Directives == + +In order to adjust the handling and display of content, these features of Moin +should be supported, with the ability to define handlers. + +== Section Numbering == + +Effectively taking table of contents numbering, headings should be numbered if +requested. + +== Variables and Wikidicts == + +These features of Moin should be supported since they permit convenient +customisation of content. + +== Macros == + +=== Include === + +This macro has proven useful in Moin to combine page content. To support it +usefully, it must interact sensibly with tables of contents, perhaps requiring +adjustments to the table of contents macro to avoid such tables appearing on +included pages, also causing top-level tables to reference sections in the +included pages. + +=== Table of Contents === + +Building on the ability to be able to provide its own stylesheet resources, +the macro should also support expandable entries, perhaps using form controls +so that a concise, single-level table of contents can be shown and expanded as +necessary.