Mercurial > mplayer.hg

comparison DOCS/xml/README.maintainers @ 29978:253fb126c4ee

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Drop support for per-language XSL stylesheets. The feature was never properly used and provides little benefit.
author diego
date Mon, 14 Dec 2009 02:01:50 +0000
parents 397bda90657c
children 2a55ab2aff1d
comparison
equal deleted inserted replaced
29977:51c429db3e68 29978:253fb126c4ee
12 creating the HTML files. 12 creating the HTML files.
13 13
14 Each subdirectory must have a Makefile. Its purpose is to include 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) 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. 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 17 The main target usually depends on all the XML files in the subdirectory.
18 subdirectory. (Note that the toplevel *.xsl files are added automatically
19 by Makefile.inc, so you do not have to list them.)
20 18
21 19
22 Adding new translations 20 Adding new translations
23 ~~~~~~~~~~~~~~~~~~~~~~~ 21 ~~~~~~~~~~~~~~~~~~~~~~~
24 22
26 copied, it is autogenerated. 24 copied, it is autogenerated.
27 25
28 2) Make sure to create a 'Makefile' for the translation -- you can 26 2) Make sure to create a 'Makefile' for the translation -- you can
29 use 'en/Makefile' as an example. 27 use 'en/Makefile' as an example.
30 28
31 3) If you want to use a customized XSL stylesheet, create one and name it 29 3) In each translated file after the <?xml ... ?> tag you must put a note
32 'html-common.xsl'. Also create two additional XSL stylesheets
33 ('html-single.xsl' and 'html-chunk.xsl'), with content such as this:
34
35 html-single.xsl:
36
37 <?xml version="1.0" encoding="ISO-8859-1"?>
38 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
39 version="1.0">
40
41 <xsl:import href="../html-single.xsl"/>
42 <xsl:include href="html-common.xsl"/>
43
44 </xsl:stylesheet>
45
46 html-chunk.xsl:
47
48 <?xml version="1.0" encoding="ISO-8859-1"?>
49 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
50 version="1.0">
51
52 <xsl:import href="../html-chunk.xsl"/>
53 <xsl:include href="html-common.xsl"/>
54
55 </xsl:stylesheet>
56
57
58 Note: You mustn't xsl:include or xsl:import chunk.xsl directly!
59 Including it can (and will) break building of documentation if chunk.xsl
60 is installed at a nonstandard location.
61
62 4) If you wish to change the output encoding of generated files, create
63 html-common.xsl as suggested in step 4) and add strings such as these
64 somewhere between the <xsl:stylesheet ...> and </xsl:stylesheet> tags
65 (please, pay attention to quotes):
66
67 <xsl:param name="chunker.output.encoding" select="'your_encoding'"/>
68 <xsl:output encoding="your_encoding"/>
69
70 5) In each translated file after the <?xml ... ?> tag you must put a note
71 like <!-- synced with r2 -->, where 2 is the revision of corresponding 30 like <!-- synced with r2 -->, where 2 is the revision of corresponding
72 English file (see comment at the top of file). 31 English file (see comment at the top of file).
73 32
74 That's all, in theory. 33 That's all, in theory.