BuildingDocumentation

Differences between revisions 1 and 5 (spanning 4 versions)

Building Documentation Yourself

Docteam documents are built with GNU make.

If you set up your svn repository according to DocteamStepByStepRepository, then the makefiles required for building the GNOME and KDE docs are in ubuntu-doc/gnome and ubuntu-doc/kde respectively.

To build the docs, open a terminal and change to the appropriate directory (either ubuntu-doc/gnome or ubuntu-doc/kde). The tables below show which commands to use to build a specific document or group of documents. You will need to following packages installed: make, docbook-xsl.

Note: These documents are all available on DocteamProjects.

Note: You will see a lot of errors like the following:

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

It is due to document language setting. In the document, it is mentioned as "&EnglishAmerican;". This variable is defined in ubuntu-doc/libs/global.ent file. If you are worried about this error, you can edit the document and set it as "en". Anyhow, you need not worry about this error; it does not affect the output.

Ubuntu Documents

Command	Document	Output File Location
make all	builds all documents	`ubuntu-doc/build/ubuntu`
make qg	Ubuntu Quick Tour	`ubuntu-doc/build/ubuntu/quickguide/C/index.html`
make ag	Ubuntu Administrator Guide	`ubuntu-doc/build/ubuntu/adminguide/C/index.html`
make in	Ubuntu Installation Guide	`ubuntu-doc/build/ubuntu/ubuntu-install/C/index.html`
make au	About Ubuntu	`ubuntu-doc/build/ubuntu/about-ubuntu/C/index.html`
make rn	Release Notes	`ubuntu-doc/build/ubuntu/release-notes/C/index.html`
make faq	Builds all FAQs	See individual FAQ guides
make faqi386	FAQ for Intel platform	`ubuntu-doc/build/ubuntu/faqi386/C/index.html`
make faqamd64	FAQ for AMD 64 bit platform	`ubuntu-doc/build/ubuntu/faqamd64/C/index.html`
make faqppc	FAQ for Power PC platform	`ubuntu-doc/build/ubuntu/faqppc/C/index.html`
make status	builds a status report for each document	`ubuntu-doc/build/ubuntu/status`

Note: The style guide is applicable to both Ubuntu and Kubuntu documents.

Kubuntu Documents

Command	Document	Output File Location
make kall	builds all documents	`ubuntu-doc/build/kubuntu`
make kak	About Kubuntu	`ubuntu-doc/build/kubuntu/about-kubuntu/C/index.html`
make kug	Kubuntu User Guide	`ubuntu-doc/build/kubuntu/kuserguide/C/index.html`
make kag	Kubuntu Administrator Guide	`ubuntu-doc/build/kubuntu/kadminguide/C/index.html`
make krn	Release Notes	`ubuntu-doc/build/kubuntu/krelease-notes/C/index.html`
make kqg	Kubuntu Quick Guide	`ubuntu-doc/build/kubuntu/kquickguide/C/index.html`
make kspec	Kubuntu doc specs	`ubuntu-doc/build/kubuntu/kadminguide/C/index.html`
make kfaq	Builds all FAQs	See individual FAQ guides
make kfaqi386	FAQ for Intel platform	`ubuntu-doc/build/kubuntu/kfaqi386/C/index.html`
make kfaqamd64	FAQ for AMD 64 bit platform	`ubuntu-doc/build/kubuntu/kfaqamd64/C/index.html`
make kfaqppc	FAQ for Power PC platform	`ubuntu-doc/build/kubuntu/kfaqppc/C/index.html`
make kin	Kubuntu Installation Guide	`ubuntu-doc/build/kubuntu/kubuntu-install/C/index.html`
make kum	Kynaptic User Manual	`ubuntu-doc/build/kubuntu/kynaptic/C/index.html`
make kstatus	builds a status report for each document	`ubuntu-doc/build/kubuntu/status`

The following table lists all generic documents. They are applicable for Ubuntu and Kubuntu Linux.

Generic Documents

Command	Document	Output File Location
make sg	Docteam Style Guide	`ubuntu-doc/build/ubuntu/styleguide/C/index.html`
make server	Docteam Server Starter Guide	`ubuntu-doc/build/ubuntu/styleguide/C/index.html`

CategoryDocteam

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

-  ⇤ ← Revision 1 as of 2005-05-28 20:11:18 → 
  Size: 1796
  Editor: adsl-213-190-44-43
  Comment: imported from the old wiki
+   ← Revision 5 as of 2005-11-10 16:59:53 → ⇥
  Size: 4488
  Editor: 59
  Comment: Added generic segment. Did s/gnome/ubuntu/g; s/kde/kubuntu/g;
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
-= DocteamBuildingDocumentation =
+= Building Documentation Yourself =
 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.
+Docteam documents are built with GNU {{{make}}}.
 Line 5:
-To use the makefile you will need to install GNU make (you'll find it in the 'make' package).
+If you set up your svn repository according to DocteamStepByStepRepository, then the makefiles required for building the GNOME and KDE docs are in {{{ubuntu-doc/gnome}}} and {{{ubuntu-doc/kde}}} respectively.
 Line 7:
-Other build dependencies for most of the documentation are the packages 'docbook-xsl' and 'xsltproc'.
+To build the docs, open a terminal and change to the appropriate directory (either {{{ubuntu-doc/gnome}}} or {{{ubuntu-doc/kde}}}). The tables below show which commands to use to build a specific document or group of documents. You will need to following packages installed: {{{make}}}, {{{docbook-xsl}}}.
 Line 9:
-To transform a document using make:
+'''Note:''' These documents are all available on DocteamProjects.
 Line 11:
-. Make trunk/ your present working directory
 2. Run the command {{{
make [targetname]
}}}
+'''Note:''' You will see a lot of errors like the following:
-Line 16:
+Line 13:
-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]
}}}
+       {{{No localization exists for "c" or "". Using default "en".}}}
-Line 20:
+Line 15:
-== Make Targets ==
+It is due to document language setting. In the document, it is mentioned as "&EnglishAmerican;". This variable is defined in ubuntu-doc/libs/global.ent file. If you are worried about this error, you can edit the document and set it as "en". Anyhow, you need not worry about this error; it does not affect the output.
-Line 22:
+Line 17:
-The makefile provides the following targets:
+== Ubuntu Documents ==
-Line 24:
+Line 19:
- 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
+||<:#f0f5fa>'''Command'''||<:#f0f5fa>'''Document'''||<:#f0f5fa>'''Output File Location'''||
##
||<:>'''make all'''||builds all documents||{{{ubuntu-doc/build/ubuntu}}}||
##
||<:>'''make qg'''||Ubuntu Quick Tour||{{{ubuntu-doc/build/ubuntu/quickguide/C/index.html}}}||
##
||<:>'''make ag'''||Ubuntu Administrator Guide||{{{ubuntu-doc/build/ubuntu/adminguide/C/index.html}}}||
##
||<:>'''make in'''||Ubuntu Installation Guide||{{{ubuntu-doc/build/ubuntu/ubuntu-install/C/index.html}}}||
##
||<:>'''make au'''||About Ubuntu||{{{ubuntu-doc/build/ubuntu/about-ubuntu/C/index.html}}}||
##
||<:>'''make rn'''||Release Notes||{{{ubuntu-doc/build/ubuntu/release-notes/C/index.html}}}||
##
||<:>'''make faq'''||Builds all FAQs||See individual FAQ guides||
##
||<:>'''make faqi386'''||FAQ for Intel platform||{{{ubuntu-doc/build/ubuntu/faqi386/C/index.html}}}||
##
||<:>'''make faqamd64'''||FAQ for AMD 64 bit platform||{{{ubuntu-doc/build/ubuntu/faqamd64/C/index.html}}}||
##
||<:>'''make faqppc'''||FAQ for Power PC platform||{{{ubuntu-doc/build/ubuntu/faqppc/C/index.html}}}||
##
||<:>'''make status'''||builds a status report for each document||{{{ubuntu-doc/build/ubuntu/status}}}||
-Line 35:
+Line 43:
-Example make command and target:
+'''Note:''' The style guide is applicable to both Ubuntu and Kubuntu documents.
-Line 37:
+Line 45:
-{{{
 make ug
}}}
+== Kubuntu Documents ==
-Line 41:
+Line 47:
-To view any of these documents just open index.html found in the relevant build directory.
+||<:#f0f5fa>'''Command'''||<:#f0f5fa>'''Document'''||<:#f0f5fa>'''Output File Location'''||
##
||<:>'''make kall'''||builds all documents||{{{ubuntu-doc/build/kubuntu}}}||
##
||<:>'''make kak'''||About Kubuntu||{{{ubuntu-doc/build/kubuntu/about-kubuntu/C/index.html}}}||
##
||<:>'''make kug'''||Kubuntu User Guide||{{{ubuntu-doc/build/kubuntu/kuserguide/C/index.html}}}||
##
||<:>'''make kag'''||Kubuntu Administrator Guide||{{{ubuntu-doc/build/kubuntu/kadminguide/C/index.html}}}||
##
||<:>'''make krn'''||Release Notes||{{{ubuntu-doc/build/kubuntu/krelease-notes/C/index.html}}}||
##
||<:>'''make kqg'''||Kubuntu Quick Guide||{{{ubuntu-doc/build/kubuntu/kquickguide/C/index.html}}}||
##
||<:>'''make kspec'''||Kubuntu doc specs||{{{ubuntu-doc/build/kubuntu/kadminguide/C/index.html}}}||
##
||<:>'''make kfaq'''||Builds all FAQs||See individual FAQ guides||
##
||<:>'''make kfaqi386'''||FAQ for Intel platform||{{{ubuntu-doc/build/kubuntu/kfaqi386/C/index.html}}}||
##
||<:>'''make kfaqamd64'''||FAQ for AMD 64 bit platform||{{{ubuntu-doc/build/kubuntu/kfaqamd64/C/index.html}}}||
##
||<:>'''make kfaqppc'''||FAQ for Power PC platform||{{{ubuntu-doc/build/kubuntu/kfaqppc/C/index.html}}}||
##
||<:>'''make kin'''||Kubuntu Installation Guide||{{{ubuntu-doc/build/kubuntu/kubuntu-install/C/index.html}}}||
##
||<:>'''make kum'''||Kynaptic User Manual||{{{ubuntu-doc/build/kubuntu/kynaptic/C/index.html}}}||
##
||<:>'''make kstatus'''||builds a status report for each document||{{{ubuntu-doc/build/kubuntu/status}}}||

The following table lists all generic documents. They are applicable for Ubuntu and Kubuntu Linux.

== Generic Documents ==

||<:#f0f5fa>'''Command'''||<:#f0f5fa>'''Document'''||<:#f0f5fa>'''Output File Location'''||
##
||<:>'''make sg'''||Docteam Style Guide||{{{ubuntu-doc/build/ubuntu/styleguide/C/index.html}}}||
##
||<:>'''make server'''||Docteam Server Starter Guide||{{{ubuntu-doc/build/ubuntu/styleguide/C/index.html}}}||

----
CategoryDocteam

Ubuntu Wiki