annotate DOCS/xml/README @ 23588:a44fc12de744

Nico claims to never have had any problems with X11 compilation on Mandrake.
author diego
date Sat, 23 Jun 2007 08:22:10 +0000
parents 61e033e4daee
children 0ad2da052b2e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9674
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
1 Tools required for building the documentation
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
3
11945
6363be1eb800 We need make 3.80 to build.
diego
parents: 11269
diff changeset
4 * GNU make 3.80 or later
9674
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
5 * DocBook 4.1.2 or later
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
6 * The DocBook XML DTD (also known as DocBk XML)
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
7 * DocBook XSL stylesheets -- version 1.50.0 or later is recommended.
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
8
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
9 I am not quite sure which tools work, but I used the following
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
10 ones successfully, so they are required:
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
11
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
12 * xmllint (part of libxml2) is used for validation.
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
13 * xsltproc (part of libxslt1) is used for transforming XML files into HTML
11269
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
14 files. Version 1.0.18 or later is recommended.
9674
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
15
11269
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
16 It's also possible to use the Saxon XSLT Processor. The Russian translator
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
17 used it (version 6.4.4) for a while. If you have a suitable JavaVM and a
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
18 saxon.jar installed somewhere, configure will try to detect them. If
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
19 autodetection fails, try to tweak DOCS/xml/configure to get it working and
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
20 send us a patch :)
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
21
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
22 On Red Hat systems you need the following packages:
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
23 libxml2, libxslt, docbook-dtds, docbook-style-xsl
10911
a2b9b13af73f Update readme's. Remove incorrect bug :)
lumag
parents: 10868
diff changeset
24
12604
21173b458231 Debian Sarge build instructions
wight
parents: 11945
diff changeset
25 On Debian Sarge you will need these packages:
17759
61e033e4daee Correct toolchain for building XML docs on Debian Sarge.
diego
parents: 12604
diff changeset
26 docbook-xml, docbook-xsl, xsltproc, libxml2-utils
10025
970a95a4d856 Add support for the Saxon XSLT Processor.
lumag
parents: 9953
diff changeset
27
9674
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
28
10868
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
29 Installing the required tools from source
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
30 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
31
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
32 1) Download libxslt AND libxml2 packages from
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
33 http://xmlsoft.org/XSLT/downloads.html
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
34
11269
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
35 Installing them should be straightforward, execute the usual "./configure"
10868
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
36 and "make" then "make install" commands.
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
37
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
38
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
39 2) Download the docbook-xml package from http://www.oasis-open.org/docbook/xml/
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
40 Use the newest version. The URL will be something like this:
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
41
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
42 http://www.oasis-open.org/docbook/xml/4.2/docbook-xml-4.2.zip
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
43
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
44 Extract this package into a directory, enter it, and execute the following
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
45 commands:
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
46
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
47 mkdir -p /usr/share/sgml/docbook/dtd/xml/4.2/
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
48 cp -r * /usr/share/sgml/docbook/dtd/xml/4.2/
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
49
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
50
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
51 3) Download the docbook-xsl package from
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
52 http://prdownloads.sourceforge.net/docbook/
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
53
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
54 Use the newest version. The URL will be something like this:
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
55
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
56 http://prdownloads.sourceforge.net/docbook/docbook-xsl-1.62.0.tar.gz
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
57
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
58 Extract this package into a directory, enter it, and execute the following
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
59 commands:
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
60
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
61 mkdir -p /usr/share/sgml/docbook/stylesheet/xsl/nwalsh
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
62 cp -r VERSION common html lib \
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
63 /usr/share/sgml/docbook/stylesheet/xsl/nwalsh
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
64
74fde9d0cab6 XML tools download and installation instructions
gabucino
parents: 10025
diff changeset
65
9674
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
66 Building the documentation
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
67 ~~~~~~~~~~~~~~~~~~~~~~~~~~
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
68
11269
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
69 Before trying to build the documentation, run
9674
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
70
11269
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
71 make help
9674
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
72
11269
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
73 to see all available build targets and make your choice. If something goes
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
74 wrong, check the Configuration section of the toplevel Makefile and adjust
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
75 the variables.
9674
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
76
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
77
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
78 A few words about SGML catalog files
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
79 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
80
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
81 As far as I know, the document type declaration in XML files requires
11269
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
82 both a public and a system identifier. For example:
9674
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
83
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
84 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
85 "/usr/share/sgml/docbook/dtd/xml/4.1.2/docbookx.dtd">
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
86
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
87 where
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
88
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
89 "-//OASIS//DTD DocBook XML V4.1.2//EN"
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
90
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
91 is the public, and
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
92
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
93 "/usr/share/sgml/docbook/dtd/xml/4.1.2/docbookx.dtd"
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
94
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
95 is the system identifier.
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
96
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
97 The problem is that the system identifier is most probably system-dependent.
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
98 To avoid the need to manually fix the system identifiers before building the
11269
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
99 documentation, I've decided to use SGML catalogs. If you have your catalogs
9953
diego
parents: 9674
diff changeset
100 set up correctly, xmllint and xsltproc will use them to find the DTDs
9674
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
101 based on the public identifiers.
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
102
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
103 Note that this works only if public identifiers override system identifiers
11269
669e67c3d6b3 Red Hat support added by Dominik, README updated.
diego
parents: 10911
diff changeset
104 (i.e. the catalog file must contain 'OVERRIDE YES'). (I had no problem with
9674
461f71ba8af4 XML version of MPlayer's doc
nicolas
parents:
diff changeset
105 these on my system, since the Debian people took care of everything. ;-))