BuildingDocumentation
|
Size: 1796
Comment: imported from the old wiki
|
Size: 3416
Comment: add menubar
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = DocteamBuildingDocumentation = | #title Building the System Documentation |
| Line 3: | Line 3: |
| 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. | <<Include(DocumentationTeam/SystemDocumentation/MenuBar)>> |
| Line 5: | Line 5: |
| To use the makefile you will need to install GNU make (you'll find it in the 'make' package). | 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]]. |
| Line 7: | Line 7: |
| Other build dependencies for most of the documentation are the packages 'docbook-xsl' and 'xsltproc'. | = Building HTML Documentation = |
| Line 9: | Line 9: |
| To transform a document using make: | 1. Set up a copy of the docteam bzr branch as described on [[DocumentationTeam/SystemDocumentation/Repository|Repository page]]. Choose the appropriate branch for the version of Ubuntu documentation you wish to build. 1. Install at least the following packages: [[apt:make|make]] and [[apt:docbook-xsl|docbook-xsl]]. 1. Type: {{{ make all}}} |
| Line 11: | Line 14: |
| 1. Make trunk/ your present working directory 2. Run the command {{{ make [targetname] }}} |
This command will build HTML versions of all the documents available. |
| Line 16: | Line 16: |
| 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] }}} |
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. |
| Line 20: | Line 18: |
| == Make Targets == | You will see a lot of warnings like the following, which can be safely ignored: {{{No localization exists for "c" or "". Using default "en".}}} |
| Line 22: | Line 21: |
| The makefile provides the following targets: | 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 script called {{{fix-urls.sh}}} to correct the broken internal links. This script is run automatically as part of the {{{make all}}} command described above. |
| Line 24: | Line 23: |
| 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 |
= Updating help.ubuntu.com = |
| Line 35: | Line 25: |
| Example make command and target: | The static pages on [[https://help.ubuntu.com|help.ubuntu.com]] (as opposed to the [[https://help.ubuntu.com/community|community wiki]]) are kept updated by pushing the HTML documents built to a [[https://code.launchpad.net/~ubuntu-core-doc/ubuntu-doc/help.ubuntu.com|specific bzr branch]] on Launchpad. |
| Line 37: | Line 27: |
| {{{ make ug }}} |
The contents of the help.ubuntu.com bzr branch are generally identical to the output of the {{{make all}}} command described in the previous section, subject to the following exceptions: * A custom index.html page is used which is not part of the build process. The index.html page which is produced by the build process is discarded. * A copy of the [[https://launchpad.net/ubuntu/+source/installation-guide|Ubuntu installation guide]] is added to the build process together with a custom index.html page. See the {{{install}}} target in the Makefile for information about how this is done. |
| Line 41: | Line 31: |
| To view any of these documents just open index.html found in the relevant build directory. | The [[https://launchpad.net/~canonical-sysadmins|Canonical Sysadmins]] are responsible for updating help.ubuntu.com from the bzr branch. It is intended that the updates will be pulled automatically in the future. '''Note:''' the HTML documentation on help.ubuntu.com should always reflect the documentation as it appears in the applicable version of Ubuntu. Changes to the help.ubuntu.com branch should not be made without the StableReleaseUpdates procedure first being followed and an equivalent change being made to the mainline bzr branch for the Ubuntu version concerned. = Building Translated HTML = If building translated copies of the documentation, you will need to adjust the Makefile and substitute your language code for the {{{LN}}} variable defined near the top of the Makefile. You may also wish to modify the header and footer details. These can be found in the {{{libs/ubuntu-banner.xsl}}} file. ---- CategoryDocteam |
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.
Building HTML Documentation
Set up a copy of the docteam bzr branch as described on Repository page. Choose the appropriate branch for the version of Ubuntu documentation you wish to build.
Install at least the following packages: make and docbook-xsl.
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.
You will see a lot of warnings like the following, which can be safely ignored:
No localization exists for "c" or "". Using default "en".
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 script called fix-urls.sh to correct the broken internal links. This script is run automatically as part of the make all command described above.
Updating help.ubuntu.com
The static pages on help.ubuntu.com (as opposed to the community wiki) are kept updated by pushing the HTML documents built to a specific bzr branch on Launchpad.
The contents of the help.ubuntu.com bzr branch are generally identical to the output of the make all command described in the previous section, subject to the following exceptions:
- A custom index.html page is used which is not part of the build process. The index.html page which is produced by the build process is discarded.
A copy of the Ubuntu installation guide is added to the build process together with a custom index.html page. See the install target in the Makefile for information about how this is done.
The Canonical Sysadmins are responsible for updating help.ubuntu.com from the bzr branch. It is intended that the updates will be pulled automatically in the future.
Note: the HTML documentation on help.ubuntu.com should always reflect the documentation as it appears in the applicable version of Ubuntu. Changes to the help.ubuntu.com branch should not be made without the StableReleaseUpdates procedure first being followed and an equivalent change being made to the mainline bzr branch for the Ubuntu version concerned.
Building Translated HTML
If building translated copies of the documentation, you will need to adjust the Makefile and substitute your language code for the LN variable defined near the top of the Makefile.
You may also wish to modify the header and footer details. These can be found in the libs/ubuntu-banner.xsl file.
DocumentationTeam/SystemDocumentation/BuildingDocumentation (last edited 2020-04-23 19:58:36 by dsmythies)