mantisbt:docbook
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
mantisbt:docbook [2008/02/28 18:40] – giallu | mantisbt:docbook [2016/07/03 11:26] (current) – [MantisBT 1.3 and later] added new section's contents dregad | ||
---|---|---|---|
Line 3: | Line 3: | ||
===== Required Tools ===== | ===== Required Tools ===== | ||
- | No special tools are needed to edit DocBook files, | + | No special tools are needed to edit DocBook files, |
+ | |||
+ | In order to build the manuals | ||
+ | |||
+ | |||
+ | ==== MantisBT 1.3 and later ==== | ||
+ | |||
+ | MantisBT 1.3 uses [[https:// | ||
- | For Debian- or Ubuntu-based Linux distributions, | ||
< | < | ||
- | | + | $ sudo apt-get |
</ | </ | ||
- | For Fedora-based distros, run this command | + | This was tested successfully on Ubuntu 14.04 LTS, but should work with older versions too. |
+ | |||
+ | |||
+ | ==== MantisBT 1.2 ==== | ||
+ | |||
+ | To build MantisBT 1.2 documentation, this tool chain includes //GNU Make//, // | ||
+ | |||
+ | The command | ||
< | < | ||
- | | + | $ sudo apt-get install docbook docbook-dsssl docbook-slides docbook-utils linuxdoc-tools make openjade xmlto |
+ | </ | ||
+ | |||
+ | For **Debian**-based Linux distributions, | ||
+ | < | ||
+ | $ sudo aptitude install docbook docbook-dsssl docbook-slides docbook-utils linuxdoc-tools make openjade xmlto | ||
+ | </ | ||
+ | |||
+ | For **Fedora**-based distros, run this command instead: | ||
+ | < | ||
+ | $ su -c 'yum groupinstall " | ||
</ | </ | ||
===== Building a DocBook Manual ===== | ===== Building a DocBook Manual ===== | ||
+ | |||
+ | ==== MantisBT 1.3 and later ==== | ||
+ | |||
+ | GNU Make files are present in each DocBook' | ||
+ | |||
+ | To build all DocBooks in default // | ||
+ | cd / | ||
+ | make | ||
+ | </ | ||
+ | |||
+ | To process a specific DocBook, first go to the corresponding directory, e.g. for Administrator' | ||
+ | </ | ||
+ | |||
+ | then execute the appropriate command: | ||
+ | |||
+ | * Build it in default (// | ||
+ | * Validate the XML files, without building the DocBook < | ||
+ | * Build a PDF < | ||
+ | * Clean build in all available formats < | ||
+ | |||
+ | This is just a few examples, refer to the [[https:// | ||
+ | |||
+ | It is also possible to manually execute Publican, e.g. < | ||
+ | publican build --langs=en-US --formats=html-desktop, | ||
+ | </ | ||
+ | |||
+ | ==== MantisBT 1.2 ==== | ||
We will use the Developer' | We will use the Developer' | ||
Line 21: | Line 71: | ||
Enter the directory containing the preferred manual: | Enter the directory containing the preferred manual: | ||
< | < | ||
- | $ cd / | + | $ cd / |
</ | </ | ||
Line 41: | Line 91: | ||
$ make pdf html | $ make pdf html | ||
$ make INSTALL_DIR=/ | $ make INSTALL_DIR=/ | ||
+ | </ | ||
+ | |||
+ | - or for cron jobs (order matters): | ||
+ | < | ||
+ | $ make INSTALL_DIR=/ | ||
+ | </ | ||
+ | |||
+ | ===== Simple Build Script ===== | ||
+ | |||
+ | Taking it one step further, there is a Python script in '' | ||
+ | |||
+ | < | ||
+ | $ docbook-manual.py < | ||
+ | </ | ||
+ | |||
+ | The last parameter is optional, and can be a space-separated list of docbook languages to build. | ||
+ | |||
+ | < | ||
+ | $ / | ||
+ | $ tree / | ||
+ | mantis | ||
+ | -- en | ||
+ | ---- administration_guide | ||
+ | ---- developers | ||
+ | -- de | ||
+ | ---- administration_guide | ||
+ | ---- developers | ||
</ | </ |
mantisbt/docbook.1204242036.txt.gz · Last modified: 2008/10/29 04:32 (external edit)