1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/docs/wiki/Changelog Sun Feb 02 18:53:12 2020 +0100
1.3 @@ -0,0 +1,4 @@
1.4 += Changelog =
1.5 +
1.6 +Currently, only an initial release has been made. See the repository history
1.7 +for change-related information.
2.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
2.2 +++ b/docs/wiki/Downloads Sun Feb 02 18:53:12 2020 +0100
2.3 @@ -0,0 +1,80 @@
2.4 += Downloads =
2.5 +
2.6 +Remember that certain [[../Prerequisites|prerequisites]] are needed for the
2.7 +software to work.
2.8 +
2.9 +== Copyright and Licence ==
2.10 +
2.11 +The MoinLight distribution is made available according to the terms of the
2.12 +[[http://www.gnu.org/copyleft/gpl.html|GNU GPL (version 3 or later)]]. See
2.13 +the `docs/COPYING.txt` and `docs/gpl-3.0.txt` files in the source code
2.14 +distribution for details.
2.15 +
2.16 +== Repository ==
2.17 +
2.18 +The source code repository is located at the following location:
2.19 +
2.20 +https://hg.boddie.org.uk/MoinLight
2.21 +
2.22 +The repository can be cloned using [[https://www.mercurial-scm.org/|Mercurial]]
2.23 +as follows:
2.24 +
2.25 +{{{
2.26 +hg clone https://hg.boddie.org.uk/MoinLight
2.27 +}}}
2.28 +
2.29 +If you are familiar with version control systems and Mercurial in particular,
2.30 +it can be convenient to use this approach to obtain and update the software,
2.31 +although you should be aware that updates made available in the repository may,
2.32 +if deployed, cause the software to not function correctly on occasion, even if
2.33 +attempts are made to avoid such situations. Therefore, you should choose to
2.34 +update with care and be prepared to switch to a "known working" revision if
2.35 +necessary.
2.36 +
2.37 +== Releases ==
2.38 +
2.39 +{{{#!wiki tip
2.40 +See below for downloadable archives.
2.41 +}}}
2.42 +
2.43 +Releases are tagged in the repository. The currently-supported releases are
2.44 +listed here for convenience:
2.45 +
2.46 +{{{#!table
2.47 +'''Release''' || '''Details'''
2.48 +==
2.49 +0.1 || [[https://hg.boddie.org.uk/MoinLight/rev/rel-0-1|changeset]]
2.50 + .. [[https://hg.boddie.org.uk/MoinLight/file/rel-0-1|files]]
2.51 +}}}
2.52 +
2.53 +Details of changes introduced in each new release can be found in the
2.54 +[[../Changelog|changelog]].
2.55 +
2.56 +=== Archives ===
2.57 +
2.58 +Downloadable archives are provided below. Choose "get" to download the
2.59 +appropriate file.
2.60 +
2.61 +<<AttachList(,application/x-tar)>>
2.62 +<<AttachList(,application/x-bzip2)>>
2.63 +
2.64 +=== Signatures ===
2.65 +
2.66 +Downloadable archive signatures are provided below. Choose "get" to download
2.67 +the appropriate file.
2.68 +
2.69 +<<AttachList(,text/plain)>>
2.70 +<<AttachList(,application/pgp-signature)>>
2.71 +
2.72 +To verify an archive, download the archive and accompanying signature file to
2.73 +the same location and then run a command of the following form:
2.74 +
2.75 +{{{
2.76 +gpg --verify <signature file> <archive file>
2.77 +}}}
2.78 +
2.79 +For example:
2.80 +
2.81 +{{{
2.82 +gpg --verify MoinLight-0.1.tar.bz2.asc MoinLight-0.1.tar.bz2
2.83 +}}}
3.1 --- a/docs/wiki/MoinLight Sun Feb 02 18:53:02 2020 +0100
3.2 +++ b/docs/wiki/MoinLight Sun Feb 02 18:53:12 2020 +0100
3.3 @@ -1,5 +1,10 @@
3.4 = MoinLight =
3.5
3.6 +{{{#!table
3.7 +[[/Downloads|Downloads]] || [[#GettingStarted|Getting Started]] ||
3.8 +[[#Architecture|Architecture]] || [[/Roadmap|Roadmap]]
3.9 +}}}
3.10 +
3.11 MoinLight is a distribution of programs and libraries for working with content
3.12 encoded in the [[https://moinmo.in/|MoinMoin]] wiki markup format. This markup
3.13 format is generally concise and supports many kinds of HTML document features
3.14 @@ -25,7 +30,7 @@
3.15 subgraph {
3.16 rank=same;
3.17 tree [label="Document tree",shape=folder,style=filled,fillcolor=cyan];
3.18 - evaluation [label="Macro evaluation",shape=ellipse];
3.19 + evaluation [label="Macro evaluation",URL="Macros",shape=ellipse];
3.20 }
3.21
3.22 serialiser [label="Serialiser",URL="Serialisers"];
3.23 @@ -65,6 +70,7 @@
3.24
3.25 The wiki format is described in the [[/MoinSyntax|syntax documentation]].
3.26
3.27 +<<Anchor(GettingStarted)>>
3.28 == Getting Started ==
3.29
3.30 To convert a collection of wiki pages in a directory (with `pages` containing
3.31 @@ -91,6 +97,7 @@
3.32
3.33 See [[/moinconvert]] for more information on the `moinconvert` program.
3.34
3.35 +<<Anchor(Architecture)>>
3.36 == Abstractions and Architecture ==
3.37
3.38 MoinLight provides a number of abstractions for working with Moin wiki content:
4.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
4.2 +++ b/docs/wiki/Prerequisites Sun Feb 02 18:53:12 2020 +0100
4.3 @@ -0,0 +1,23 @@
4.4 += Prerequisites =
4.5 +
4.6 +MoinLight has the following general dependencies or prerequisites:
4.7 +
4.8 +{{{#!table
4.9 +'''Prerequisite''' || '''Suggestions'''
4.10 +==
4.11 +Python 2.x
4.12 +(needed to run tools) || Debian package: python \\
4.13 + .. Tested with Debian version 2.7.9-1 \\
4.14 + .. [[https://www.python.org/]]
4.15 +==
4.16 +Graphviz
4.17 +(needed for graph content) || Debian package: graphviz \\
4.18 + .. Tested with Debian version 2.38.0-7 \\
4.19 + .. [[http://graphviz.org/]]
4.20 +==
4.21 +xsltproc
4.22 +(for XSL transformations on
4.23 +SVG graph output) || Debian package: xsltproc \\
4.24 + .. Tested with Debian version 1.1.28-2+deb8u6 \\
4.25 + .. [[http://xmlsoft.org/xslt/]]
4.26 +}}}
5.1 --- a/docs/wiki/Roadmap Sun Feb 02 18:53:02 2020 +0100
5.2 +++ b/docs/wiki/Roadmap Sun Feb 02 18:53:12 2020 +0100
5.3 @@ -56,3 +56,52 @@
5.4 are superfluous or inappropriate to the core HTML representation of the
5.5 document, but which can be interpreted in order to restore the form of the
5.6 original document.
5.7 +
5.8 +== Configuration Files ==
5.9 +
5.10 +Instead of configuring the conversion [[Metadata|metadata]] programmatically
5.11 +or using command line options with the [[moinconvert]] tool, it would be
5.12 +useful to be able to define settings in configuration files.
5.13 +
5.14 +== Externally Available Extensions ==
5.15 +
5.16 +Currently, the extensions (macros, themes, parsers, and so on) available to
5.17 +MoinLight are defined within the `moinformat` package. However, it should be
5.18 +possible to define extra extensions that reside in other locations.
5.19 +
5.20 +== Themed Output for Extensions ==
5.21 +
5.22 +Macros and other extensions should be able to provide specific theme resources
5.23 +that are referenced in page output and bundled in the deployed content.
5.24 +
5.25 +== Pragmas and Directives ==
5.26 +
5.27 +In order to adjust the handling and display of content, these features of Moin
5.28 +should be supported, with the ability to define handlers.
5.29 +
5.30 +== Section Numbering ==
5.31 +
5.32 +Effectively taking table of contents numbering, headings should be numbered if
5.33 +requested.
5.34 +
5.35 +== Variables and Wikidicts ==
5.36 +
5.37 +These features of Moin should be supported since they permit convenient
5.38 +customisation of content.
5.39 +
5.40 +== Macros ==
5.41 +
5.42 +=== Include ===
5.43 +
5.44 +This macro has proven useful in Moin to combine page content. To support it
5.45 +usefully, it must interact sensibly with tables of contents, perhaps requiring
5.46 +adjustments to the table of contents macro to avoid such tables appearing on
5.47 +included pages, also causing top-level tables to reference sections in the
5.48 +included pages.
5.49 +
5.50 +=== Table of Contents ===
5.51 +
5.52 +Building on the ability to be able to provide its own stylesheet resources,
5.53 +the macro should also support expandable entries, perhaps using form controls
5.54 +so that a concise, single-level table of contents can be shown and expanded as
5.55 +necessary.
