Index: head/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml =================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml (revision 47397) +++ head/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml (revision 47398) @@ -1,164 +1,141 @@ Tools 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. Required Tools Install textproc/docproj from the Ports Collection. This meta-port installs all the applications required to do useful work with the &os; documentation. Some further notes on particular components are given below. <acronym>DTD</acronym>s and <acronym>Entities</acronym> &os; documentation uses several Document Type Definitions (DTDs) and sets of XML entities. These are all installed by the textproc/docproj port. XHTML DTD (textproc/xhtml) XHTML is the markup language of choice for the World Wide Web, and is used throughout the &os; web site. DocBook DTD (textproc/docbook-xml-450) DocBook is designed for marking up technical documentation. Most of the &os; documentation is written in DocBook. ISO 8879 entities (textproc/iso8879) Character entities from the ISO 8879:1986 standard used by many DTDs. Includes named mathematical symbols, additional characters in the Latin character set (accents, diacriticals, and so on), and Greek symbols. Optional Tools These applications are not required, but can make working on the documentation easier or add capabilities. Software - - JadeTeX, - teTeX and Modular DocBook - Stylesheets - (print/jadetex, - print/teTeX and - textproc/dsssl-docbook-modular) - - - Jade, - teTeX and Modular DocBook - Stylesheets are used to convert DocBook documents to - DVI, Postscript, and PDF formats. The - JadeTeX macros are needed to - do this. - - If XHTML and plain text output - formats are adequate, then this program is not needed - and the option to install it from the - textproc/docproj - configuration screen can be disabled. - - Vim (editors/vim) A popular editor for working with XML and derived documents, like DocBook XML. Emacs or XEmacs (editors/emacs or editors/xemacs) Both of these editors include a special mode for editing documents marked up according to an XML DTD. This mode includes commands to reduce the amount of typing needed, and help reduce the possibility of errors.