Bug#485689: should mention DocBook XML as documentation format
tags 485689 + pending
thanks
On 13/06/08 at 15:13 +0200, W. Martin Borgert wrote:
> On Fri, Jun 13, 2008 at 12:41:25PM +0200, Raphael Hertzog wrote:
> > Do you agree that we should recommend
> > usage of docbook for new documents in general
>
> Yes.
>
> > and that debiandoc-sgml,
> > while still maintained, should be considered deprecated?
>
> If the debiandoc-sgml maintainers don't feel strongly in favour
> of it, yes.
Hi,
I applied the following patch to svn:
diff --git a/tools.dbk b/tools.dbk
index 2e5dda2..a9b4b81 100644
--- a/tools.dbk
+++ b/tools.dbk
@@ -499,12 +499,40 @@ enhanced to support cross-compiling.
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
+SGML DTD, which is commonly used for Debian documentation,
+but is now deprecated
+(<systemitem role="package">docbook-xml</systemitem>
+should be used instead).
+It also provides scripts for building and
styling the source to various output formats.
</para>
<para>
@@ -512,22 +540,6 @@ Documentation for the DTD can be found in the <systemitem
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>
--
| Lucas Nussbaum
| lucas@lucas-nussbaum.net http://www.lucas-nussbaum.net/ |
| jabber: lucas@nussbaum.fr GPG: 1024D/023B3F4F |
Reply to: