[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#485689: should mention DocBook XML as documentation format



Package: developers-reference
Version: 3.3.9
Severity: normal
Tags: patch

The developers-reference and many other Debian documents are now
in DocBook XML format.
Index: tools.dbk
===================================================================
--- tools.dbk	(revisión: 5227)
+++ tools.dbk	(copia de trabajo)
@@ -499,12 +499,37 @@
 The following packages provide information for maintainers or help with
 building documentation.
 </para>
+
+<section id="docbook-xml">
+<title><systemitem role="package">docbook-xml</systemitem></title>
+<para>
+<systemitem role="package">docbook-xml</systemitem> provides the
+DocBook XML DTDs, which are commonly used for Debian documentation (as
+is the older debiandoc SGML DTD). This manual, for instance, is
+written in DocBook XML.
+</para>
+<para>
+The <systemitem role="package">docbook-xsl</systemitem> package
+provides the XSL files for building and styling the source to various
+output formats. You will need an XSLT processor, such as <systemitem
+role="package">xsltproc</systemitem>, to use the XSL stylesheets.
+Documentation for the stylesheets can be found in the various
+<systemitem role="package">docbook-xsl-doc-*</systemitem> packages.
+</para>
+<para>
+To produce PDF from FO, you need an FO processor, such as <systemitem
+role="package">xmlroff</systemitem> or <systemitem
+role="package">fop</systemitem>. Another tool to generate PDF from
+DocBook XML is <systemitem role="package">dblatex</systemitem>.
+</para>
+</section>
+
 <section id="debiandoc-sgml">
 <title><systemitem role="package">debiandoc-sgml</systemitem></title>
 <para>
-<systemitem role="package">debiandoc-sgml</systemitem> provides the DebianDoc
-SGML DTD, which is commonly used for Debian documentation.  This manual, for
-instance, is written in DebianDoc.  It also provides scripts for building and
+<systemitem role="package">debiandoc-sgml</systemitem> provides the
+DebianDoc SGML DTD, which is commonly used for Debian documentation
+(along with DocBook XML). It also provides scripts for building and
 styling the source to various output formats.
 </para>
 <para>
@@ -512,22 +537,6 @@
 role="package">debiandoc-sgml-doc</systemitem> package.
 </para>
 </section>
-<!-- TODO: Maybe better:
-<section id="docbook-xml">
-<title><systemitem role="package">docbook-xml</systemitem></title>
-<para>
-<systemitem role="package">docbook-xml</systemitem> provides the
-DocBook XML DTDs, which are commonly used for Debian documentation (as
-is the older debiandoc SGML DTD). This manual, for instance, is written
-in DocBook XML. The <systemitem
-role="package">docbook-xsl</systemitem> package provides the XSL files
-for building and styling the source to various output formats. You
-will need an XSLT processor, such as <systemitem
-role="package">xsltproc</systemitem>, and an FO processor, such as
-<systemitem role="package">fop</systemitem>, to generate documentation.
-</para>
-</section>
--->
 
 <section id="debian-keyring">
 <title><systemitem role="package">debian-keyring</systemitem></title>

Reply to: