Mercurial > mplayer.hg
annotate DOCS/xml/README @ 13951:a181e18aba8d
sync to 1.23
author | gabrov |
---|---|
date | Mon, 15 Nov 2004 11:49:53 +0000 |
parents | 21173b458231 |
children | 61e033e4daee |
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 It's also possible to use the Saxon XSLT Processor. The Russian translator |
17 used it (version 6.4.4) for a while. If you have a suitable JavaVM and a | |
18 saxon.jar installed somewhere, configure will try to detect them. If | |
19 autodetection fails, try to tweak DOCS/xml/configure to get it working and | |
20 send us a patch :) | |
21 | |
22 On Red Hat systems you need the following packages: | |
23 libxml2, libxslt, docbook-dtds, docbook-style-xsl | |
10911 | 24 |
12604 | 25 On Debian Sarge you will need these packages: |
26 libxml2, libxml2-utils, docbook-xsl, libxslt1.1, docbook, docbook-utils | |
10025 | 27 |
9674 | 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 | 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 | 66 Building the documentation |
67 ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
68 | |
11269 | 69 Before trying to build the documentation, run |
9674 | 70 |
11269 | 71 make help |
9674 | 72 |
11269 | 73 to see all available build targets and make your choice. If something goes |
74 wrong, check the Configuration section of the toplevel Makefile and adjust | |
75 the variables. | |
9674 | 76 |
77 | |
78 A few words about SGML catalog files | |
79 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
80 | |
81 As far as I know, the document type declaration in XML files requires | |
11269 | 82 both a public and a system identifier. For example: |
9674 | 83 |
84 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" | |
85 "/usr/share/sgml/docbook/dtd/xml/4.1.2/docbookx.dtd"> | |
86 | |
87 where | |
88 | |
89 "-//OASIS//DTD DocBook XML V4.1.2//EN" | |
90 | |
91 is the public, and | |
92 | |
93 "/usr/share/sgml/docbook/dtd/xml/4.1.2/docbookx.dtd" | |
94 | |
95 is the system identifier. | |
96 | |
97 The problem is that the system identifier is most probably system-dependent. | |
98 To avoid the need to manually fix the system identifiers before building the | |
11269 | 99 documentation, I've decided to use SGML catalogs. If you have your catalogs |
9953 | 100 set up correctly, xmllint and xsltproc will use them to find the DTDs |
9674 | 101 based on the public identifiers. |
102 | |
103 Note that this works only if public identifiers override system identifiers | |
11269 | 104 (i.e. the catalog file must contain 'OVERRIDE YES'). (I had no problem with |
9674 | 105 these on my system, since the Debian people took care of everything. ;-)) |