Mercurial > mplayer.hg
annotate DOCS/xml/README @ 10868:74fde9d0cab6
XML tools download and installation instructions
author | gabucino |
---|---|
date | Sun, 14 Sep 2003 19:10:55 +0000 |
parents | 970a95a4d856 |
children | a2b9b13af73f |
rev | line source |
---|---|
9674 | 1 Tools required for building the documentation |
2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
3 | |
4 * DocBook 4.1.2 or later | |
5 * The DocBook XML DTD (also known as DocBk XML) | |
6 * DocBook XSL stylesheets -- version 1.50.0 or later is recommended. | |
7 | |
8 I am not quite sure which tools work, but I used the following | |
9 ones successfully, so they are required: | |
10 | |
11 * xmllint (part of libxml2) is used for validation. | |
12 * xsltproc (part of libxslt1) is used for transforming XML files into HTML | |
13 files. Version 1.0.18 or later is recommended. | |
14 | |
10025 | 15 Also it's possible to use the Saxon XSLT Processor. Russian translator |
16 used it (version 6.4.4) for a while. To enable it change USE_SAXON to 1 in | |
17 the Makefile. | |
18 | |
9674 | 19 |
10868
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
20 Installing the required tools from source |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
21 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
22 |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
23 1) Download libxslt AND libxml2 packages from |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
24 http://xmlsoft.org/XSLT/downloads.html |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
25 |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
26 Installing them should be straightforward, executing the usual "./configure" |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
27 and "make" then "make install" commands. |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
28 |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
29 |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
30 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
|
31 Use the newest version. The URL will be something like this: |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
32 |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
33 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
|
34 |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
35 Extract this package into a directory, enter it, and execute the following |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
36 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 mkdir -p /usr/share/sgml/docbook/dtd/xml/4.2/ |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
39 cp -r * /usr/share/sgml/docbook/dtd/xml/4.2/ |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
40 |
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 3) Download the docbook-xsl package from |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
43 http://prdownloads.sourceforge.net/docbook/ |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
44 |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
45 Use the newest version. The URL will be something like this: |
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 http://prdownloads.sourceforge.net/docbook/docbook-xsl-1.62.0.tar.gz |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
48 |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
49 Extract this package into a directory, enter it, and execute the following |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
50 commands: |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
51 |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
52 mkdir -p /usr/share/sgml/docbook/stylesheet/xsl/nwalsh |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
53 cp -r VERSION common html lib \ |
74fde9d0cab6
XML tools download and installation instructions
gabucino
parents:
10025
diff
changeset
|
54 /usr/share/sgml/docbook/stylesheet/xsl/nwalsh |
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 |
9674 | 57 Building the documentation |
58 ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
59 | |
60 1) Before trying to build the documentation, run | |
61 | |
62 make test | |
63 | |
64 to see if everything is set up properly. If something goes wrong, | |
65 check the Configuration section of the toplevel Makefile and adjust | |
66 the variables. | |
67 | |
68 | |
69 2) Now simply run | |
70 | |
71 make all | |
72 | |
73 to build the documentation. | |
74 | |
75 | |
76 A few words about SGML catalog files | |
77 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
78 | |
79 As far as I know, the document type declaration in XML files requires | |
80 both a public and a system identifier. For example: | |
81 | |
82 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" | |
83 "/usr/share/sgml/docbook/dtd/xml/4.1.2/docbookx.dtd"> | |
84 | |
85 where | |
86 | |
87 "-//OASIS//DTD DocBook XML V4.1.2//EN" | |
88 | |
89 is the public, and | |
90 | |
91 "/usr/share/sgml/docbook/dtd/xml/4.1.2/docbookx.dtd" | |
92 | |
93 is the system identifier. | |
94 | |
95 The problem is that the system identifier is most probably system-dependent. | |
96 To avoid the need to manually fix the system identifiers before building the | |
97 documentation, I've decided to use SGML catalogs. If you have your catalogs | |
9953 | 98 set up correctly, xmllint and xsltproc will use them to find the DTDs |
9674 | 99 based on the public identifiers. |
100 | |
101 Note that this works only if public identifiers override system identifiers | |
102 (i.e. the catalog file must contain 'OVERRIDE YES'). (I had no problem with | |
103 these on my system, since the Debian people took care of everything. ;-)) | |
104 | |
105 | |
106 -- | |
107 Andras Mohari |