BuildingDocumentation

Differences between revisions 14 and 15
⇤ ← Revision 14 as of 2007-05-03 07:34:22 →
Size: 1403
Editor: 212-139-109-89
Comment: link to /PDF
← Revision 15 as of 2007-05-03 07:40:25 → ⇥
Size: 2388
Editor: 212-139-109-89
Comment: notes for feisty and translators
Deletions are marked like this. Additions are marked like this.
Line 22: Line 22:
'''Note:''' The above process describes how to build the documents in English. If you wish to build translated versions of the documentation, you will need to edit the Makefile manually and replace each instance of {{{C/}}} with the appropriate language code. If you need help with this, you should [:DocumentationTeam/Contact:contact] the Documentation team.

= Note for Ubuntu 7.04 (Feisty Fawn) =

Since Ubuntu 7.04, the Ubuntu system documentation has split into several categories, many of which link between them using an internal Gnome/KDE linking system. When the documents are converted into HTML, this results in a lot of links being broken. For this reason we use a [https://docteam.ubuntu.com/repos/branches/feisty/ubuntu/fix-urls.sh script] named {{{fix-urls.sh}}} to correct the broken internal links.

If building translated copies of the documentation, you will need to adjust the script and replace each instance of {{{C/}}} with the relevant language code.
 

Building Documentation Yourself

Documentation which is written in Docbook XML can be quite easily converted into other formats. This page deals with converting to HTML. If you are interested in converting to PDF format, see ["/PDF"]

  1. Set up a copy of the docteam svn repository as described on [:DocumentationTeam/Repository:Repository page]. If you want the latest documents, get the svn trunk. If you want to build documents for existing Ubuntu releases, get the appropriate svn branch as described on that page.

  2. Install at least the following packages: make & docbook-xsl.

  3. Open a terminal and change to the appropriate directory (ubuntu-doc/ubuntu, ubuntu-doc/edubuntu, ubuntu-doc/kubuntu or ubuntu-doc/generic).

  4. Type: 

    make all

This command will build HTML versions of all the documents available.

Generally there are a number of other make targets which you can use to build specific or miscellaneous documents. Read through the Makefile to discover what these are.

Note: Previews of all docteam work in progress are also available on http://docteam.ubuntu.com

Note: You will see a lot of warnings like the following, which can be safely ignored:

  • No localization exists for "c" or "". Using default "en".

Note: The above process describes how to build the documents in English. If you wish to build translated versions of the documentation, you will need to edit the Makefile manually and replace each instance of C/ with the appropriate language code. If you need help with this, you should [:DocumentationTeam/Contact:contact] the Documentation team.

Note for Ubuntu 7.04 (Feisty Fawn)

Since Ubuntu 7.04, the Ubuntu system documentation has split into several categories, many of which link between them using an internal Gnome/KDE linking system. When the documents are converted into HTML, this results in a lot of links being broken. For this reason we use a [https://docteam.ubuntu.com/repos/branches/feisty/ubuntu/fix-urls.sh script] named fix-urls.sh to correct the broken internal links.

If building translated copies of the documentation, you will need to adjust the script and replace each instance of C/ with the relevant language code.

CategoryDocteam

DocumentationTeam/SystemDocumentation/BuildingDocumentation (last edited 2020-04-23 19:58:36 by dsmythies)