DocteamBuildingDocumentation

The makefile found in the root of the Subversion repository trunk directory can be used to transform the Docbook XML documents into presentational formats. As of this writing the only presentational format is HTML. We expect to add PDF shortly.

To use the makefile you will need to install GNU make (you'll find it in the 'make' package).

Other build dependencies for most of the documentation are the packages 'docbook-xsl' and 'xsltproc'.

To transform a document using make:

1. Make trunk/ your present working directory

2. Run the command

   make [targetname]

If your build is very slow trying to download things from the Internet, try running make as:

XML_CATALOG_FILES=/usr/share/xml/docbook/schema/dtd/4.3/catalog.xml make [targetname]

Make Targets

The makefile provides the following targets:

all

builds all documents

ug

build the User's Guide (UserGuide) (outputs to trunk/build/userguide/)

qg

builds the Quick Guide (QuickGuide) (outputs to trunk/build/quickguide/)

faq

builds the Frequently Asked Questions ([FAQGuide]) (outputs to trunk/build/faqguide/)

ag

builds the Administrators Guide (AdminGuide) (outputs to trunk/build/adminguide/)

abt

builds the About Ubuntu page (AboutUbuntuPage) (outputs to trunk/build/about-ubuntu/home/)

rn

builds the Release Notes (outputs to trunk/build/release-notes/)

status

builds the Project Status Reports (outputs to trunk/build/reports/)

dist

builds documents and prepares a source tarball (outputs to trunk/ubuntu-docs/)

clean

removes any mess made during the builds

Example make command and target:

 make ug

To view any of these documents just open index.html found in the relevant build directory.

CategoryDocteam