1
0
mirror of https://github.com/mpv-player/mpv synced 2024-12-15 11:25:10 +00:00
mpv/DOCS/xml
lumag 0da0c7ec9a Sync
git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@11143 b3059339-0415-0410-9bf9-f77b7e298cf2
2003-10-16 11:32:11 +00:00
..
en punctuation fixes 2003-10-16 08:26:40 +00:00
es Errare humanum est. Buxfixes, now compile ok. 2003-10-12 23:34:06 +00:00
fr sync, typos, cosmetics, more accurate translation & other various fixes 2003-10-12 09:46:57 +00:00
pl Don't include chunk.xsl directly. 2003-10-15 21:06:57 +00:00
ru Sync 2003-10-16 11:32:11 +00:00
xsl
.cvsignore XML autoconfiguration by Dmitry Baryshkov <lumag@qnc.ru> with some 2003-06-18 17:37:36 +00:00
configure Cygwin support 2003-10-05 01:06:30 +00:00
default.css
html-common.xsl Generate more links for Site navigation Bar. 2003-05-20 07:11:33 +00:00
ldp.dsl
Makefile Also build Polish documentation. 2003-10-15 17:00:25 +00:00
Makefile.inc Support for building incomplete translations. 2003-10-08 02:00:59 +00:00
README Update readme's. Remove incorrect bug :) 2003-09-21 13:01:25 +00:00
README.maintainers Document, that chunk.xsl mustn't be included directly. 2003-10-15 20:54:38 +00:00

Tools required for building the documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* DocBook 4.1.2 or later
* The DocBook XML DTD (also known as DocBk XML)
* DocBook XSL stylesheets -- version 1.50.0 or later is recommended.

I am not quite sure which tools work, but I used the following
ones successfully, so they are required:

* xmllint (part of libxml2) is used for validation.
* xsltproc (part of libxslt1) is used for transforming XML files into HTML
  files.  Version 1.0.18 or later is recommended.

Also it's possible to use the Saxon XSLT Processor. Russian translator
used it (version 6.4.4) for a while. If you have suitable JavaVM and a saxon.jar
installed somewhere, configure will try to detect them. If autodetection fails,
try to tweak DOCS/xml/configure to get it working and send us a patch :)



Installing the required tools from source
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1) Download libxslt AND libxml2 packages from
   http://xmlsoft.org/XSLT/downloads.html

   Installing them should be straightforward, executing the usual "./configure"
   and "make" then "make install" commands.


2) Download the docbook-xml package from http://www.oasis-open.org/docbook/xml/
   Use the newest version. The URL will be something like this:

	http://www.oasis-open.org/docbook/xml/4.2/docbook-xml-4.2.zip

   Extract this package into a directory, enter it, and execute the following
   commands:

	mkdir -p /usr/share/sgml/docbook/dtd/xml/4.2/
	cp -r * /usr/share/sgml/docbook/dtd/xml/4.2/


3) Download the docbook-xsl package from
   http://prdownloads.sourceforge.net/docbook/

   Use the newest version. The URL will be something like this:

	http://prdownloads.sourceforge.net/docbook/docbook-xsl-1.62.0.tar.gz

   Extract this package into a directory, enter it, and execute the following
   commands:

	mkdir -p /usr/share/sgml/docbook/stylesheet/xsl/nwalsh
	cp -r VERSION common html lib \
		/usr/share/sgml/docbook/stylesheet/xsl/nwalsh


Building the documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~

1) Before trying to build the documentation, run

	make test

   to see if everything is set up properly.  If something goes wrong,
   check the Configuration section of the toplevel Makefile and adjust
   the variables.


2) Now simply run

	make all

   to build the documentation.


A few words about SGML catalog files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

As far as I know, the document type declaration in XML files requires
both a public and a system identifier.  For example:

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
	"/usr/share/sgml/docbook/dtd/xml/4.1.2/docbookx.dtd">

where

	"-//OASIS//DTD DocBook XML V4.1.2//EN"

is the public, and

	"/usr/share/sgml/docbook/dtd/xml/4.1.2/docbookx.dtd"

is the system identifier.

The problem is that the system identifier is most probably system-dependent.
To avoid the need to manually fix the system identifiers before building the
documentation, I've decided to use SGML catalogs.  If you have your catalogs
set up correctly, xmllint and xsltproc will use them to find the DTDs
based on the public identifiers.

Note that this works only if public identifiers override system identifiers
(i.e. the catalog file must contain 'OVERRIDE YES').  (I had no problem with
these on my system, since the Debian people took care of everything. ;-))


--
Andras Mohari