small compilation fix
[mplayer/glamo.git] / DOCS / xml / README.maintainers
blob02bc43d48274c1be580b892071f802a4956fb16a
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' and 'HTML-single' directories.
7 IMPORTANT: Do NOT place sensitive files under 'HTML' or 'HTML-single'!
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'.
11            Also, subdirectories are wiped out one by one before
12            creating the HTML files.
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.)
22 Adding new translations
23 ~~~~~~~~~~~~~~~~~~~~~~~
25 1) Create a new subdirectory and copy the XML files there.
27 2) Make sure to create a 'Makefile' for the translation -- you can
28    use 'en/Makefile' as an example.
30 3) Set <book lang="XX"> to your language code if the DocBook XSL
31    stylesheets support it.
33 4) If you want to use a customized XSL stylesheet, create one and name it
34    'html-common.xsl'. Also create two additional XSL stylesheets
35    ('html-single.xsl' and 'html-chunk.xsl'), with content such as this:
37    html-single.xsl:
39    <?xml version="1.0" encoding="ISO-8859-1"?>
40    <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
41                 version="1.0">
43   <xsl:import href="../html-single.xsl"/>
44   <xsl:include href="html-common.xsl"/>
46   </xsl:stylesheet>
48   html-chunk.xsl:
49   
50   <?xml version="1.0" encoding="ISO-8859-1"?>
51   <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
52                 version="1.0">
54   <xsl:import href="../html-chunk.xsl"/>
55   <xsl:include href="html-common.xsl"/>
57   </xsl:stylesheet>
60    Note: You mustn't xsl:include or xsl:import chunk.xsl directly!
61    Including it can (and will) break building of documentation if chunk.xsl
62    is installed at a nonstandard location.
64 5) If you wish to change the output encoding of generated files, create
65    html-common.xsl as suggested in step 4) and add strings such as these
66    somewhere between the <xsl:stylesheet ...> and </xsl:stylesheet> tags
67    (please, pay attention to quotes):
69       <xsl:param name="chunker.output.encoding" select="'your_encoding'"/>
70       <xsl:output encoding="your_encoding"/>
72    Use ru/html-common.xsl as example.
74 6) If you are using your own HTML stylesheet, edit your Makefile and set
75    the HTML_STYLESHEET variable to its name. Please, don't call your HTML
76    stylesheet 'default.css'.
78 7) In each translated file after the <?xml ... ?> tag you must put a note
79    like <!-- synced with 1.2 -->, where 1.2 is the revision of corresponding
80    English file (see comment at the top of file).
82 8) While your translation isn't finished, you can change USE_SYMLINKS
83    to "yes" in your Makefile. This will help you testing your translation:
84    english files will be used instead of untranslated ones, when generating
85    HTML docs.
87 That's all, in theory.