1.1 --- a/docs/tools/make_docs.sh Mon Apr 15 23:42:00 2019 +0200
1.2 +++ b/docs/tools/make_docs.sh Mon Apr 15 23:42:51 2019 +0200
1.3 @@ -6,7 +6,11 @@
1.4
1.5 ROOT="MoinLight"
1.6
1.7 -MAPPING='--mapping WikiPedia https://en.wikipedia.org/wiki/'
1.8 +MAPPING='
1.9 +--mapping WikiPedia https://en.wikipedia.org/wiki/
1.10 +--mapping MoinMoin https://moinmo.in/
1.11 +'
1.12 +
1.13 THEME='--theme mercurial'
1.14
1.15 if [ "$1" = '--web' ] ; then
2.1 --- a/docs/wiki/MoinLight Mon Apr 15 23:42:00 2019 +0200
2.2 +++ b/docs/wiki/MoinLight Mon Apr 15 23:42:51 2019 +0200
2.3 @@ -63,6 +63,8 @@
2.4 * To be able to work with the content more easily and to develop tools for
2.5 doing so
2.6
2.7 +The wiki format is described in the [[/MoinSyntax|syntax documentation]].
2.8 +
2.9 == Getting Started ==
2.10
2.11 To convert a collection of wiki pages in a directory (with `pages` containing
2.12 @@ -87,10 +89,24 @@
2.13 for styling and wrapping the output, `--macros` for expanding macros in
2.14 documents, and `--format` for choosing alternative output formats.
2.15
2.16 +See [[/moinconvert]] for more information on the `moinconvert` program.
2.17 +
2.18 == Abstractions and Architecture ==
2.19
2.20 MoinLight provides a number of abstractions for working with Moin wiki content:
2.21
2.22 + * [[/Input]] contexts permit the interpretation of existing content in
2.23 + certain ways so that a collection of text files can be treated like a wiki
2.24 +
2.25 + * [[/Output]] contexts permit the publishing of content in certain
2.26 + ways so that wiki content can be shared on the Web
2.27 +
2.28 + * [[/Macros]] define locations in documents where content is to be inserted
2.29 + or expanded
2.30 +
2.31 + * [[/Metadata]] is used to configure the processing of content by defining
2.32 + the different abstractions involved
2.33 +
2.34 * [[/Parsers]] interpret various forms of markup-related content, producing a
2.35 document tree representation that can be inspected and processed
2.36
2.37 @@ -100,15 +116,6 @@
2.38 * [[/Themes]] augment serialised content with additional details and
2.39 resources
2.40
2.41 - * [[/Macros]] define locations in documents where content is to be inserted
2.42 - or expanded
2.43 -
2.44 - * [[/Input]] contexts permit the interpretation of existing content in
2.45 - certain ways so that a collection of text files can be treated like a wiki
2.46 -
2.47 - * [[/Output]] contexts permit the publishing of content in certain
2.48 - ways so that wiki content can be shared on the Web
2.49 -
2.50 A major objective with MoinLight is to be able to produce static files that
2.51 can be served using a typical Web server without any need for scripts,
2.52 applications or other kinds of dynamic content. Other objectives are described
3.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
3.2 +++ b/docs/wiki/MoinSyntax Mon Apr 15 23:42:51 2019 +0200
3.3 @@ -0,0 +1,63 @@
3.4 += Moin Format Syntax =
3.5 +
3.6 +The syntax of the wiki format is described in various locations on the
3.7 +[[MoinMoin:]] site:
3.8 +
3.9 + * [[MoinMoin:HelpOnMoinWikiSyntax]]
3.10 + * [[MoinMoin:HelpOnEditing]]
3.11 +
3.12 +Various enhancements are introduced in MoinLight, and these are described
3.13 +below.
3.14 +
3.15 +== Anchor ==
3.16 +
3.17 +Syntax:
3.18 +
3.19 +{{{
3.20 +((identifier))
3.21 +}}}
3.22 +
3.23 +Effect:
3.24 +
3.25 +Introduce an anchor employing a fragment identifier that can be reached by a
3.26 +link employing the identifier.
3.27 +
3.28 +Related:
3.29 +
3.30 +The {{{<<Anchor(identifier)>>}}} macro has the same function.
3.31 +
3.32 +== Line Break ==
3.33 +
3.34 +Syntax:
3.35 +
3.36 +{{{
3.37 +\\
3.38 +}}}
3.39 +
3.40 +Effect:
3.41 +
3.42 +Introduces a line break in the page.
3.43 +
3.44 +Related:
3.45 +
3.46 +The {{{<<BR>>}}} macro has the same function.
3.47 +
3.48 +== Verbatim ==
3.49 +
3.50 +Syntax:
3.51 +
3.52 +{{{
3.53 +<<<some verbatim
3.54 +text>>>
3.55 +}}}
3.56 +
3.57 +Effect:
3.58 +
3.59 +Introduce the enclosed text verbatim in the page, ignoring any other markup
3.60 +features that may be present.
3.61 +
3.62 +Related:
3.63 +
3.64 +The {{{<<Verbatim(some verbatim text)>>}}} macro has a similar function, but
3.65 +being a macro it imposes limitations on the enclosed content, such as not
3.66 +permitting newlines.