Introduction to htmlpp

Introduction  Introduction 
Overview Getting Started

How do I use htmlpp?

  • Take a look at htmlpp.htp, which is the documentation source for htmlpp's own on-line documentation and comes with htmlpp. This is the main example for htmlpp.
  • The file that is supplied with htmlpp contains the basis for a new project. Unzip this file into a working directory. You'll find:
    • template.txt - template for new documentation text files.
    • prelude.def - standard definitions - e.g. page header and footer.
    • contents.def - build table of contents.
    • filetype.def - definitions for various file types.

    As a start, run htmlpp on template.txt:

    C:\SOMEDIR\>htmlpp template.txt

    This creates a set of HTML files (extension .htm). You can open index.htm with a browser, and the links should work. Then edit the source files using any text editor and modify them to your will.

  • In general, htmlpp generates HTML pages that use relative addressing, so that pages refer to each other without specifying a host or path. This allows you to test and use the HTML pages on a local hard disk.

Htmlpp creates a file called errors.lst which contains any errors. This file is useful if you are building really large documentation kits, and messages scroll off the screen.

The -debug command-line option is also userful to see what htmlpp is doing with its passes:

htmlpp -debug filename
This leaves a number of .wrk files lying around; these contain the result of each pass, and allow you to debug your source code.

If you have problems, follow the instructions in the support section.

Copyright © 1996-99 iMatix Corporation.
Hosted by Made with Htmlpp. Powered by Xitami.
Updated: October 20, 1999