Contents of /trunk/doc/manual/build/README

1. Requirements:
================

docbook, docbook-xml, docbook-xsl, xsltproc, (fop)


2. Included Files:
==================

install.en.xml: Main xml file used to aggregate various parts into
                one big whole. This is a bit customized compared to
                the original (changed SYSTEM entities, hardcode local
                path to docbook dtd -- broken system xml catalogs?)
                Feel free to add your local install.xx.xml.

common.ent: Contains various entities like &num-of-distrib-packages;
            &debian; &arch-title; ...

urls.ent: Contains various urls used through the manual.

docstruct.ent: Describes physical structure of documentation. Not
               included directly (because of hardcoded en/ path), but
               in a form of dynamic.ent (after some path replacing by sed).

dynamic.ent: Generated on-the-fly from the shell script buildone.sh.
             Contains lang and arch specific entities which can't be
             profiled the usual xml way.

any other .ent: Location of installation files (kernels, boot disks,
                base tarballs) for various architectures.

buildone.sh: For given architecture and language builds one set of
             documentation in .html, .fo (and sometimes .pdf).

build.sh: For each language and architecture calls buildone.sh, moves
          rendered documentation somewhere and cleans after that.

clear.sh: Does the actual cleaning.

style-common.xsl: Common parameters for xsl transformation.

style-html.xsl: HTML-specific parameters for xsl transformation.

style-fo.xsl: FO-specific parameters for xsl transformation.


3. Building:
============

After you customize build*.sh and style-*.xsl to suit your needs
(esp. various paths), you can run

 ./buildone.sh sparc en

to build documentation for one specific architecture (sparc) and
language (en). For mass building you can use ./build.sh script.


-- 
27. January 2004 Miroslav Kure 
1	1. Requirements:
2	================
3
4	docbook, docbook-xml, docbook-xsl, xsltproc, (fop)
5
6
7	2. Included Files:
8	==================
9
10	install.en.xml: Main xml file used to aggregate various parts into
11	one big whole. This is a bit customized compared to
12	the original (changed SYSTEM entities, hardcode local
13	path to docbook dtd -- broken system xml catalogs?)
14	Feel free to add your local install.xx.xml.
15
16	common.ent: Contains various entities like &num-of-distrib-packages;
17	&debian; &arch-title; ...
18
19	urls.ent: Contains various urls used through the manual.
20
21	docstruct.ent: Describes physical structure of documentation. Not
22	included directly (because of hardcoded en/ path), but
23	in a form of dynamic.ent (after some path replacing by sed).
24
25	dynamic.ent: Generated on-the-fly from the shell script buildone.sh.
26	Contains lang and arch specific entities which can't be
27	profiled the usual xml way.
28
29	any other .ent: Location of installation files (kernels, boot disks,
30	base tarballs) for various architectures.
31
32	buildone.sh: For given architecture and language builds one set of
33	documentation in .html, .fo (and sometimes .pdf).
34
35	build.sh: For each language and architecture calls buildone.sh, moves
36	rendered documentation somewhere and cleans after that.
37
38	clear.sh: Does the actual cleaning.
39
40	style-common.xsl: Common parameters for xsl transformation.
41
42	style-html.xsl: HTML-specific parameters for xsl transformation.
43
44	style-fo.xsl: FO-specific parameters for xsl transformation.
45
46
47	3. Building:
48	============
49
50	After you customize build.sh and style-.xsl to suit your needs
51	(esp. various paths), you can run
52
53	./buildone.sh sparc en
54
55	to build documentation for one specific architecture (sparc) and
56	language (en). For mass building you can use ./build.sh script.
57
58
59	--
60	27. January 2004 Miroslav Kure