| 1 |
|
This document describes how the scripts in this directory can be used for |
| 2 |
|
building the Debian Installer Manual. |
| 3 |
|
|
| 4 |
|
The scripts support building the manual for different architectures, in |
| 5 |
|
different languages and in different document types. |
| 6 |
|
The currently supported document types are: |
| 7 |
|
- html |
| 8 |
|
- pdf |
| 9 |
|
- ps |
| 10 |
|
|
| 11 |
|
Note: Building pdf and ps versions of the manual for Japanese and Greek is |
| 12 |
|
not supported at the moment. |
| 13 |
|
Reason is that we have not yet figured out how to use the required |
| 14 |
|
fonts in the build process. |
| 15 |
|
|
| 16 |
|
|
| 17 |
1. Requirements: |
1. Requirements: |
| 18 |
================ |
================ |
| 19 |
|
|
| 20 |
docbook, docbook-xml, docbook-xsl, xsltproc, (fop) |
The build dependencies depend on which document types you wish to generate: |
| 21 |
|
all : docbook, docbook-xml, docbook-xsl, xsltproc |
| 22 |
|
html : (no additional packages required) |
| 23 |
|
pdf, ps : openjade, jadetex, docbook-dsssl |
| 24 |
|
pdf : gs-common |
| 25 |
|
|
| 26 |
|
Note: It's not possible to build the documentation on Woody as packages are |
| 27 |
|
required that are not available for Woody. |
| 28 |
|
Note: jadetex depends on tetex-bin which unfortunately depends on some X libs, |
| 29 |
|
so installing jadetex will pull in a basic X installation. |
| 30 |
|
There are several open bugs about this (the oldest over 3 years old, but |
| 31 |
|
it seems nobody cares enough to fix it (see #223728). |
| 32 |
|
|
| 33 |
2. Included Files: |
2. Included Files: |
| 34 |
================== |
================== |
| 35 |
|
|
| 36 |
install.en.xml: Main xml file used to aggregate various parts into |
SCRIPTS |
| 37 |
one big whole. This is a bit customized compared to |
------- |
| 38 |
the original (changed SYSTEM entities, hardcode local |
buildone.sh: For given architecture and language builds one set of |
| 39 |
path to docbook dtd -- broken system xml catalogs?) |
documentation in .html, .fo (and sometimes .pdf). |
|
Feel free to add your local install.xx.xml. |
|
| 40 |
|
|
| 41 |
common.ent: Contains various entities like &num-of-distrib-packages; |
build.sh: For each language and architecture calls buildone.sh, moves |
| 42 |
&debian; &arch-title; ... |
rendered documentation somewhere and cleans after that. |
| 43 |
|
|
| 44 |
urls.ent: Contains various urls used through the manual. |
clear.sh: Does the actual cleaning. |
| 45 |
|
|
| 46 |
docstruct.ent: Describes physical structure of documentation. Not |
In ./templates |
| 47 |
included directly (because of hardcoded en/ path), but |
------------- |
| 48 |
in a form of dynamic.ent (after some path replacing by sed). |
install.xml.template: Main xml file used to aggregate various parts into |
| 49 |
|
one big whole. This is a bit customized compared to the original |
| 50 |
|
(changed SYSTEM entities, hardcode local path to docbook dtd -- broken |
| 51 |
|
system xml catalogs?) |
| 52 |
|
|
| 53 |
dynamic.ent: Generated on-the-fly from the shell script buildone.sh. |
docstruct.ent: Describes physical structure of documentation. Not |
| 54 |
Contains lang and arch specific entities which can't be |
included directly (because of hardcoded en/ path), but in a form |
| 55 |
profiled the usual xml way. |
of dynamic.ent (after some path replacing by sed). |
| 56 |
|
|
| 57 |
any other .ent: Location of installation files (kernels, boot disks, |
In ./entities |
| 58 |
base tarballs) for various architectures. |
------------- |
| 59 |
|
common.ent: Contains various entities like &num-of-distrib-packages; |
| 60 |
|
&debian; &arch-title; ... |
| 61 |
|
|
| 62 |
buildone.sh: For given architecture and language builds one set of |
urls.ent: Contains various urls used through the manual. |
|
documentation in .html, .fo (and sometimes .pdf). |
|
| 63 |
|
|
| 64 |
build.sh: For each language and architecture calls buildone.sh, moves |
dynamic.ent: Generated on-the-fly from the shell script buildone.sh. |
| 65 |
rendered documentation somewhere and cleans after that. |
Contains lang and arch specific entities which can't be profiled |
| 66 |
|
the usual xml way. |
| 67 |
|
|
| 68 |
clear.sh: Does the actual cleaning. |
any other .ent: Location of installation files (kernels, boot disks, |
| 69 |
|
base tarballs) for various architectures. |
| 70 |
|
|
| 71 |
|
In ./stylesheets |
| 72 |
style-common.xsl: Common parameters for xsl transformation. |
style-common.xsl: Common parameters for xsl transformation. |
| 73 |
|
|
| 74 |
style-html.xsl: HTML-specific parameters for xsl transformation. |
style-html.xsl: HTML-specific parameters for xsl transformation. |
| 75 |
|
|
| 76 |
style-fo.xsl: FO-specific parameters for xsl transformation. |
style-print.dsl: Parameters for dvi transformation. |
| 77 |
|
|
| 78 |
|
style-fo.xsl: FO-specific parameters for xsl transformation. |
| 79 |
|
(currently unused) |
| 80 |
|
|
| 81 |
3. Building: |
3. Building: |
| 82 |
============ |
============ |
| 84 |
After you customize build*.sh and style-*.xsl to suit your needs |
After you customize build*.sh and style-*.xsl to suit your needs |
| 85 |
(esp. various paths), you can run |
(esp. various paths), you can run |
| 86 |
|
|
| 87 |
./buildone.sh sparc en |
./buildone.sh <architecture> <language> <format(s)> |
| 88 |
|
|
| 89 |
|
to build documentation for one specific architecture and language, and |
| 90 |
|
one or more output formats. |
| 91 |
|
If you call buildone.sh without any parameters, it will build the html |
| 92 |
|
version of the English manual for i386 (equivalent to 'i386 en html'). |
| 93 |
|
If you specify multiple output formats, you should put quotes around them. |
| 94 |
|
Example: ./buildone.sh sparc es "html pdf" |
| 95 |
|
|
| 96 |
to build documentation for one specific architecture (sparc) and |
For mass building you can use ./build.sh script. |
|
language (en). For mass building you can use ./build.sh script. |
|
| 97 |
|
|
| 98 |
|
|
| 99 |
-- |
-- |
| 100 |
27. January 2004 Miroslav Kure |
01. December 2004 Frans Pop |
| 101 |
|
27. January 2004 Miroslav Kure |
Parent Directory
| 
Revision Log
| 
Patch