Mercurial > mplayer.hg
annotate DOCS/xml/README.maintainers @ 20752:0617c67ad68f
Fix code that cuts audio data if the filters produce too much.
It incorrectly used the channel count and sample size values from the
decoder even though the filters can change those.
author | uau |
---|---|
date | Tue, 07 Nov 2006 23:16:55 +0000 |
parents | 0b8825d823dd |
children | e9736e48523f |
rev | line source |
---|---|
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 | |
11202 | 5 in subdirectories of the 'HTML' and 'HTML-single' directories. |
9674 | 6 |
11202 | 7 IMPORTANT: Do NOT place sensitive files under 'HTML' or 'HTML-single'! |
9674 | 8 It is for generated documentation only. |
9 The whole directory tree is wiped out by the Makefile | |
11204 | 10 when running 'make distclean' or 'make clean'. |
9674 | 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 | |
18409 | 25 1) Create a new subdirectory and copy the XML files there. main.xml must not be |
26 copied, it is autogenerated. | |
11199
b61680a0b29a
Add some whitespace for readability + some wording improvements.
diego
parents:
11188
diff
changeset
|
27 |
9674 | 28 2) Make sure to create a 'Makefile' for the translation -- you can |
29 use 'en/Makefile' as an example. | |
11199
b61680a0b29a
Add some whitespace for readability + some wording improvements.
diego
parents:
11188
diff
changeset
|
30 |
9674 | 31 3) Set <book lang="XX"> to your language code if the DocBook XSL |
32 stylesheets support it. | |
11199
b61680a0b29a
Add some whitespace for readability + some wording improvements.
diego
parents:
11188
diff
changeset
|
33 |
9674 | 34 4) If you want to use a customized XSL stylesheet, create one and name it |
11209 | 35 'html-common.xsl'. Also create two additional XSL stylesheets |
36 ('html-single.xsl' and 'html-chunk.xsl'), with content such as this: | |
11188
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
37 |
11209 | 38 html-single.xsl: |
11188
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
39 |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
40 <?xml version="1.0" encoding="ISO-8859-1"?> |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
41 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
42 version="1.0"> |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
43 |
11209 | 44 <xsl:import href="../html-single.xsl"/> |
11188
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
45 <xsl:include href="html-common.xsl"/> |
9674 | 46 |
11188
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
47 </xsl:stylesheet> |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
48 |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
49 html-chunk.xsl: |
18409 | 50 |
11188
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
51 <?xml version="1.0" encoding="ISO-8859-1"?> |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
52 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
53 version="1.0"> |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
54 |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
55 <xsl:import href="../html-chunk.xsl"/> |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
56 <xsl:include href="html-common.xsl"/> |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
57 |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
58 </xsl:stylesheet> |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
59 |
11132
550c25c57f34
Document, that chunk.xsl mustn't be included directly.
lumag
parents:
11051
diff
changeset
|
60 |
11145 | 61 Note: You mustn't xsl:include or xsl:import chunk.xsl directly! |
62 Including it can (and will) break building of documentation if chunk.xsl | |
63 is installed at a nonstandard location. | |
11199
b61680a0b29a
Add some whitespace for readability + some wording improvements.
diego
parents:
11188
diff
changeset
|
64 |
b61680a0b29a
Add some whitespace for readability + some wording improvements.
diego
parents:
11188
diff
changeset
|
65 5) If you wish to change the output encoding of generated files, create |
b61680a0b29a
Add some whitespace for readability + some wording improvements.
diego
parents:
11188
diff
changeset
|
66 html-common.xsl as suggested in step 4) and add strings such as these |
b61680a0b29a
Add some whitespace for readability + some wording improvements.
diego
parents:
11188
diff
changeset
|
67 somewhere between the <xsl:stylesheet ...> and </xsl:stylesheet> tags |
11188
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
68 (please, pay attention to quotes): |
9674 | 69 |
10911 | 70 <xsl:param name="chunker.output.encoding" select="'your_encoding'"/> |
11188
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
71 <xsl:output encoding="your_encoding"/> |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
72 |
6dfed0b2a300
Add support for building all-in-one HTML docs. (Files go to DOCS/HTML-single)
lumag
parents:
11145
diff
changeset
|
73 Use ru/html-common.xsl as example. |
11199
b61680a0b29a
Add some whitespace for readability + some wording improvements.
diego
parents:
11188
diff
changeset
|
74 |
10911 | 75 6) If you are using your own HTML stylesheet, edit your Makefile and set |
11199
b61680a0b29a
Add some whitespace for readability + some wording improvements.
diego
parents:
11188
diff
changeset
|
76 the HTML_STYLESHEET variable to its name. Please, don't call your HTML |
b61680a0b29a
Add some whitespace for readability + some wording improvements.
diego
parents:
11188
diff
changeset
|
77 stylesheet 'default.css'. |
b61680a0b29a
Add some whitespace for readability + some wording improvements.
diego
parents:
11188
diff
changeset
|
78 |
10926 | 79 7) In each translated file after the <?xml ... ?> tag you must put a note |
80 like <!-- synced with 1.2 -->, where 1.2 is the revision of corresponding | |
81 English file (see comment at the top of file). | |
11199
b61680a0b29a
Add some whitespace for readability + some wording improvements.
diego
parents:
11188
diff
changeset
|
82 |
11051 | 83 8) While your translation isn't finished, you can change USE_SYMLINKS |
84 to "yes" in your Makefile. This will help you testing your translation: | |
15778 | 85 English files will be used instead of untranslated ones, when generating |
11051 | 86 HTML docs. |
10926 | 87 |
9674 | 88 That's all, in theory. |