BuildingDocumentation

Differences between revisions 9 and 11 (spanning 2 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 9 as of 2006-12-11 22:48:14 → 
  Size: 5241
  Editor: vc-196-207-41-253
  Comment:
+   ← 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 6:
-If you set up your svn repository according to DocteamStepByStepRepository, then the makefiles required for building the Ubuntu and Kubuntu docs are in {{{ubuntu-doc/ubuntu}}} and {{{ubuntu-doc/kubuntu}}} respectively. The makefiles required for building generic docs are in {{{ubuntu-doc/generic}}}.
+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 8:
-To build the docs, open a terminal and change to the appropriate directory ({{{ubuntu-doc/ubuntu}}} or {{{ubuntu-doc/kubuntu}}} or {{{ubuntu-doc/generic}}}). The 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}}}.
+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 16:
-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 warning; it does not affect the output.
+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 18:
+[[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)]]
-Line 19:
+Line 30:
+From inside the {{{ubuntu-doc/ubuntu}}} directory:
-Line 20:
+Line 32:
-||<:#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}}}||
+||<#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 44:
+Line 41:
+[[Anchor(k)]]
-Line 45:
+Line 43:
+From inside the {{{ubuntu-doc/kubuntu}}} directory:
-Line 46:
+Line 45:
-||<:#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}}}||
+||<#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'''|| || ||
-Line 76:
+Line 57:
+[[Anchor(e)]]
-Line 77:
+Line 59:
+From inside the {{{ubuntu-doc/edubuntu}}} directory:
-Line 78:
+Line 61:
-||<:#f0f5fa>'''Command'''||<:#f0f5fa>'''Document'''||<:#f0f5fa>'''Output File Location'''||
##
||<:>'''make all'''||builds all documents||{{{ubuntu-doc/build/edubuntu}}}||
##
||<:>'''make ae'''||About Edubuntu||{{{ubuntu-doc/build/edubuntu/about-edubuntu/C/index.html}}}||
##
||<:>'''make rn'''||Release Notes||{{{ubuntu-doc/build/edubuntu/edubuntu-releasenotes/C/index.html}}}||
##
||<:>'''make hb'''||Edubuntu Hand Book (not available in 6.10 Edgy Eft)||{{{ubuntu-doc/build/edubuntu/handbook/C/index.html}}}||
##
||<:>'''make esa'''||Edubuntu School Advocacy||{{{ubuntu-doc/build/edubuntu/school-advocacy/C/index.html}}}||
+||<#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}}}||
-Line 90:
+Line 68:
-The following table lists all generic documents. They are applicable for Ubuntu and Kubuntu Linux.
+[[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)]]
-Line 92:
+Line 79:
+From inside the {{{ubuntu-doc/generic}}} directory:
-Line 93:
+Line 81:
-||<:#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}}}||
+||<#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}}}||

Ubuntu Wiki