BuildingDocumentation
|
Size: 4488
Comment: Added generic segment. Did s/gnome/ubuntu/g; s/kde/kubuntu/g;
|
Size: 5227
Comment: Added Edubuntu 7.04 "make" targets
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ## page was renamed from DocteamBuildingDocumentation | |
| Line 5: | Line 6: |
| 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 8: |
| 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 12: |
| '''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 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 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 42: | Line 43: |
'''Note:''' The style guide is applicable to both Ubuntu and Kubuntu documents. |
|
| Line 77: | Line 76: |
| == Edubuntu (7.04 Feisty Fawn) == ||<:#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||{{{ubuntu-doc/build/edubuntu/handbook/C/index.html}}}|| ## ||<:>'''make esa'''||Edubuntu School Advocacy||{{{ubuntu-doc/build/edubuntu/school-advocacy/C/index.html}}}|| |
|
| Line 78: | Line 91: |
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 |
Edubuntu (7.04 Feisty Fawn)
Command |
Document |
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 |
ubuntu-doc/build/edubuntu/handbook/C/index.html |
make esa |
Edubuntu School Advocacy |
ubuntu-doc/build/edubuntu/school-advocacy/C/index.html |
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)