|
9674
|
1 The documentation and its translations reside in subdirectories.
|
|
|
2 When building the documentation, the toplevel Makefile goes into
|
|
|
3 the subdirectories listed in the SUBDIRS variable and executes make
|
|
|
4 in each of those directories to create the HTML documentation
|
|
|
5 in subdirectories of the 'HTML' directory.
|
|
|
6
|
|
|
7 IMPORTANT: Do NOT place sensitive files under 'HTML'!
|
|
|
8 It is for generated documentation only.
|
|
|
9 The whole directory tree is wiped out by the Makefile
|
|
|
10 when running 'make distclean' or 'make clean-html'.
|
|
|
11 Also, subdirectories are wiped out one by one before
|
|
|
12 creating the HTML files.
|
|
|
13
|
|
|
14 Each subdirectory must have a Makefile. Its purpose is to include
|
|
|
15 the toplevel Makefile.inc file (with the rules to build the docs)
|
|
|
16 and add dependency information to the main target, $(HTMLDIR)/index.html.
|
|
|
17 The main target usually depends on all the XML and XSL files in the
|
|
|
18 subdirectory. (Note that the toplevel *.xsl files are added automatically
|
|
|
19 by Makefile.inc, so you do not have to list them.)
|
|
|
20
|
|
|
21
|
|
|
22 Adding new translations
|
|
|
23 ~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
24
|
|
|
25 1) Create a new subdirectory and copy the XML files there.
|
|
|
26 2) Make sure to create a 'Makefile' for the translation -- you can
|
|
|
27 use 'en/Makefile' as an example.
|
|
|
28 3) Set <book lang="XX"> to your language code if the DocBook XSL
|
|
|
29 stylesheets support it.
|
|
|
30 4) If you want to use a customized XSL stylesheet, create one and name it
|
|
|
31 'html.xsl'. And do not forget to import the toplevel XSL file:
|
|
|
32
|
|
|
33 <xsl:import href="../html.xsl"/>
|
|
|
34
|
|
9953
|
35 5) If you are using your own HTML stylesheet, edit your Makefile and set
|
|
9674
|
36 the HTML_STYLESHEET variable to its name.
|
|
|
37
|
|
|
38 That's all, in theory.
|
