home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / wcst2url.zip / readme.1st < prev    next >
Text File  |  1998-01-01  |  10KB  |  212 lines
  1.  
  2.    January, 9th 1997
  3.    Warpcast New and Updated links => URL-create scripts
  4.    First public release
  5.  
  6.  
  7.    ___________________________________________________________________
  8.    0 - Foreword
  9.  
  10.    These are simple rexx scripts which build URL objects (and a HTML
  11.    index, if needed) out of Warpcast 'New and Updated' links messages.
  12.    These scripts are completely useless if you do not receive Warpcast
  13.    daily updates in your mailbox.
  14.  
  15.    To subscribe, unsubscribe, or for more information on WarpCast
  16.    itself, visit: http://www.warpcast.com/
  17.  
  18.    These scripts were written for personal use and then cleaned up and
  19.    released to the public domain: you can use them freely and you can
  20.    modify the source to suit your needs, at your own risk.
  21.  
  22.    ___________________________________________________________________
  23.    1 - CreateFolder, createURL and HTMLBuilder: hu?
  24.  
  25.    Since they answered a personal need, no real effort has been done
  26.    to make the script themselves 'user-friendly'.
  27.    No one-step installation routine is provided: you will actually
  28.    have to read all this (and the .cmd files) to understand how (and
  29.    if) these scripts may be useful for you.
  30.    Each script performs a specialized function:
  31.  
  32.    createFolder builds the folders to store the URLs in
  33.    createURL    reads your incoming mail to actually build URLs and
  34.                 data files
  35.    HTMLBuilder  creates a HTML 'digest' out of the data files
  36.  
  37.    deleteOBJs   will let you quickly destroy folders and shadows
  38.  
  39.    ___________________________________________________________________
  40.    2 - Quick and dirty installation and use notes
  41.  
  42.    Please check the scripts also, since they are quite commented.
  43.    A couple of the scripts use the FILEREXX extensions: we've included
  44.    the necessary DLL in the package for your convenience.
  45.    All credits go to its author, Jeff Glatt.
  46.  
  47.    The License part of the FILEREXX documentation reads:
  48.  
  49.    ---snip----
  50.  
  51.    'FILEREXX.DLL and this document are copyright 1995 by the author,
  52.    Jeff Glatt.  These items are freely distributable.
  53.    There are no pagan user fees, surreptitious financial charges, or
  54.    other devious capitalist trickery associated with the use of these
  55.    files.  There are also no warranties of any kind with this software.
  56.    If swallowed, induce vomiting immediately (by contemplating the
  57.    aesthetics of Windows).  You can do anything you like with this
  58.    archive, except reverse engineer or modify FILEREXX.DLL, nor can you
  59.    poke it with a sharp stick.  But you can print it out on flimsy
  60.    paper stock, wrap it around your privates, and go to work like that
  61.    as long as you don't blame the author for your actions.
  62.    You are not allowed to think nasty thoughts about the author, even
  63.    if the software somehow causes the erasure of your collection of
  64.    smutty picture files (...).
  65.  
  66.    I can be contacted at:
  67.  
  68.    6 Sycamore Drive East
  69.    New Hartford, NY 13413
  70.    (315) 735-5350
  71.  
  72.    Report bug fixes, or shut up.
  73.    Whose says that writing software licenses is no fun?'
  74.  
  75.    ---snip----
  76.  
  77.    Thanks Jeff for creating FileRexx and for the clear and exahustive
  78.    documentation (really).
  79.  
  80.    You are encouraged to download the complete package from Hobbes:
  81.  
  82.    at ftp-os2.nmsu.edu as filerx.zip
  83.  
  84.  
  85.    Now, let's take a look at what needs to be done to use the scripts.
  86.  
  87.        a - unzip the archive (you already did it, don't you?)
  88.        b - copy the filerexx.dll to your DLL path (or another known
  89.            path) and place the scripts in any directory you like the
  90.            best. The files which will be created at runtime, INIs and
  91.            the HTML digest, will have a home here.
  92.        c - run createFolder.cmd.
  93.            It will ask you on which drive (default: boot drive) you
  94.            want the two folders, NEW and UPDATED, to be created and
  95.            how do they have to be called (default: [Warpcast New
  96.            Links] and [Warpcast Updated links]). Then it will ask you
  97.            if you want an object for HTMLBuilder on your WPS.
  98.  
  99.        d - open your mailer.
  100.            You will need to tell it to use createURL.cmd as a rexx
  101.            program while fetching mail.
  102.  
  103.            PMMail: you will need to tell PMMail to use createURL.cmd as
  104.            a message receive exit under the account or utilities rexx
  105.            settings, depending on your version of the program.
  106.            Use the complete path.
  107.  
  108.            PostRoad Mailer: open 'file' => 'settings' and move to the
  109.            'User Exits' page of the notebook.
  110.            Use createURL.cmd as your receive message exit, and make it
  111.            run 'Minimized' (createURL has no video output).
  112.  
  113.            Save your settings and you are ready to go.
  114.  
  115.        e - download your mail.
  116.            If you chose to create URLs (see below), you will find that
  117.            new folders have been created inside of the NEW and UPDATED
  118.            ones (if NEW or UPDATED URLs have been broadcasted for that
  119.            day). These day folders (if created) will have a full-date
  120.            name, something like 'Thu, 18 Dec 1997'.
  121.            You will find the URLs inside, ready to be double-clicked
  122.            or dragged.
  123.  
  124.        f - run HTMLBuilder if you want the HTML digest.
  125.            Keep in mind that the daily database is rewritten each time
  126.            a message from Warpcast is received (e.g. once a day).
  127.            If you want your digest solid and useful, run HTMLBuilder
  128.            once a day too, or you won't be able to keep track of what
  129.            is NEW, UPDATED or NORMAL (see below).
  130.  
  131.    ___________________________________________________________________
  132.    4 - A closer look to the scripts
  133.  
  134.    There are four small rexx tools in the archive.
  135.  
  136.    createFolder.cmd => this script has to be run from a command prompt
  137.                        if you want folders and URLs from your Warpcast
  138.                        messages. You do not need to use it if you just
  139.                        want the URLs HTML-ized. If you prefer to have
  140.                        URL objects, this is the first script to run.
  141.                        Mind you: URLs won't be created if you do not
  142.                        run this script.
  143.  
  144.    createURL.cmd    => This is the script which does most of the work.
  145.                        We tested it with PMMail and PostRoad Mailer,
  146.                        but it should work with any rexx-enabled mailer:
  147.                        you only need check that it uses rexx CMDs upon
  148.                        receiving messages and that it passes the current
  149.                        file name as an argument.
  150.                        This script checks all of the incoming messages
  151.                        and creates the URLs when it finds a Warpcast
  152.                        message that contains them.
  153.                        It does not create URLs referenced in messages
  154.                        coming from sources other than Warpcast (although
  155.                        you could easily adapt the script).
  156.                        It also writes a data file used by HTMLBuilder in
  157.                        order to give you a HTML version of the New and
  158.                        Updated links.
  159.                        Note that you can set from inside the script if
  160.                        you want URLs to be created or not, and, if yes,
  161.                        if you prefer normal folders or URLFolders.
  162.                        The data file is always created at runtime and this
  163.                        feature cannot be disabled.
  164.  
  165.                        Note that createURL.cmd can be run if necessary
  166.                        from a command line, but you will need to pass
  167.                        it a Warpcast URL message file as an argument:
  168.                        using PMMail you will need to do something like
  169.  
  170.                        createURL EJ635X61.MSG
  171.  
  172.                        We heartily suggest you not to do so, if not for
  173.                        testing purposes ;) )
  174.  
  175.    HTMLBuilder.cmd  => This is the script which reads the datafile and
  176.                        creates the HTML code. It also writes the history
  177.                        archive, so you can keep track of which URL is
  178.                        NEW, UPDATED or NORMAL.
  179.                        This script needs to be run each time a new
  180.                        Warpcast URL message comes in, or you will lose
  181.                        the links of the day in your HTML digest (the data
  182.                        file gets rewritten each time by createURL.).
  183.                        This is somewhat a mixed-bag feature, since the
  184.                        HTML file tends to rapidly become quite huge.
  185.                        An URL is NEW if it has never been broadcasted by
  186.                        Warpcast, and is NORMAL if it has not been updated
  187.                        in the last 7 days.
  188.                        You can set the value for the UPDATED => NORMAL
  189.                        transition from inside HTMLBuilder.cmd.
  190.  
  191.    deleteOBJS.cmd   => This script deletes the folders created by
  192.                        createFolder.cmd with all of their contents.
  193.                        Mainly for testing purposes.
  194.                        Be warned that it won't ask you if you are sure
  195.                        of what you are doing. ;)
  196.  
  197.  
  198.    You will also find:
  199.  
  200.    jpg images       => Used by the HTML file
  201.  
  202.  
  203.  
  204.    Thanks for the interest.
  205.    Please report bugs and/or improvements.
  206.    We hope you find these small tools useful.
  207.  
  208.    G. Aprile
  209.    P.Rossi
  210.    A. Resmini   resmini@netsis.it
  211.  
  212.