Mercurial > hg > batmud > ggrtf

annotate docs/README.txt @ 1643:5d56f1311d46

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update build dependencies very slightly.
author Matti Hamalainen <ccr@tnsp.org>
date Sat, 30 Jan 2021 15:45:11 +0200
parents 173e6e3efe58
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1152
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
1 Manual building instructions
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
2 ============================
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
3
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
4 NOTICE! Typically the end user (that probably means you) does not need to
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
5 build the manuals, as the pre-built manual comes in several formats within
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
6 the GgrTF packages.
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
7
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
8 However, if you wish to re-build the manual from source, you will need
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
9 the following tools / utilities on an UNIX-style platform:
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
10
1643
5d56f1311d46 Update build dependencies very slightly.
Matti Hamalainen <ccr@tnsp.org>
parents: 1552
diff changeset
11 - GNU Bash or similar compatible shell
1216
1f779034319e Cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 1153
diff changeset
12 - Either GraphicsMagick, ImageMagick or NetPBM utils
1152
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
13 - DocBook XML utilities
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
14 - xsltproc
1216
1f779034319e Cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 1153
diff changeset
15 - Perl 5.8 or later
1152
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
16
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
17 Optionally you can also benefit from:
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
18 - HTML Tidy <http://tidy.sourceforge.net/>
1552
173e6e3efe58 Mention FOP.
Matti Hamalainen <ccr@tnsp.org>
parents: 1216
diff changeset
19 - fop <http://xmlgraphics.apache.org/fop/>
1643
5d56f1311d46 Update build dependencies very slightly.
Matti Hamalainen <ccr@tnsp.org>
parents: 1552
diff changeset
20 ("apt install fop" in Debian / Ubuntu)
1152
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
21
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
22 When these depencies have been satisfied, you can try building
7d1d810148d6 Add a short document about requirements for building the documentation, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
23 the manual by running 'build-docs.sh'.
1153
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
24
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
25
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
26 Miscellanea
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
27 ===========
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
28 The documentation has been written using DocBook XML, with some
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
29 custom extensions that are handled and converted to plain XML by the
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
30 Perl-based utilities. The following utilities are used:
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
31
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
32 - tfdoc.pl: Enables grabbing additional documentation embedded inside
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
33 the various TinyFugue scripts. The documentation is inserted to
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
34 matching places in the XML marked via special tags.
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
35
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
36 - normalizeml.pl: "Normalizes" the SGML/XML document, removing any
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
37 "recursive" entity definitions (similar to macros). Definitions like
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
38 these are useful, but unfortunately XML/SGML does not seem to support
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
39 anything like them.
ab95f0d7f7c7 Add some notes about the custom utilities, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 1152
diff changeset
40