BuildingDocumentation

Differences between revisions 1 and 11 (spanning 10 versions)

Building Documentation Yourself

Docteam documents are built with GNU make.

If you set up your svn repository according to /Repository, then the makefiles required for building the Ubuntu, Kubuntu and Edubuntu docs are in ubuntu-doc/ubuntu, ubuntu-doc/edubuntu and ubuntu-doc/kubuntu respectively. The makefiles required for building generic docs are in ubuntu-doc/generic.

To build the docs, open a terminal and change to the appropriate directory (ubuntu-doc/ubuntu, ubuntu-doc/edubuntu, ubuntu-doc/kubuntu or ubuntu-doc/generic). The [#TargetList tables] below show which commands to use to build a specific document or group of documents. You will need to have following packages installed: make & docbook-xsl.

Note: These documents are all available on DocteamProjects.

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

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

It is owing 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 warning; it does not affect the output.

Anchor(TargetList) Document Set:

[#u Ubuntu]
[#k Kubuntu]
[#e Edubuntu]
[#x Xubuntu]
[#g Generic]

Note: These make targets are documented according to the current state of the Makefiles (in trunk).

Anchor(u)

Ubuntu Documents

From inside the ubuntu-doc/ubuntu directory:

Command	Document/Result	Output File Location/Target Location
make all	builds all targets below	`../build/ubuntu`
make clean	cleans out build target directory	`../build/ubuntu/`
make au	About Ubuntu	`../build/ubuntu/about-ubuntu/C/index.html`
make rn	Release Notes	`../build/ubuntu/release-notes/C/index.html`
make dg	Ubuntu Desktop Guide	`../build/ubuntu/desktopguide/C/index.html`
make server	Ubuntu Server Guide	`../build/serverguide/C/index.html`
make package	Ubuntu Packaging Guide	`../build/ubuntu/packagingguide/C/index.html`

Anchor(k)

Kubuntu Documents

From inside the ubuntu-doc/kubuntu directory:

Command	Document/Result	Output File Location/Target Location
make all	builds all targets below	`../build/kubuntu`
make clean	cleans out build target directory	`../build/kubuntu/`
make about	About Kubuntu	`../build/kubuntu/about-kubuntu/C/index.html`
make desktop	Kubuntu Desktop Guide	`../build/kubuntu/desktopguide/C/index.html`
make release-notes	Release Notes	`../build/kubuntu/release-notes/C/index.html`
make server	Ubuntu Server Guide	`../build/kubuntu/serverguide/C/index.html`
make package	Ubuntu Packaging Guide	`../build/kubuntu/packagingguide/C/index.html`
make adept-guide
make adept-updater
make addremoveprograms

Anchor(e)

Edubuntu

From inside the ubuntu-doc/edubuntu directory:

Command	Document/Result	Output File Location/Target Location
make all	builds all targets below	`../build/edubuntu`
make ae	About Edubuntu	`../build/edubuntu/about-edubuntu/C/index.html`
make rn	Release Notes	`../build/edubuntu/edubuntu-releasenotes/C/index.html`
make hb	Edubuntu Hand Book	`../build/edubuntu/handbook/C/index.html`
make esa	Edubuntu School Advocacy	`../build/edubuntu/school-advocacy/C/index.html`

Anchor(x)

Xubuntu Documents

From inside the ubuntu-doc/xubuntu directory:

Command	Document/Result	Output File Location/Target Location
make all	builds desktopguide	`../build/xubuntu`
make clean	cleans out build target directory	`../build/xubuntu/`
make desktopguide	Xubuntu Desktop Guide	`../build/xubuntu/desktopguide/C/index.html`

Anchor(g)

Generic Documents

From inside the ubuntu-doc/generic directory:

Command	Document/Result	Output File Location/Target Location
make sg	Style Guide	`../build/ubuntu/styleguide/C/index.html`
make sg-pdf	Style Guide (PDF)	`../build/ubuntu/pdf/C/serverguide.pdf`
make server	Server Guide	`../build/serverguide/C/index.html`
make package	Packaging Guide	`../build/ubuntu/packagingguide/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 11 as of 2006-12-12 11:36:48 → ⇥
  Size: 5080
  Editor: vc-196-207-41-253
  Comment: formatting errors
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
-= DocteamBuildingDocumentation =
+## page was renamed from DocteamBuildingDocumentation
= Building Documentation Yourself =
-Line 3:
+Line 4:
-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:
+Line 6:
-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 /Repository, then the makefiles required for building the Ubuntu, Kubuntu and Edubuntu docs are in {{{ubuntu-doc/ubuntu}}}, {{{ubuntu-doc/edubuntu}}} and {{{ubuntu-doc/kubuntu}}} respectively. The makefiles required for building generic docs are in {{{ubuntu-doc/generic}}}.
-Line 7:
+Line 8:
-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 ({{{ubuntu-doc/ubuntu}}}, {{{ubuntu-doc/edubuntu}}}, {{{ubuntu-doc/kubuntu}}} or {{{ubuntu-doc/generic}}}). The [#TargetList tables] below show which commands to use to build a specific document or group of documents. You will need to have following packages installed: {{{make}}} & {{{docbook-xsl}}}.
-Line 9:
+Line 10:
-To transform a document using make:
+'''Note:''' These documents are all available on DocteamProjects.
-Line 11:
+Line 12:
-. Make trunk/ your present working directory
 2. Run the command {{{
make [targetname]
}}}
+'''Note:''' You will see a lot of warnings like the following:
-Line 16:
+Line 14:
-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 16:
-== Make Targets ==
+It is owing 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 warning; it does not affect the output.
-Line 22:
+Line 18:
-The makefile provides the following targets:
+[[Anchor(TargetList)]]
__Document Set__:
 * [#u Ubuntu]
 * [#k Kubuntu]
 * [#e Edubuntu]
 * [#x Xubuntu]
 * [#g Generic]
-Line 24:
+Line 26:
- 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
+'''Note:''' These {{{make}}} targets are documented according to the current state of the {{{Makefiles}}} (in trunk).
-Line 35:
+Line 28:
-Example make command and target:
+[[Anchor(u)]]
== Ubuntu Documents ==
From inside the {{{ubuntu-doc/ubuntu}}} directory:
-Line 37:
+Line 32:
-{{{
 make ug
}}}
+||<#f0f5fa>'''Command'''||<#f0f5fa>'''Document/Result'''||<#f0f5fa>'''Output File Location/Target Location'''||
||'''make all'''||''builds all targets below''||{{{../build/ubuntu}}}||
||'''make clean'''||''cleans out build target directory''||{{{../build/ubuntu/}}}||
||'''make au'''||About Ubuntu||{{{../build/ubuntu/about-ubuntu/C/index.html}}}||
||'''make rn'''||Release Notes||{{{../build/ubuntu/release-notes/C/index.html}}}||
||'''make dg'''||Ubuntu Desktop Guide||{{{../build/ubuntu/desktopguide/C/index.html}}}||
||'''make server'''||Ubuntu Server Guide||{{{../build/serverguide/C/index.html}}}||
||'''make package'''||Ubuntu Packaging Guide||{{{../build/ubuntu/packagingguide/C/index.html}}}||
 Line 41:
-To view any of these documents just open index.html found in the relevant build directory.
+[[Anchor(k)]]
== Kubuntu Documents ==
From inside the {{{ubuntu-doc/kubuntu}}} directory:

||<#f0f5fa>'''Command'''||<#f0f5fa>'''Document/Result'''||<#f0f5fa>'''Output File Location/Target Location'''||
||'''make all'''||''builds all targets below''||{{{../build/kubuntu}}}||
||'''make clean'''||''cleans out build target directory''||{{{../build/kubuntu/}}}||
||'''make about'''||About Kubuntu||{{{../build/kubuntu/about-kubuntu/C/index.html}}}||
||'''make desktop'''||Kubuntu Desktop Guide||{{{../build/kubuntu/desktopguide/C/index.html}}}||
||'''make release-notes'''||Release Notes||{{{../build/kubuntu/release-notes/C/index.html}}}||
||'''make server'''||Ubuntu Server Guide||{{{../build/kubuntu/serverguide/C/index.html}}}||
||'''make package'''||Ubuntu Packaging Guide||{{{../build/kubuntu/packagingguide/C/index.html}}}||
||'''make adept-guide'''|| || ||
||'''make adept-updater'''|| || ||
||'''make addremoveprograms'''|| || ||

[[Anchor(e)]]
== Edubuntu ==
From inside the {{{ubuntu-doc/edubuntu}}} directory:

||<#f0f5fa>'''Command'''||<#f0f5fa>'''Document/Result'''||<#f0f5fa>'''Output File Location/Target Location'''||
||'''make all'''||''builds all targets below''||{{{../build/edubuntu}}}||
||'''make ae'''||About Edubuntu||{{{../build/edubuntu/about-edubuntu/C/index.html}}}||
||'''make rn'''||Release Notes||{{{../build/edubuntu/edubuntu-releasenotes/C/index.html}}}||
||'''make hb'''||Edubuntu Hand Book||{{{../build/edubuntu/handbook/C/index.html}}}||
||'''make esa'''||Edubuntu School Advocacy||{{{../build/edubuntu/school-advocacy/C/index.html}}}||

[[Anchor(x)]]
== Xubuntu Documents ==
From inside the {{{ubuntu-doc/xubuntu}}} directory:

||<#f0f5fa>'''Command'''||<#f0f5fa>'''Document/Result'''||<#f0f5fa>'''Output File Location/Target Location'''||
||'''make all'''||''builds desktopguide''||{{{../build/xubuntu}}}||
||'''make clean'''||''cleans out build target directory''||{{{../build/xubuntu/}}}||
||'''make desktopguide'''||Xubuntu Desktop Guide||{{{../build/xubuntu/desktopguide/C/index.html}}}||

[[Anchor(g)]]
== Generic Documents ==
From inside the {{{ubuntu-doc/generic}}} directory:

||<#f0f5fa>'''Command'''||<#f0f5fa>'''Document/Result'''||<#f0f5fa>'''Output File Location/Target Location'''||
||'''make sg'''||Style Guide||{{{../build/ubuntu/styleguide/C/index.html}}}||
||'''make sg-pdf'''||Style Guide (PDF)||{{{../build/ubuntu/pdf/C/serverguide.pdf}}}||
||'''make server'''||Server Guide||{{{../build/serverguide/C/index.html}}}||
||'''make package'''||Packaging Guide||{{{../build/ubuntu/packagingguide/C/index.html}}}||
----
CategoryDocteam

Ubuntu Wiki