SDF 2.001: SDF User Guide: Introducing SDF

Contents | Parent Topic | Previous Topic | Next Topic
Home | Catalog

# 1.1. Introducing SDF

## 1.1.1. What is SDF?

SDF (Simple Document Format) is a freely available document development system which generates high quality outputs in a variety of formats from a single source. The output formats supported include PostScript™ , HTML, POD, plain text, man pages, LaTeX, SGML, Windows™ help, MIF and RTF. If the idea of specifying documents in a logical manner via a simple markup language sounds appealing, SDF may be useful to you.

SDF documents are simple to create and maintain, minimising the time spent on documentation. In particular, SDF directly supports the creation and maintenance of large, on-line documentation systems (including intranets) via centralised hypertext management and rule-based hypertext generation.

## 1.1.2. What is SDF useful for?

As well as normal documents, SDF is useful for:

- user manuals (paper-based and online)
- online document catalogs
- Perl module documentation
- Delphi™ component documentation
- source code listings (pretty printing most languages).

SDF is also good for literate programming, i.e. documentation can be embedded in the comments of most programming languages and can be selectively extracted. The embedded documentation can be in any markup language you like, although there are advantages to using SDF's markup language.

## 1.1.3. Requirements

SDF has been completely developed in Perl, a popular and highly portable scripting language. Perl 5.004 or later is recommended, although SDF may run on earlier versions of Perl 5.

To generate PostScript, SDF requires one of the following:

- the freely available pod2ps program
- the freely available SGML-Tools and LaTeX packages
- FrameMaker 5.x or later
- another word processor which can import RTF.

Earlier versions of FrameMaker will generally work, but I don't explicitly support them.

To generate Windows help, a help compiler (e.g. hcp.exe) is required.

## 1.1.4. SDF on the World Wide Web

The SDF home page URL is http://www.mincom.com/mtr/sdf. From the home page, you can:

- download the latest software
- browse the FAQ
- report defects
- suggest enhancements.

## 1.1.5. Fetching SDF

SDF is available using anonymous ftp. The URL of the base directory is ftp://ftp.mincom.com/pub/mtr/sdf. The latest release is available in a variety of formats.

## 1.1.6. Mailing lists

The following mailing lists are available:

- sdf-users@mincom.com - for general questions
- sdf-bugs@mincom.com - for reporting bugs and fixes.

To subscribe to these lists, send email to sdf-users-request@mincom.com and/or sdf-bugs-request@mincom.com for instructions on using factotum, the majordomo variant that manages these lists. In short, send email to factotum@mincom.com with a message body of subscribe sdf-users or subscribe sdf-bugs.