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