mantisbt:docbook
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
mantisbt:docbook [2013/05/10 09:11] – Added reference to publican for docbook in master branch dregad | mantisbt:docbook [2016/07/03 11:26] (current) – [MantisBT 1.3 and later] added new section's contents dregad | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Working with DocBook Manuals ====== | ====== Working with DocBook Manuals ====== | ||
+ | ===== Required Tools ===== | ||
+ | No special tools are needed to edit DocBook files, a plain-text editor is good enough to do the job, although a specialized XML editor may be useful. | ||
- | ===== Required Tools ===== | + | In order to build the manuals however, you need to have a working DocBook tool chain installed on your system. |
- | No special tools are needed to edit DocBook files, but in order to build DocBook manuals, you need to have a DocBook tool chain installed on your system, including GNU Make, OpenJade, and various DocBook tools. | ||
- | The command below installs the toolchain on **Ubuntu**-based systems (tested successfully on Ubuntu 12.04 and 13.04 desktop) | + | ==== MantisBT 1.3 and later ==== |
+ | |||
+ | MantisBT 1.3 uses [[https:// | ||
< | < | ||
- | | + | $ sudo apt-get install publican |
+ | </ | ||
+ | |||
+ | 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, | ||
+ | |||
+ | The command below installs the toolchain on **Ubuntu**-based systems (tested successfully on Ubuntu 12.04 LTS and 13.04 desktop) | ||
+ | < | ||
+ | $ sudo apt-get install docbook docbook-dsssl docbook-slides docbook-utils linuxdoc-tools make openjade xmlto | ||
</ | </ | ||
For **Debian**-based Linux distributions, | 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: | For **Fedora**-based distros, run this command instead: | ||
< | < | ||
- | | + | $ su -c 'yum groupinstall " |
</ | </ | ||
- | To build the docbook in the **master branch**, additional package '' | + | ===== Building a DocBook Manual ===== |
+ | ==== MantisBT 1.3 and later ==== | ||
- | ===== Building a DocBook Manual | + | 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' |
mantisbt/docbook.1368191518.txt.gz · Last modified: 2016/07/03 10:53 (external edit)