← Back to branch summary

~ubuntu-branches/ubuntu/vivid/installation-guide/vivid-proposed

« back to all changes in this revision

Viewing changes to build/README

  • Committer: Bazaar Package Importer
  • Author(s): Frans Pop
  • Date: 2005-10-25 17:37:25 UTC
  • Revision ID: james.westby@ubuntu.com-20051025173725-aq0bm11be7bfd7rw
Tags: 20051025
http://bugs.debian.org/334925
* Mention in copyright that full GPL is included in the manual.
  Closes: #334925
* Register installed documents with doc-base.
* Minor updates in English text and translations.

Show diffs side-by-side

added added

removed removed

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