Mercurial > mplayer.hg
annotate DOCS/xml/README @ 36308:687e65bf99f9
Make fallback for failing context creation actually work.
author | reimar |
---|---|
date | Mon, 05 Aug 2013 16:51:10 +0000 |
parents | 91794b4aa5d0 |
children |
rev | line source |
---|---|
9674 | 1 Tools required for building the documentation |
2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
3 | |
11945 | 4 * GNU make 3.80 or later |
9674 | 5 * DocBook 4.1.2 or later |
6 * The DocBook XML DTD (also known as DocBk XML) | |
7 * DocBook XSL stylesheets -- version 1.50.0 or later is recommended. | |
8 | |
9 I am not quite sure which tools work, but I used the following | |
10 ones successfully, so they are required: | |
11 | |
12 * xmllint (part of libxml2) is used for validation. | |
13 * xsltproc (part of libxslt1) is used for transforming XML files into HTML | |
11269 | 14 files. Version 1.0.18 or later is recommended. |
9674 | 15 |
11269 | 16 On Red Hat systems you need the following packages: |
17 libxml2, libxslt, docbook-dtds, docbook-style-xsl | |
10911 | 18 |
31775
44a63a5a3175
The package list for Debian systems is not specific to the Sarge release.
diego
parents:
31470
diff
changeset
|
19 On Debian you will need these packages: |
17759
61e033e4daee
Correct toolchain for building XML docs on Debian Sarge.
diego
parents:
12604
diff
changeset
|
20 docbook-xml, docbook-xsl, xsltproc, libxml2-utils |
10025 | 21 |
9674 | 22 |
23 Building the documentation | |
24 ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
25 | |
31108
20cee5a646b3
Merge both XML documentation README files into one.
diego
parents:
30990
diff
changeset
|
26 The documentation and its translations reside in subdirectories. |
20cee5a646b3
Merge both XML documentation README files into one.
diego
parents:
30990
diff
changeset
|
27 When building the documentation, the generated HTML files are |
20cee5a646b3
Merge both XML documentation README files into one.
diego
parents:
30990
diff
changeset
|
28 placed in subdirectories of the 'HTML' directory. |
20cee5a646b3
Merge both XML documentation README files into one.
diego
parents:
30990
diff
changeset
|
29 |
20cee5a646b3
Merge both XML documentation README files into one.
diego
parents:
30990
diff
changeset
|
30 IMPORTANT: Do NOT place sensitive files under 'HTML'! |
20cee5a646b3
Merge both XML documentation README files into one.
diego
parents:
30990
diff
changeset
|
31 It is for generated documentation only. |
20cee5a646b3
Merge both XML documentation README files into one.
diego
parents:
30990
diff
changeset
|
32 The whole directory tree is wiped out by the Makefile |
20cee5a646b3
Merge both XML documentation README files into one.
diego
parents:
30990
diff
changeset
|
33 when running 'make distclean' or 'make clean'. |
20cee5a646b3
Merge both XML documentation README files into one.
diego
parents:
30990
diff
changeset
|
34 |
20cee5a646b3
Merge both XML documentation README files into one.
diego
parents:
30990
diff
changeset
|
35 |
9674 | 36 A few words about SGML catalog files |
37 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
38 | |
39 As far as I know, the document type declaration in XML files requires | |
11269 | 40 both a public and a system identifier. For example: |
9674 | 41 |
42 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" | |
30990 | 43 "/usr/share/sgml/docbook/dtd/xml/4.1.2/docbookx.dtd"> |
9674 | 44 |
45 where | |
46 | |
30990 | 47 "-//OASIS//DTD DocBook XML V4.1.2//EN" |
9674 | 48 |
49 is the public, and | |
50 | |
30990 | 51 "/usr/share/sgml/docbook/dtd/xml/4.1.2/docbookx.dtd" |
9674 | 52 |
53 is the system identifier. | |
54 | |
55 The problem is that the system identifier is most probably system-dependent. | |
56 To avoid the need to manually fix the system identifiers before building the | |
11269 | 57 documentation, I've decided to use SGML catalogs. If you have your catalogs |
9953 | 58 set up correctly, xmllint and xsltproc will use them to find the DTDs |
9674 | 59 based on the public identifiers. |
60 | |
61 Note that this works only if public identifiers override system identifiers | |
11269 | 62 (i.e. the catalog file must contain 'OVERRIDE YES'). (I had no problem with |
9674 | 63 these on my system, since the Debian people took care of everything. ;-)) |