5.  How to Use roffToWeb

The roffToWeb toolkit is easy to use even though is has many components, some of which are mentioned below. To begin a new project, the user must:

1.

Use mk_init to create a default web site information file, called info, create the necessary directories and set up the commands needed for the next steps of the process.

2.

Edit the web site information file, an example of which is shown below.

 1      MAIL_TO= your_email_address             # for example: hpb@cs.rit.edu
 2      TITLE="Web page Titel"                  # for example: "Compiler Design I"
 3      COPYRIGHT="you name"                    # for example: "Hans-Peter Bischof"
 4      DIR_IN_PUBLIC_HTML="the_public_html_directory"
 5                                              # for example: "~/public_html/cd_I"

3.

Write the content of the troff source files. These are named c.01, c.02, c.03 etc.

4.

Use mk_gen to create the makfile that will contain targets such as:

Targets   Description
-------------------------------------------------------------------
i         creates the PostScript file of chapter i
i.links   creates the linked HTML version of chapter i
all       creates the PostScript file of all chapters
copy      creates the linked HTML version of all chapters, creates
          the search index, and copies the resulting into the
          ~/public_html directroy structure.

4.

Use make to create the PostScript and HTML files, and to move them into the public_html directory.

Last modified: 24/November/98 (09:40)