# HG changeset patch # User Paul Boddie # Date 1555364571 -7200 # Node ID e1da4a0e95ada9750274727e5948851a753a63d1 # Parent b310a5ca9290fb45838fb989009a36217dbad1c7 Expanded and reorganised the front page; added a syntax description page. diff -r b310a5ca9290 -r e1da4a0e95ad docs/tools/make_docs.sh --- a/docs/tools/make_docs.sh Mon Apr 15 23:42:00 2019 +0200 +++ b/docs/tools/make_docs.sh Mon Apr 15 23:42:51 2019 +0200 @@ -6,7 +6,11 @@ ROOT="MoinLight" -MAPPING='--mapping WikiPedia https://en.wikipedia.org/wiki/' +MAPPING=' +--mapping WikiPedia https://en.wikipedia.org/wiki/ +--mapping MoinMoin https://moinmo.in/ +' + THEME='--theme mercurial' if [ "$1" = '--web' ] ; then diff -r b310a5ca9290 -r e1da4a0e95ad docs/wiki/MoinLight --- a/docs/wiki/MoinLight Mon Apr 15 23:42:00 2019 +0200 +++ b/docs/wiki/MoinLight Mon Apr 15 23:42:51 2019 +0200 @@ -63,6 +63,8 @@ * To be able to work with the content more easily and to develop tools for doing so +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 @@ -87,10 +89,24 @@ for styling and wrapping the output, `--macros` for expanding macros in documents, and `--format` for choosing alternative output formats. +See [[/moinconvert]] for more information on the `moinconvert` program. + == Abstractions and Architecture == MoinLight provides a number of abstractions for working with Moin wiki content: + * [[/Input]] contexts permit the interpretation of existing content in + certain ways so that a collection of text files can be treated like a wiki + + * [[/Output]] contexts permit the publishing of content in certain + ways so that wiki content can be shared on the Web + + * [[/Macros]] define locations in documents where content is to be inserted + or expanded + + * [[/Metadata]] is used to configure the processing of content by defining + the different abstractions involved + * [[/Parsers]] interpret various forms of markup-related content, producing a document tree representation that can be inspected and processed @@ -100,15 +116,6 @@ * [[/Themes]] augment serialised content with additional details and resources - * [[/Macros]] define locations in documents where content is to be inserted - or expanded - - * [[/Input]] contexts permit the interpretation of existing content in - certain ways so that a collection of text files can be treated like a wiki - - * [[/Output]] contexts permit the publishing of content in certain - ways so that wiki content can be shared on the Web - A major objective with MoinLight is to be able to produce static files that can be served using a typical Web server without any need for scripts, applications or other kinds of dynamic content. Other objectives are described diff -r b310a5ca9290 -r e1da4a0e95ad docs/wiki/MoinSyntax --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/wiki/MoinSyntax Mon Apr 15 23:42:51 2019 +0200 @@ -0,0 +1,63 @@ += Moin Format Syntax = + +The syntax of the wiki format is described in various locations on the +[[MoinMoin:]] site: + + * [[MoinMoin:HelpOnMoinWikiSyntax]] + * [[MoinMoin:HelpOnEditing]] + +Various enhancements are introduced in MoinLight, and these are described +below. + +== Anchor == + +Syntax: + +{{{ +((identifier)) +}}} + +Effect: + +Introduce an anchor employing a fragment identifier that can be reached by a +link employing the identifier. + +Related: + +The {{{<>}}} macro has the same function. + +== Line Break == + +Syntax: + +{{{ +\\ +}}} + +Effect: + +Introduces a line break in the page. + +Related: + +The {{{<
>}}} macro has the same function. + +== Verbatim == + +Syntax: + +{{{ +<<>> +}}} + +Effect: + +Introduce the enclosed text verbatim in the page, ignoring any other markup +features that may be present. + +Related: + +The {{{<>}}} macro has a similar function, but +being a macro it imposes limitations on the enclosed content, such as not +permitting newlines.