# HG changeset patch # User Paul Boddie # Date 1693612292 -7200 # Node ID 70233ea53bf2b0825b82094d6fb05d40c53aba4c # Parent 23edd8f55d402bc56042402c78fef8d586678b7e# Parent a86d8a7da761bd25232ed7f8f634a46b0b3e7f5b Merged changes from the well-defined-instances branch. diff -r 23edd8f55d40 -r 70233ea53bf2 README.txt --- a/README.txt Sat Sep 02 01:48:44 2023 +0200 +++ b/README.txt Sat Sep 02 01:51:32 2023 +0200 @@ -24,6 +24,25 @@ reconfigure such tools. However, an alternative suffix is likely to be introduced in future. +A Note about the Documentation +------------------------------ + +The original content in docs/wiki aims to be readable as plain text under most +circumstances, but the intention is that this content be translated to HTML +since it employs a formatting language based on the MoinMoin wiki format +syntax. + +The following command can be used to generate the HTML form of the +documentation from the main directory of this distribution: + +./docs/tools/make_docs.sh + +Specify the --web option for Web server deployment: + +./docs/tools/make_docs.sh --web + +To generate individual documents, specify their names after any options. + Getting Started =============== @@ -107,27 +126,3 @@ Copyright and licence information can be found in the docs directory - see docs/COPYING.txt and docs/gpl-3.0.txt for more information. - -Generating the Wiki Pages -========================= - -The docs/tools/make_pages.sh script generates a page package for MoinMoin. The -following command will generate a page package called pages.zip using the -pages directory for staging, with Lichen as the page prefix: - -docs/tools/make_pages.sh pages Lichen - -Make sure to include the page prefix where the pages are being deployed in a -wiki with other content at the top level. - -Currently, the wiki pages require the following extensions: - -ImprovedTableParser https://moinmo.in/ParserMarket/ImprovedTableParser - -MoinSupport http://hgweb.boddie.org.uk/MoinSupport - -GraphvizParser https://moinmo.in/ParserMarket/graphviz - -The GraphvizParser requires diagram-tools for the notugly.xsl stylesheet, -although a copy of the stylesheet is provided in the GraphvizParser -distribution for convenience. diff -r 23edd8f55d40 -r 70233ea53bf2 docs/tools/make_docs.sh --- a/docs/tools/make_docs.sh Sat Sep 02 01:48:44 2023 +0200 +++ b/docs/tools/make_docs.sh Sat Sep 02 01:51:32 2023 +0200 @@ -2,7 +2,6 @@ THISDIR=`dirname "$0"` INDIR="$THISDIR/../wiki" -OUTDIR="$THISDIR/../html" ROOT="Lichen" @@ -16,6 +15,13 @@ DOCINDEX='--document-index index.html' fi +if [ "$1" = '-o' ] ; then + OUTDIR="$2" + shift 2 +else + OUTDIR="$THISDIR/../html" +fi + FILENAMES=${*:-'--all'} moinconvert --input-dir "$INDIR" \ diff -r 23edd8f55d40 -r 70233ea53bf2 docs/wiki/Prerequisites --- a/docs/wiki/Prerequisites Sat Sep 02 01:48:44 2023 +0200 +++ b/docs/wiki/Prerequisites Sat Sep 02 01:51:32 2023 +0200 @@ -15,3 +15,6 @@ As Free Software, priority has been given to supporting Lichen on Free Software platforms, with Debian GNU/Linux being the development platform. Proprietary platforms are neither supported nor recommended. + +To generate HTML documentation, the [[https://projects.boddie.org.uk/MoinLight| +MoinLight]] distribution is required.