FreeBSD Documentation Project Primer for New Contributors
Prev		Next

Chapter 2. Tools

Table of Contents
2.1. Mandatory tools
2.2. Optional tools

The FDP uses a number of different software tools to help manage the FreeBSD documentation, convert it to different output formats, and so on. You will need to use these tools yourself if you are to work with the FreeBSD documentation.

All these tools are available as FreeBSD Ports and Packages, greatly simplifying the work you have to do to install them.

You will need to install these tools before you work through any of the examples in later chapters. The actual usage of these tools is covered in later chapters.

Use textproc/docproj if possible: You can save yourself a lot of time if you install the textproc/docproj port. This is a meta-port which does not contain any software itself. Instead, it depends on various other ports being installed correctly. Installing this port should automatically download and install all of the packages listed in this chapter that you need.

One of the packages that you might need is the JadeTeX macro set. In turn, this macro set requires that TeX is installed. TeX is a large package, and you only need it if you want to produce Postscript or PDF output.

To save yourself time and space you must specify whether or not you want JadeTeX (and therefore TeX) installed when you install this port. Either do;
    # make JADETEX=yes install
or
    # make JADETEX=no install
as necessary.

2.1. Mandatory tools

2.1.1. Software

These programs are required before you can usefully work with the FreeBSD documentation. They are all included in textproc/docproj.

SP (textproc/sp): A suite of applications, including a validating SGML parser, and an SGML normaliser.
Jade (textproc/jade): A DSSSL implementation. Used for converting marked up documents to other formats, including HTML and TeX.
Tidy (www/tidy): An HTML 'pretty printer', used to reformat some of the automatically generated HTML so that it is easier to follow.
W3M (www/w3m): A text-mode WWW browser, w3m(1) can also convert HTML files to plain text.

2.1.2. DTDs and Entities

These are the DTDs and entity sets used by the FDP. They need to be installed before you can work with any of the documentation.

HTML DTD (textproc/html): HTML is the markup language of choice for the World Wide Web, and is used throughout the FreeBSD web site.
LinuxDoc DTD (textproc/linuxdoc): Some FreeBSD documentation is marked up in LinuxDoc. The FDP is actively migrating from LinuxDoc to DocBook.
DocBook DTD (textproc/docbook): DocBook is designed for marking up technical documentation, and the FDP is migrating from LinuxDoc to DocBook. At the time of writing, this document and the FreeBSD Handbook are marked up in DocBook.
ISO 8879 entities (textproc/iso8879): 19 of the ISO 8879:1986 character entity sets used by many DTDs. Includes named mathematical symbols, additional characters in the 'latin' character set (accents, diacriticals, and so on), and greek symbols.

2.1.3. Stylesheets

The stylesheets are used when converting and formatting the documentation for display on screen, printing, and so on.

Modular DocBook Stylesheets (textproc/dsssl-docbook-modular): The Modular DocBook Stylesheets are used when converting documentation marked up in DocBook to other formats, such as HTML or RTF.

Prev	Home	Next
Before you start		Optional tools