Mercurial > mplayer.hg
annotate DOCS/xml/README.maintainers @ 29978:253fb126c4ee
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 |
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 | |
29964
5513e1981e0e
- Remove now unnecessary dependency on intermediate directories.
diego
parents:
21627
diff
changeset
|
5 in subdirectories of the 'HTML' directory. |
9674 | 6 |
29964
5513e1981e0e
- Remove now unnecessary dependency on intermediate directories.
diego
parents:
21627
diff
changeset
|
7 IMPORTANT: Do NOT place sensitive files under 'HTML'! |
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. | |
29978 | 17 The main target usually depends on all the XML files in the subdirectory. |
9674 | 18 |
19 | |
20 Adding new translations | |
21 ~~~~~~~~~~~~~~~~~~~~~~~ | |
22 | |
18409 | 23 1) Create a new subdirectory and copy the XML files there. main.xml must not be |
24 copied, it is autogenerated. | |
11199
b61680a0b29a
Add some whitespace for readability + some wording improvements.
diego
parents:
11188
diff
changeset
|
25 |
9674 | 26 2) Make sure to create a 'Makefile' for the translation -- you can |
27 use 'en/Makefile' as an example. | |
11199
b61680a0b29a
Add some whitespace for readability + some wording improvements.
diego
parents:
11188
diff
changeset
|
28 |
29978 | 29 3) In each translated file after the <?xml ... ?> tag you must put a note |
21627 | 30 like <!-- synced with r2 -->, where 2 is the revision of corresponding |
10926 | 31 English file (see comment at the top of file). |
11199
b61680a0b29a
Add some whitespace for readability + some wording improvements.
diego
parents:
11188
diff
changeset
|
32 |
9674 | 33 That's all, in theory. |