BuildingDocumentation
|
Size: 3874
Comment: added packages needed to make documents
|
Size: 4530
Comment: more tweaks
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 5: | Line 5: |
| 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. | 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}}}. |
| Line 7: | Line 7: |
| 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}}}. | 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}}}. |
| Line 11: | Line 11: |
| '''Note:''' You will see a lot of errors like the following: | '''Note:''' You will see a lot of warnings like the following: |
| Line 15: | Line 15: |
| Do not worry about this error; it does not affect the output. | 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. |
| Line 17: | Line 17: |
| == GNOME Documents == | == Ubuntu Documents == |
| Line 21: | Line 21: |
| ||<:>'''make all'''||builds all documents||{{{ubuntu-doc/build/}}}|| | ||<:>'''make all'''||builds all documents||{{{ubuntu-doc/build/ubuntu}}}|| |
| Line 23: | Line 23: |
| ||<:>'''make qg'''||Ubuntu Quick Tour||{{{ubuntu-doc/build/gnome/quickguide/C/index.html}}}|| | ||<:>'''make qg'''||Ubuntu Quick Tour||{{{ubuntu-doc/build/ubuntu/quickguide/C/index.html}}}|| |
| Line 25: | Line 25: |
| ||<:>'''make ag'''||Ubuntu Administrator Guide||{{{ubuntu-doc/build/gnome/adminguide/C/index.html}}}|| | ||<:>'''make ag'''||Ubuntu Administrator Guide||{{{ubuntu-doc/build/ubuntu/adminguide/C/index.html}}}|| |
| Line 27: | Line 27: |
| ||<:>'''make in'''||Ubuntu Installation Guide||{{{ubuntu-doc/build/gnome/ubuntu-install/C/index.html}}}|| | ||<:>'''make in'''||Ubuntu Installation Guide||{{{ubuntu-doc/build/ubuntu/ubuntu-install/C/index.html}}}|| |
| Line 29: | Line 29: |
| ||<:>'''make au'''||About Ubuntu||{{{ubuntu-doc/build/gnome/about-ubuntu/C/index.html}}}|| | ||<:>'''make au'''||About Ubuntu||{{{ubuntu-doc/build/ubuntu/about-ubuntu/C/index.html}}}|| |
| Line 31: | Line 31: |
| ||<:>'''make rn'''||Release Notes||{{{ubuntu-doc/build/gnome/release-notes/C/index.html}}}|| | ||<:>'''make rn'''||Release Notes||{{{ubuntu-doc/build/ubuntu/release-notes/C/index.html}}}|| |
| Line 35: | Line 35: |
| ||<:>'''make faqi386'''||FAQ for Intel platform||{{{ubuntu-doc/build/gnome/faqi386/C/index.html}}}|| | ||<:>'''make faqi386'''||FAQ for Intel platform||{{{ubuntu-doc/build/ubuntu/faqi386/C/index.html}}}|| |
| Line 37: | Line 37: |
| ||<:>'''make faqamd64'''||FAQ for AMD 64 bit platform||{{{ubuntu-doc/build/gnome/faqamd64/C/index.html}}}|| | ||<:>'''make faqamd64'''||FAQ for AMD 64 bit platform||{{{ubuntu-doc/build/ubuntu/faqamd64/C/index.html}}}|| |
| Line 39: | Line 39: |
| ||<:>'''make faqppc'''||FAQ for Power PC platform||{{{ubuntu-doc/build/gnome/faqppc/C/index.html}}}|| | ||<:>'''make faqppc'''||FAQ for Power PC platform||{{{ubuntu-doc/build/ubuntu/faqppc/C/index.html}}}|| |
| Line 41: | Line 41: |
| ||<:>'''make sg'''||Docteam Style Guide||{{{ubuntu-doc/build/gnome/styleguide/C/index.html}}}|| ## ||<:>'''make status'''||builds a status report for each document||{{{ubuntu-doc/build/gnome/status}}}|| |
||<:>'''make status'''||builds a status report for each document||{{{ubuntu-doc/build/ubuntu/status}}}|| |
| Line 45: | Line 43: |
| '''Note:''' The style guide is applicable to both GNOME and KDE documents. It is included in the GNOME makefile purely for convenience. == KDE Documents == |
== Kubuntu Documents == |
| Line 51: | Line 47: |
| ||<:>'''make kall'''||builds all documents||{{{ubuntu-doc/build/}}}|| | ||<:>'''make kall'''||builds all documents||{{{ubuntu-doc/build/kubuntu}}}|| |
| Line 53: | Line 49: |
| ||<:>'''make kak'''||About Kubuntu||{{{ubuntu-doc/build/kde/about-kubuntu/C/index.html}}}|| | ||<:>'''make kak'''||About Kubuntu||{{{ubuntu-doc/build/kubuntu/about-kubuntu/C/index.html}}}|| |
| Line 55: | Line 51: |
| ||<:>'''make kug'''||Kubuntu User Guide||{{{ubuntu-doc/build/kde/kuserguide/C/index.html}}}|| | ||<:>'''make kug'''||Kubuntu User Guide||{{{ubuntu-doc/build/kubuntu/kuserguide/C/index.html}}}|| |
| Line 57: | Line 53: |
| ||<:>'''make kag'''||Kubuntu Administrator Guide||{{{ubuntu-doc/build/kde/kadminguide/C/index.html}}}|| | ||<:>'''make kag'''||Kubuntu Administrator Guide||{{{ubuntu-doc/build/kubuntu/kadminguide/C/index.html}}}|| |
| Line 59: | Line 55: |
| ||<:>'''make krn'''||Release Notes||{{{ubuntu-doc/build/kde/krelease-notes/C/index.html}}}|| | ||<:>'''make krn'''||Release Notes||{{{ubuntu-doc/build/kubuntu/krelease-notes/C/index.html}}}|| |
| Line 61: | Line 57: |
| ||<:>'''make kqg'''||Kubuntu Quick Guide||{{{ubuntu-doc/build/kde/kquickguide/C/index.html}}}|| | ||<:>'''make kqg'''||Kubuntu Quick Guide||{{{ubuntu-doc/build/kubuntu/kquickguide/C/index.html}}}|| |
| Line 63: | Line 59: |
| ||<:>'''make kspec'''||Kubuntu doc specs||{{{ubuntu-doc/build/kde/kadminguide/C/index.html}}}|| | ||<:>'''make kspec'''||Kubuntu doc specs||{{{ubuntu-doc/build/kubuntu/kadminguide/C/index.html}}}|| |
| Line 67: | Line 63: |
| ||<:>'''make kfaqi386'''||FAQ for Intel platform||{{{ubuntu-doc/build/kde/kfaqi386/C/index.html}}}|| | ||<:>'''make kfaqi386'''||FAQ for Intel platform||{{{ubuntu-doc/build/kubuntu/kfaqi386/C/index.html}}}|| |
| Line 69: | Line 65: |
| ||<:>'''make kfaqamd64'''||FAQ for AMD 64 bit platform||{{{ubuntu-doc/build/kde/kfaqamd64/C/index.html}}}|| | ||<:>'''make kfaqamd64'''||FAQ for AMD 64 bit platform||{{{ubuntu-doc/build/kubuntu/kfaqamd64/C/index.html}}}|| |
| Line 71: | Line 67: |
| ||<:>'''make kfaqppc'''||FAQ for Power PC platform||{{{ubuntu-doc/build/kde/kfaqppc/C/index.html}}}|| | ||<:>'''make kfaqppc'''||FAQ for Power PC platform||{{{ubuntu-doc/build/kubuntu/kfaqppc/C/index.html}}}|| |
| Line 73: | Line 69: |
| ||<:>'''make kin'''||Kubuntu Installation Guide||{{{ubuntu-doc/build/kde/kubuntu-install/C/index.html}}}|| | ||<:>'''make kin'''||Kubuntu Installation Guide||{{{ubuntu-doc/build/kubuntu/kubuntu-install/C/index.html}}}|| |
| Line 75: | Line 71: |
| ||<:>'''make kum'''||Kynaptic User Manual||{{{ubuntu-doc/build/kde/kynaptic/C/index.html}}}|| | ||<:>'''make kum'''||Kynaptic User Manual||{{{ubuntu-doc/build/kubuntu/kynaptic/C/index.html}}}|| |
| Line 77: | Line 73: |
| ||<:>'''make kstatus'''||builds a status report for each document||{{{ubuntu-doc/build/kde/status}}}|| | ||<:>'''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}}}|| |
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 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.
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.
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 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.
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 |
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 |
DocumentationTeam/SystemDocumentation/BuildingDocumentation (last edited 2020-04-23 19:58:36 by dsmythies)