home *** CD-ROM | disk | FTP | other *** search
/ Chip 2002 March / Chip_2002-03_cd1.bin / sharewar / Slunec / app / ppww32.exe / readme.txt < prev    next >
Text File  |  2001-08-24  |  9KB  |  202 lines
  1.         ╔═══════════════════════════════════════════════════╗
  2.         ║                   Dennis Bareis                   ║
  3.         ║             dbareis@labyrinth.net.au              ║
  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. It works in all windows operating systems as well as in OS/2, UNIX,
  12. DOS and BeOS.
  13.  
  14. At its simplest you can create definitions such as:
  15.  
  16.    #define MyEmailAddress       dbareis@labyrinth.net.au
  17.    #define HttpAnExternalSite   http://www.laybrinth.net.au
  18.  
  19.  
  20. These are defined once (normally in a seperate file called a header
  21. file which probably also contains your standard headers and footers)
  22. and then referred to throughout your pages.  If you need to change
  23. the address its a simple change to one location and then a rebuild.
  24. PPWIZARD can be told to automatically only rebuild those files that need
  25. to be (it tracks what input files make each output file).
  26.  
  27. Example of using one of the definitions defined above:
  28.  
  29.    My email address is <$MyEmailAddress>, please ...
  30.  
  31.  
  32. PPWIZARD is powerful (more details below) but just being able to use the
  33. "#define" command to create simple definitions as show above and including
  34. the header files in your pages with "#include" would be more than enough
  35. justification for its use and many people won't use the more advanced
  36. features (at least not initially).  I am more than happy to help anyone
  37. who can provide a detailed description of any problem and what they have
  38. tried to do to resolve it.
  39.  
  40. PPWIZARD can import data from databases.  It can be extended through a
  41. simple (but very powerful) processing language called rexx.  The following
  42. is an example of me creating a reasonably complex macro and using it
  43. twice to include some images (the height and width of these are determined
  44. by the macro - it would generally be in a seperate header):
  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 INSTALL
  94. ~~~~~~~~~~
  95. There are two Windows downloads "PPWW32.ZIP" and "PPWW32.EXE", the self
  96. extracting EXE is easier to use but both have the same contents,
  97. as follows:
  98.  
  99.      * PPWIZARD itself
  100.  
  101.      * The free Regina interpreter
  102.  
  103.      * PPWIZARD's documentation in html format (main page is "ppwizard.htm")
  104.        Documentation is also online at:
  105.              "http://www.labyrinth.net.au/~dbareis/ppwizard/ppwizard.htm".
  106.  
  107.        Your drive must support long filenames for the documentation!
  108.  
  109. I recommend that ppwizard be installed into the "C:\Program Files\ppwizard"
  110. directory. These are the steps:
  111.  
  112. 1. Win 95 users make sure that you have "msvcrt.dll" in your
  113.    "c:\windows\system" directory etc.
  114.    If you DON'T then I have a copy on the ppwizard download page as
  115.    a self extracting EXE.
  116.    Install this before doing anything else.
  117.  
  118. 2. If you have the EXE simply execute it to unzip the contents and
  119.    run the installation.
  120.  
  121.    If you have the ZIP you need to unzip it with WinZip or similar tools
  122.    and then run "SETUP.EXE" to start the setup.
  123.  
  124. 3. Follow bouncing ball...
  125.    PPWIZARD creates a sample html page which it displays as part of the
  126.    setup.
  127.  
  128. 4. Right click options should have been installed on ppwizard extensions
  129.    such as ".IT", ".IH",  ".X", ".XH" and ".PPW".
  130.  
  131. 5. Shutdown and reboot before continuing.
  132.  
  133. 6. You could try right clicking on "tryme.it" and selecting the build
  134.    option that should recreate the HTML and display ppwizard output in
  135.    your editor.
  136.  
  137. As part of the installation a small fairly simplistic html page is
  138. created. This tests the installation as well as giving you a simple example
  139. to play with.  To rebuild the html if you change source you can choose the
  140. "build" option when you right click on the file in explorer or type the
  141. following from a command prompt:
  142.  
  143.    PPWIZARD.REX TRYME.IT
  144.  
  145. If the above command did not work (you are probably using Windows 95/98/ME)
  146. then use:
  147.  
  148.    REGINA.EXE PPWIZARD.REX TRYME.IT
  149.  
  150. This should create "TRYME.HTM", view it in your browser if you wish.
  151. The command we used left everything as default which is why the output has
  152. the extension ".htm", you can change this to ".html" or tell ppwizard
  153. to place the output into a specific directory if you wish (as the explorer
  154. method does).
  155.  
  156. There are many ppwizard options that allow you to customise its operation
  157. for your needs, for example leading and trailing spaces are removed by
  158. default (for faster download).  There are situations where you do not
  159. wish to occur, you can turn the space removal and all other ppwizard
  160. magic on and off as required.
  161.  
  162. Note that ppwizard is enhanced quite frequently so you may wish to
  163. check my site out for a new version!
  164.  
  165.  
  166. To UPDATE
  167. ~~~~~~~~~
  168. Simply install the new version.
  169. If you wish you could uninstall the older version first.
  170.  
  171. If you don't mind older documentation (or other features) you could simply
  172. extract "ppwizard.rex" from my "ppwall.zip" download as it is a fraction
  173. of the size of the windows download.
  174.  
  175. I do not wish to support this so if you have any problems please uninstall,
  176. download the latest windows download and reinstall.
  177.  
  178.  
  179. PPWIZARD HOME PAGE
  180. ~~~~~~~~~~~~~~~~~~
  181. PPWIZARD has its own page which contains some more examples of what you
  182. can do:
  183.  
  184.       "http://www.labyrinth.net.au/~dbareis/ppwizard.htm".
  185.  
  186. If you find this program useful please consider linking to the above
  187. page, you can use the supplied "madewppw.jpg" (120x35) image for this
  188. purpose if you wish.
  189.  
  190.  
  191. Note that there are many PPWIZARD add-ons available from the PPWIZARD
  192. download page, these cover link and documention generation as well as
  193. thumnail and MP3 related stuff.
  194.  
  195.  
  196. COST (NONE) / LICENCE / DISTRIBUTION ETC
  197. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  198. Please see "PPWIZARD.LIC" for more information.
  199. This information is displayed during the install.
  200.  
  201.  
  202.