home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / ppwizard.zip / readme.txt < prev    next >
Text File  |  1999-11-20  |  7KB  |  160 lines
  1.         ╔═══════════════════════════════════════════════════╗
  2.         ║                   Dennis Bareis                   ║
  3.         ║                    db0@anz.com                    ║
  4.         ║                                                   ║
  5.         ║ http://www.labyrinth.net.au/~dbareis/ppwizard.htm ║
  6.         ╚═══════════════════════════════════════════════════╝
  7.  
  8.  
  9. PPWIZARD is a powerful but simple to use free preprocessor that can
  10. greatly simplify the creation of HTML.
  11.  
  12. At its simplest you can create definitions such as:
  13.  
  14.    #define MyEmailAddress       db0@anz.com
  15.    #define HttpAnExternalSite   http://www.laybrinth.net.au
  16.  
  17.  
  18. These are defined once (normally in a separate file called a header
  19. file) and then referred to throughout your pages.  If you need to change
  20. the address its a simple change to one location and then a rebuild.
  21. PPWIZARD can be told to automatically only rebuild those files that need
  22. to be (it tracks what input files make each output file).
  23.  
  24. Example of using one of the definitions defined above:
  25.  
  26.    My email address is <$MyEmailAddress>, please ...
  27.  
  28.  
  29. PPWIZARD is powerful (more details below) but just being able to use the
  30. "#define" command to create simple definitions as show above and including
  31. the header files in your pages with "#include" would be more than enough
  32. justification for its use and many people won't use the more advanced
  33. features (at least not initially).  I am more than happy to help anyone
  34. who can provide a detailed description of any problem and what they have
  35. tried to do to resolve it.
  36.  
  37. PPWIZARD can import data from databases.  It can be extended through a
  38. simple (but very powerful) processing language called rexx.  The following
  39. is an example of me creating a reasonably complex macro and using it
  40. twice to include some images (the height and width of these are determined
  41. by the macro - it would generally be in a separate header):
  42.  
  43.  
  44.  
  45.  
  46. ****************************************************************************
  47. ***************************** START EXAMPLE ********************************
  48. ****************************************************************************
  49.  ;--- Photo macro will either use passed size or work out correct size for you ---
  50.   #define Photo                                                            \
  51.           ;--- Where is file on local file system? ----------------------  \
  52.           #evaluate+  LocalFileName    ^"..\graphics\{$Image}"^            \
  53.                                                                            \
  54.           ;--- The output depends on this image -------------------------  \
  55.           #DependsOn  INPUT            "<$LocalFileName>"                  \
  56.                                                                            \
  57.           ;--- Start a new table row ------------------------------------  \
  58.           <TR>                                                             \
  59.                                                                            \
  60.           ;--- If user did not pass the size then work it out -----------  \
  61.           #if "{$Size=''}" <> ""                                           \
  62.               #define+   TmpSize {$Size}       ;;User told us size         \
  63.           #elseif                                                          \
  64.               #evaluate+ TmpSize ^GetImageHeightWidth("<$LocalFileName>")^ \
  65.           #endif                                                           \
  66.                                                                            \
  67.           ;--- Generate some code ---------------------------------------  \
  68.           <TD ALIGN=CENTER>                                                \
  69.           <IMG SRC="graphics/clear1x1.gif" WIDTH=1 HEIGHT=1 VSPACE=20>     \
  70.           {$Title}<BR><BR>                                                 \
  71.           <IMG SRC="graphics/{$Image}" BORDER=0 <$TmpSize> ALT="{$Title}"> \
  72.           <IMG SRC="graphics/clear1x1.gif" WIDTH=1 HEIGHT=1 VSPACE=20>     \
  73.           </TR>
  74.  
  75.   ;--- Start the table --------------------------------------------------------
  76.   <BR><CENTER><TABLE COLS=1 BORDER=10 CELLSPACING=10>
  77.      <TR>
  78.      <TH ALIGN=CENTER>Pictures
  79.      </TR>
  80.  
  81.      ;--- Use the macro to generate photo cells -------------------------------
  82.      <$Photo Image="dbareis.jpg"  Title="Me hard at work">
  83.      <$Photo Image="kpaw_ff.jpg"  Title="Kangaroo Paws along Front Fence">
  84.  
  85.   ;--- Complete table ---------------------------------------------------------
  86.   </TABLE></CENTER>
  87. ****************************************************************************
  88. ***************************** END   EXAMPLE ********************************
  89. ****************************************************************************
  90.  
  91.  
  92. To execute PPWIZARD under operating systems other than OS/2 you need to
  93. use the free "regina" rexx interpreter.
  94.  
  95.  
  96.  
  97. Documentation
  98. ~~~~~~~~~~~~~
  99. PPWIZARD has extensive documentation which used to be bundled with
  100. it, however my users have suggested that I split it out to reduce the
  101. download time. Please go to the PPWIZARD homepage (address below) to
  102. get the documentation in either HTML or INF format.
  103.  
  104.  
  105. To INSTALL
  106. ~~~~~~~~~~
  107.  
  108. To install I recommend that you simply create a directory and unzip the
  109. contents of the zip file into this directory.  You would normally
  110. also wish to add the name of the new directory to the path.
  111.  
  112. To test the install on OS/2, execute the command:
  113.  
  114.    ppwizard tryme.it
  115.  
  116. To test the install on other operating systems (PPWIZARD executes
  117. under REGINA), execute the command:
  118.  
  119.    (1) rexx   ppwizard.cmd tryme.it     OR
  120.    (2) regina ppwizard.cmd tryme.it
  121.  
  122.  
  123. This should create "tryme.htm", view it in your browser if you wish.  The
  124. command we used left everything as default which is why the output has
  125. the extension ".htm", you can change this to ".html" or tell ppwizard
  126. to place the output into a specific directory if you wish.
  127.  
  128.  
  129. There are many ppwizard options that allow you to customise its operation
  130. for your needs, for example leading and trailing spaces are removed by
  131. default (for faster download).  There are situations where you do not
  132. wish to occur, you can turn the space removal and all other ppwizard
  133. magic on and off as required.
  134.  
  135.  
  136.  
  137. PPWIZARD HOME PAGE
  138. ~~~~~~~~~~~~~~~~~~
  139. PPWIZARD has its own page which contains some more examples of what you
  140. can do:
  141.  
  142.       "http://www.labyrinth.net.au/~dbareis/ppwizard.htm".
  143.  
  144. If you find this program useful please consider linking to the above
  145. page, you can use the supplied "madewppw.jpg" (120x35) image for this
  146. purpose if you wish.
  147.  
  148.  
  149.  
  150. DISTRIBUTION
  151. ~~~~~~~~~~~~
  152. This archive may be freely distributed (but not sold) in full.  Files
  153. must not be removed from the distibuted zip files and the zip file
  154. comments must not be removed.
  155.  
  156.  
  157. The contents of the archive are (C)opyright Dennis Bareis 1997. All
  158. rights reserved.
  159.  
  160.