Mercurial > mplayer.hg

comparison DOCS/xml/README @ 11269:669e67c3d6b3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Red Hat support added by Dominik, README updated.
author diego
date Sun, 26 Oct 2003 13:43:26 +0000
parents a2b9b13af73f
children 6363be1eb800
comparison
equal deleted inserted replaced
11268:c367751bd7cb 11269:669e67c3d6b3
8 I am not quite sure which tools work, but I used the following 8 I am not quite sure which tools work, but I used the following
9 ones successfully, so they are required: 9 ones successfully, so they are required:
10 10
11 * xmllint (part of libxml2) is used for validation. 11 * xmllint (part of libxml2) is used for validation.
12 * xsltproc (part of libxslt1) is used for transforming XML files into HTML 12 * xsltproc (part of libxslt1) is used for transforming XML files into HTML
13 files. Version 1.0.18 or later is recommended. 13 files. Version 1.0.18 or later is recommended.
14 14
15 Also it's possible to use the Saxon XSLT Processor. Russian translator 15 It's also possible to use the Saxon XSLT Processor. The Russian translator
16 used it (version 6.4.4) for a while. If you have suitable JavaVM and a saxon.jar 16 used it (version 6.4.4) for a while. If you have a suitable JavaVM and a
17 installed somewhere, configure will try to detect them. If autodetection fails, 17 saxon.jar installed somewhere, configure will try to detect them. If
18 try to tweak DOCS/xml/configure to get it working and send us a patch :) 18 autodetection fails, try to tweak DOCS/xml/configure to get it working and
19 send us a patch :)
20
21 On Red Hat systems you need the following packages:
22 libxml2, libxslt, docbook-dtds, docbook-style-xsl
19 23
20 24
21 25
22 Installing the required tools from source 26 Installing the required tools from source
23 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 27 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 28
25 1) Download libxslt AND libxml2 packages from 29 1) Download libxslt AND libxml2 packages from
26 http://xmlsoft.org/XSLT/downloads.html 30 http://xmlsoft.org/XSLT/downloads.html
27 31
28 Installing them should be straightforward, executing the usual "./configure" 32 Installing them should be straightforward, execute the usual "./configure"
29 and "make" then "make install" commands. 33 and "make" then "make install" commands.
30 34
31 35
32 2) Download the docbook-xml package from http://www.oasis-open.org/docbook/xml/ 36 2) Download the docbook-xml package from http://www.oasis-open.org/docbook/xml/
33 Use the newest version. The URL will be something like this: 37 Use the newest version. The URL will be something like this:
57 61
58 62
59 Building the documentation 63 Building the documentation
60 ~~~~~~~~~~~~~~~~~~~~~~~~~~ 64 ~~~~~~~~~~~~~~~~~~~~~~~~~~
61 65
62 1) Before trying to build the documentation, run 66 Before trying to build the documentation, run
63 67
64 make test 68 make help
65 69
66 to see if everything is set up properly. If something goes wrong, 70 to see all available build targets and make your choice. If something goes
67 check the Configuration section of the toplevel Makefile and adjust 71 wrong, check the Configuration section of the toplevel Makefile and adjust
68 the variables. 72 the variables.
69
70
71 2) Now simply run
72
73 make all
74
75 to build the documentation.
76 73
77 74
78 A few words about SGML catalog files 75 A few words about SGML catalog files
79 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 76 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
80 77
81 As far as I know, the document type declaration in XML files requires 78 As far as I know, the document type declaration in XML files requires
82 both a public and a system identifier. For example: 79 both a public and a system identifier. For example:
83 80
84 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 81 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
85 "/usr/share/sgml/docbook/dtd/xml/4.1.2/docbookx.dtd"> 82 "/usr/share/sgml/docbook/dtd/xml/4.1.2/docbookx.dtd">
86 83
87 where 84 where
94 91
95 is the system identifier. 92 is the system identifier.
96 93
97 The problem is that the system identifier is most probably system-dependent. 94 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 95 To avoid the need to manually fix the system identifiers before building the
99 documentation, I've decided to use SGML catalogs. If you have your catalogs 96 documentation, I've decided to use SGML catalogs. If you have your catalogs
100 set up correctly, xmllint and xsltproc will use them to find the DTDs 97 set up correctly, xmllint and xsltproc will use them to find the DTDs
101 based on the public identifiers. 98 based on the public identifiers.
102 99
103 Note that this works only if public identifiers override system identifiers 100 Note that this works only if public identifiers override system identifiers
104 (i.e. the catalog file must contain 'OVERRIDE YES'). (I had no problem with 101 (i.e. the catalog file must contain 'OVERRIDE YES'). (I had no problem with
105 these on my system, since the Debian people took care of everything. ;-)) 102 these on my system, since the Debian people took care of everything. ;-))
106
107
108 --
109 Andras Mohari