1.1 --- a/README.txt Sat Sep 02 01:48:44 2023 +0200
1.2 +++ b/README.txt Sat Sep 02 01:51:32 2023 +0200
1.3 @@ -24,6 +24,25 @@
1.4 reconfigure such tools. However, an alternative suffix is likely to be
1.5 introduced in future.
1.6
1.7 +A Note about the Documentation
1.8 +------------------------------
1.9 +
1.10 +The original content in docs/wiki aims to be readable as plain text under most
1.11 +circumstances, but the intention is that this content be translated to HTML
1.12 +since it employs a formatting language based on the MoinMoin wiki format
1.13 +syntax.
1.14 +
1.15 +The following command can be used to generate the HTML form of the
1.16 +documentation from the main directory of this distribution:
1.17 +
1.18 +./docs/tools/make_docs.sh
1.19 +
1.20 +Specify the --web option for Web server deployment:
1.21 +
1.22 +./docs/tools/make_docs.sh --web
1.23 +
1.24 +To generate individual documents, specify their names after any options.
1.25 +
1.26 Getting Started
1.27 ===============
1.28
1.29 @@ -107,27 +126,3 @@
1.30
1.31 Copyright and licence information can be found in the docs directory - see
1.32 docs/COPYING.txt and docs/gpl-3.0.txt for more information.
1.33 -
1.34 -Generating the Wiki Pages
1.35 -=========================
1.36 -
1.37 -The docs/tools/make_pages.sh script generates a page package for MoinMoin. The
1.38 -following command will generate a page package called pages.zip using the
1.39 -pages directory for staging, with Lichen as the page prefix:
1.40 -
1.41 -docs/tools/make_pages.sh pages Lichen
1.42 -
1.43 -Make sure to include the page prefix where the pages are being deployed in a
1.44 -wiki with other content at the top level.
1.45 -
1.46 -Currently, the wiki pages require the following extensions:
1.47 -
1.48 -ImprovedTableParser https://moinmo.in/ParserMarket/ImprovedTableParser
1.49 -
1.50 -MoinSupport http://hgweb.boddie.org.uk/MoinSupport
1.51 -
1.52 -GraphvizParser https://moinmo.in/ParserMarket/graphviz
1.53 -
1.54 -The GraphvizParser requires diagram-tools for the notugly.xsl stylesheet,
1.55 -although a copy of the stylesheet is provided in the GraphvizParser
1.56 -distribution for convenience.
2.1 --- a/docs/tools/make_docs.sh Sat Sep 02 01:48:44 2023 +0200
2.2 +++ b/docs/tools/make_docs.sh Sat Sep 02 01:51:32 2023 +0200
2.3 @@ -2,7 +2,6 @@
2.4
2.5 THISDIR=`dirname "$0"`
2.6 INDIR="$THISDIR/../wiki"
2.7 -OUTDIR="$THISDIR/../html"
2.8
2.9 ROOT="Lichen"
2.10
2.11 @@ -16,6 +15,13 @@
2.12 DOCINDEX='--document-index index.html'
2.13 fi
2.14
2.15 +if [ "$1" = '-o' ] ; then
2.16 + OUTDIR="$2"
2.17 + shift 2
2.18 +else
2.19 + OUTDIR="$THISDIR/../html"
2.20 +fi
2.21 +
2.22 FILENAMES=${*:-'--all'}
2.23
2.24 moinconvert --input-dir "$INDIR" \
3.1 --- a/docs/wiki/Prerequisites Sat Sep 02 01:48:44 2023 +0200
3.2 +++ b/docs/wiki/Prerequisites Sat Sep 02 01:51:32 2023 +0200
3.3 @@ -15,3 +15,6 @@
3.4 As Free Software, priority has been given to supporting Lichen on Free Software
3.5 platforms, with Debian GNU/Linux being the development platform. Proprietary
3.6 platforms are neither supported nor recommended.
3.7 +
3.8 +To generate HTML documentation, the [[https://projects.boddie.org.uk/MoinLight|
3.9 +MoinLight]] distribution is required.