Contents of /manuals/trunk/release-notes/README

Release Notes

The Release Notes contain important information for new users and for
an update from the previous version of Debian. It is written in
DocBook XML which allows the creation of various output files in the
formats HTML, text, PDF, ...

To build it you need these packages:
 - docbook-xsl         (transformation stylesheets)
 - libxml2-utils       (for xmllint)
 - dblatex and xmlroff (depending on the output format and language)
 - po4a                (for handling PO file based translations)
 - make                (or you will type a lot)
 - ttf-arphic-*        (fonts)
 - texlive-*           (used by dblatex)
 - w3m                 (to create the text version)

For etch, you need the lenny backports of dblatex and xmlroff.

Just call "make" to build it. To build the release notes in a single
format (html or txt or pdf) for a single language (e.g. zh_CN, en, es)
and the "all" pseudo-architecture, call e.g.:
"make html LINGUA=es architecture=all".

Translations

The document is available in many languages. po4a is currently used as
the translation tool.

To add a new language "new", do as follows:

$ svn checkout svn+ssh://svn.debian.org/svn/ddp/manuals/trunk/release-notes
$ mkdir new (in the source directory, of course)
$ make updatepo LINGUA=new
(now translate all po files in new/)
$ make tidypo LINGUA=new (always before commit!)
$ make validate LINGUA=new (always before commit!)
(fix any XML validity problems)
$ make html txt pdf LINGUA=new architecture=all
(proof-read and correct)
$ svn commit

Some translators prefer full-text translation without po. For this
style of translations, the original English files are just copied
into the language directory and the translators have to make sure,
that the translation is up to date.

Send your translation for inclusion to the public mailing list
debian-doc@lists.debian.org.
1	Release Notes
2
3	The Release Notes contain important information for new users and for
4	an update from the previous version of Debian. It is written in
5	DocBook XML which allows the creation of various output files in the
6	formats HTML, text, PDF, ...
7
8	To build it you need these packages:
9	- docbook-xsl (transformation stylesheets)
10	- libxml2-utils (for xmllint)
11	- dblatex and xmlroff (depending on the output format and language)
12	- po4a (for handling PO file based translations)
13	- make (or you will type a lot)
14	- ttf-arphic-* (fonts)
15	- texlive-* (used by dblatex)
16	- w3m (to create the text version)
17
18	For etch, you need the lenny backports of dblatex and xmlroff.
19
20	Just call "make" to build it. To build the release notes in a single
21	format (html or txt or pdf) for a single language (e.g. zh_CN, en, es)
22	and the "all" pseudo-architecture, call e.g.:
23	"make html LINGUA=es architecture=all".
24
25	Translations
26
27	The document is available in many languages. po4a is currently used as
28	the translation tool.
29
30	To add a new language "new", do as follows:
31
32	$ svn checkout svn+ssh://svn.debian.org/svn/ddp/manuals/trunk/release-notes
33	$ mkdir new (in the source directory, of course)
34	$ make updatepo LINGUA=new
35	(now translate all po files in new/)
36	$ make tidypo LINGUA=new (always before commit!)
37	$ make validate LINGUA=new (always before commit!)
38	(fix any XML validity problems)
39	$ make html txt pdf LINGUA=new architecture=all
40	(proof-read and correct)
41	$ svn commit
42
43	Some translators prefer full-text translation without po. For this
44	style of translations, the original English files are just copied
45	into the language directory and the translators have to make sure,
46	that the translation is up to date.
47
48	Send your translation for inclusion to the public mailing list
49	debian-doc@lists.debian.org.