LDP/LDP/guide/docbook/LDP-Author-Guide/tools.xml

125 lines
3.6 KiB
XML

<!--
<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.2//EN'>
-->
<appendix id="tools">
<title>System Setup: Editors, Validation and
Transformations</title>
<para>In this section, we will cover some of the tools
that you may want to use to create your own LDP documentation.
If you use some other tool to assist you in writing
documents for the LDP, please drop us a line and we'll add
a blurb for it here. <xref linkend="feedback" /> has contact
information.</para>
<section id="tools-distro"> <title>Tools for your operating
system</title>
<para>
A few notes on setting up your system for DocBook
publishing. These tools focus more on the transformation
of documents from DocBook to XHTML (for example).
</para>
<variablelist> <title>Tools For Your Operating System</title>
<!-- try to stay alphabetically correct... -->
<varlistentry> <term>Debian</term>
<listitem>
<para>
<ulink
url="http://www.docbook.org/wiki/moin.cgi/DebianGnuLinuxPackages">
http://www.docbook.org/wiki/moin.cgi/DebianGnuLinuxPackages
</ulink>
</para>
<para>
<ulink url="http://www.surgo.net">Morgon Kanter</ulink>
suggests <command>apt-get install docbook-xml
docbook-xsl xsltproc</command> as the minimum requirements.
<ulink url="http://lists.tldp.org/index.cgi?1:mss:4851" />
</para>
</listitem>
</varlistentry>
<varlistentry> <term>Fedora (aka the new
RedHat)</term>
<listitem> <para>
Notes contributed by <ulink
url="http://www.charlescurley.com">Charles
Curley</ulink>.
</para>
<para>
Tools for Docbook SGML and XML are included in the distrubution. So
are <application>Emacs</application> and <application>PSGML
mode</application>, although you will have to customize your
<filename>.emacs</filename>. If you are missing a package after installing
Fedora, get familiar with <application>yum</application> or
<application>apt</application>.
</para>
<para> Installation instructions: none; use Red Hat 9
until they are written: <ulink
url="http://www.redhat.com/docs/manuals/linux/RHL-9-Manual/" />.
</para> </listitem>
</varlistentry>
<varlistentry> <term>Mandrake</term>
<listitem> <para>
Notes contributed by <ulink
url="http://www.artemio.net">Artemio</ulink>.
</para>
<para>
In Mandrake (as of my current 9.2), all the
stuff including openjade, xmlto, docbook-utils
etc. comes as standard.
</para>
<para>
So I just needed to get the TLDP XSL sheet and
that's all. Didn't ever have any dependency
or other problems, everything works fine (knock
on wood :-)).
</para> </listitem>
</varlistentry>
<varlistentry> <term>RedHat</term>
<listitem> <para>
According to Hal Burgiss, your system is likely
already ready to edit and process DocBook
documents without installing any additional
packages.
</para> </listitem>
</varlistentry>
</variablelist>
</section> <!-- end of tools-distro -->
<!--
Tools to edit your document. Pretty straight forward
stuff. I'd like to update the screen shots so that they're a
printer-friendly size. And add screen shots for VIM *hearts to
vi* and Morphon and whoever else is missing pretty pictures.
-->
&tools-edit;
<!--
Tools to validate your XML/SGML There will be some duplication
in here as editing and validation may or may not be considered
the same thing. Mostly I'm keeping them separate because I use
VIM and all the stuff on emacs is useless to me. ;)
-->
&tools-validate;
<!--
Tools to Transform DocBook to other formats Mostly this is
a Jade/DSSSL section; but I'd like to add some XSLT stuff
because...well... I found it about 100 times easier to install.
-->
&tools-transform;
</appendix>