simple example readme
----------------------

For pmpp version 0.01
$Id: README,v 1.3 1999/02/21 05:12:10 kev Exp kev $

This is a simple example of how to use pmpp.  It's trivial in its real
usefulness, but should be good in giving you a feel for how pmpp works.

First, check out the files simple.pmpp (the config file), and simple.tmpl
(the template file).

* simple.pmpp:

  This file is heavily commented, so hopefully you'll be able to work out
  what's going on.  The directives at the top tell pmpp things like where
  the template file is, and what the header and footers are.  Notice,
  however, the 'bullet = *' directive.  This is a directive that is used in
  the template, and has the value of '*' for all articles that are
  processed.

  Further on, there are the definitions for the articles themselves, four
  in total.  Each one defines the directive 'name', with a different value
  each time.

* simple.tmpl:

  Looking at this file, we can see that each article will take up just one
  line, which consists of whatever value 'bullet' has, followed by a tab,
  followed by whatever value 'name' has.

To find out exactly how all these pieces fit together, run the pmpp over
the config file, with the command:

pmpp simple.pmpp

This will create a file called simple.out (as specified in simple.pmpp).
Looking at this file, we can see that it has the header defined in
simple.pmpp, followed by each of the articles after having the replacement
operators in the template file processed, followed by the footer as defined
in simple.pmpp.


