diff options
Diffstat (limited to 'nl_NL.ISO8859-1/books/fdp-primer/tools/chapter.xml')
| -rw-r--r-- | nl_NL.ISO8859-1/books/fdp-primer/tools/chapter.xml | 141 |
1 files changed, 141 insertions, 0 deletions
diff --git a/nl_NL.ISO8859-1/books/fdp-primer/tools/chapter.xml b/nl_NL.ISO8859-1/books/fdp-primer/tools/chapter.xml new file mode 100644 index 0000000000..f911e934ab --- /dev/null +++ b/nl_NL.ISO8859-1/books/fdp-primer/tools/chapter.xml @@ -0,0 +1,141 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved. + + Redistribution and use in source (SGML DocBook) and 'compiled' forms + (SGML, HTML, PDF, PostScript, RTF and so forth) with or without + modification, are permitted provided that the following conditions + are met: + + 1. Redistributions of source code (SGML DocBook) must retain the above + copyright notice, this list of conditions and the following + disclaimer as the first lines of this file unmodified. + + 2. Redistributions in compiled form (transformed to other DTDs, + converted to PDF, PostScript, RTF and other formats) must reproduce + the above copyright notice, this list of conditions and the + following disclaimer in the documentation and/or other materials + provided with the distribution. + + THIS DOCUMENTATION IS PROVIDED BY NIK CLAYTON "AS IS" AND ANY EXPRESS OR + IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL NIK CLAYTON BE LIABLE FOR ANY DIRECT, + INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE + POSSIBILITY OF SUCH DAMAGE. + + $FreeBSD$ +--> +<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="tools"> + <title>Tools</title> + + <para>Several software tools are used to manage the FreeBSD + documentation and render it to different output formats. Some of + these tools are required and must be installed before working + through the examples in the following chapters. Some are + optional, adding capabilities or making the job of creating + documentation less demanding.</para> + + <sect1 xml:id="tools-required"> + <title>Required Tools</title> + + <para>Install + <package>textproc/docproj</package> from the + Ports Collection. This <emphasis>meta-port</emphasis> installs + all the applications required to do useful work with the &os; + documentation. Some further notes on particular components are + given below.</para> + + <sect2> + <title><acronym>DTD</acronym>s and + <acronym>Entities</acronym></title> + + <para>&os; documentation uses several Document Type Definitions + (<acronym>DTD</acronym>s) and sets of <acronym>XML</acronym> + entities. These are all installed by the + <package>textproc/docproj</package> + port.</para> + + <variablelist> + <varlistentry> + <term><acronym>XHTML</acronym> <acronym>DTD</acronym> + (<package>textproc/xhtml</package>)</term> + + <listitem> + <para><acronym>XHTML</acronym> is the markup language of + choice for the World Wide Web, and is used throughout + the &os; web site.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>DocBook <acronym>DTD</acronym> (<package>textproc/docbook-xml-450</package>)</term> + + <listitem> + <para>DocBook is designed for marking up technical + documentation. Most of the &os; documentation is + written in DocBook.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>ISO 8879 entities + (<package>textproc/iso8879</package>)</term> + + <listitem> + <para>Character entities from the ISO 8879:1986 standard + used by many <acronym>DTD</acronym>s. Includes named + mathematical symbols, additional characters in the Latin + character set (accents, diacriticals, and so on), and + Greek symbols.</para> + </listitem> + </varlistentry> + </variablelist> + </sect2> + </sect1> + + <sect1 xml:id="tools-optional"> + <title>Optional Tools</title> + + <para>These applications are not required, but can make working on + the documentation easier or add capabilities.</para> + + <sect2> + <title>Software</title> + + <variablelist> + + <varlistentry> + <term><application>Vim</application> + (<package>editors/vim</package>)</term> + + <listitem> + <para>A popular editor for working with + <acronym>XML</acronym> and derived documents, like + DocBook <acronym>XML</acronym>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><application>Emacs</application> or + <application>XEmacs</application> + (<package>editors/emacs</package> or + <package>editors/xemacs</package>)</term> + + <listitem> + <para>Both of these editors include a special mode for + editing documents marked up according to an + <acronym>XML</acronym> <acronym>DTD</acronym>. This + mode includes commands to reduce the amount of typing + needed, and help reduce the possibility of + errors.</para> + </listitem> + </varlistentry> + </variablelist> + </sect2> + </sect1> +</chapter> |