home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / HEADV10B.ZIP / HEADLINE.DOC next >
Text File  |  1991-11-06  |  13KB  |  251 lines
  1. INTRODUCTION
  2.  
  3.    Hello and thank you for having a look at my latest project.
  4.  
  5.    Most if not all of you must currently use LIST or something similar to browse
  6. through the files provided in services.  HeadLiner has been designed to allow
  7. you to continue to use LIST (or whatever) for those files which HeadLiner
  8. doesn't understand while making it easier to read those which it does.  I was
  9. continuously annoyed by having to page through the entire file looking for
  10. interesting news items (and sports scores) and thus was born HeadLiner.  It
  11. started out as a standalone concept where I had to unpack the newsfeeds and
  12. then read them using HeadLiner.  You CAN still do it this way if you like but,
  13. it works much nicer when used with an OLMR that does the unpacking for you.
  14.  
  15.    Thank you Les Gyurky, for providing me with the hooks to get the integration
  16. started and for taking minutes out of the PMDBM development cycle to give
  17. HeadLiner a poke.  Thanks also to Eric Decker who picked up the gauntlet when
  18. PMDBM took all of Les' time for poking at HeadLiner.  I find it very useful and
  19. I hope you do to.
  20.  
  21. ===============================================================================
  22. ABOUT
  23.  
  24.                 HeadLiner  V1.03    (c) 1991   Kevin Morwood
  25.  
  26.   This program is intended to make it simpler to read the newsfeeds you want
  27.   to read while skipping over the news you don't.  The news file is scanned
  28.   for headlines and these are put into a bar menu.  Once this is complete you
  29.   have an index to each and every article in the file without having to page
  30.   through the entire file.
  31.  
  32.   For example if you want to only read the Sports in the CPI news then you
  33.   simply cursor down to the sports entries and press RETURN.
  34.  
  35.   Currently HeadLiner supports the following newsfeeds:
  36.      CPITODAY
  37.      MicroBytes
  38.      Newsbytes
  39.  
  40.   I'm currently working on some expansions that will make HeadLiner even more
  41.   useful.  Toronto Computes is the biggest of these that I'm attempting now
  42.   but it is proving to be a difficult file to parse.  Stay tuned for new
  43.   updates.
  44.  
  45. ===============================================================================
  46. LICENSE
  47.  
  48.    HeadLiner is the property of Kevin Morwood.  You may use it in either of
  49. it's operating formats (standalone or inside of your OLMR), for evaluation
  50. purposes, for a period of 10 days.  If you find it useful you are obliged to
  51. register it with me after this period.  The registration fee for this release
  52. is $5.  I reserve the right to alter this amount for future releases as
  53. HeadLiner grows in capability.
  54.  
  55.    This program is provided for your use, as is.  I accept no liability for the
  56. use of this program.  You are using it at your own risk.  There are no known
  57. bugs that would cause system failures but it has not been tested on every
  58. possible platform.
  59.  
  60.    I can be reached on CRS in conference 2, 5 or 43.  Please let me know if you
  61. have any ideas for enhancments.
  62.  
  63. ===============================================================================
  64. INSTALLATION
  65.  
  66.    HeadLiner is designed to fit seamlessly into your regular OLMR setup.  As
  67. a consequence of this it MAY also be run from the regular DOS command line.
  68. This has to do with it being a LIST 'replacement'.
  69.    I have tested it with Deluxe² and PMDBM.  If you are using a different mail
  70. reader then let me know how it handles services and I'll look at how to connect
  71. it properly.
  72.  
  73.    To install it into PMDBM or Deluxe² you simply change the LIST utility in
  74. the configuration from
  75.  
  76.       LIST  <────┬(or whatever)
  77.                  │
  78. to               │
  79.                  
  80.       HEADLINE LIST
  81.  
  82. When you attempt to read a file that Headliner can parse then it will execute
  83. and provide HeadLiner features.  If HeadLiner cannot understand the file it
  84. terminates and sends the file onward to LIST.  That's all there is to it.
  85. Place the executable HEADLINE.EXE in the same directory as your reader
  86. executables or at least somewhere in your path.
  87.  
  88. From DOS:
  89.    If you wish to use HeadLiner outside of your OLMR type HEADLINE for the
  90. usage text.  You will have to unzip the news files yourself if you want to use
  91. it in this way.
  92.  
  93. ===============================================================================
  94. USE
  95.  
  96.    HeadLiner has prompts on screen whereever appropriate to indicate which keys
  97. do what.
  98.  
  99. ===============================================================================
  100. BUGS
  101.  
  102.    Occasionally a newsfeed file comes down from the source that doesn't quite
  103. conform to the recognized standard.  The program, being a parser, gets really
  104. confused and may even crash.  I'm working on some error trapping capabilities
  105. that will prevent this event.  Please let me know when something happens that
  106. isn't expected.  I'm active on CRS in the conferences mentioned above.
  107.  
  108.    In the event you get a file that causes HeadLiner to crash let me know which
  109. file.  I get all of my test files from CRS so I've likely got the one you're
  110. using.  I have been running HeadLiner since October with no file parsing errors.
  111. When new newsfeeds come down the pipe I usually test them thoroughly.
  112.  
  113. ===============================================================================
  114. HISTORY
  115.  
  116.           Aug-Sept 1991  - Tinkered with the idea and wrote the basic system
  117.                          - Figured out what the hooks required to add this to
  118.                            PMDBM or Deluxe² were.  Thanks go to Les Gyurky for
  119.                            his assistance.
  120.           Sept 28 1991   - Adjusted the colour scheme so that it appears to be
  121.                            a part of PMDBM.  Les' colour scheme is good so I'll
  122.                            follow it.
  123.           Oct 17 1991    - Some cleanup.  I realized that I had compiled the
  124.                            program with -f87 which meant that other people
  125.                            might not be able to run it if they didn't have a
  126.                            f.p. processor.
  127.                          - Finished PMDBMizing the colour.
  128.                          - Added capability to read NEWSBYTES newsfeeds
  129.                  V0.95   - Added scrolling menus.  The NewsBytes feed made
  130.                            this necessary since the file is so large and has
  131.                            so many articles in it.
  132.                          - did some general cleanup to try to find the bug
  133.                            described below.
  134.           Oct 18 1991  (very early in the morning)
  135.                  V0.96   - I fixed the file passing bug.  The program will now
  136.                            either parse the file as one that it knows how to
  137.                            parse or it will send it straight through to the
  138.                            list utility specified as argument #1.
  139.                          - fixed an apparent bug of leaving files open.  DOS
  140.                            hates this kind of stuff.
  141.                  V0.97   - fixed the very annoying *.* bug.  They are now
  142.                            treated as unknown files and sent straight to
  143.                            listUtil which must know how to handle them.
  144.           Oct 19 1991    - Fixed path look-up problem.  Wouldn't execute DOS
  145.                  V0.98     shell functions, since they're not in the path.
  146.                            and it was a bit annoying to always have to put the
  147.                            list utility in the path.  SO it looks first at the
  148.                            current directory, then at the path and finally
  149.                            DOS shell commands.
  150.                          - Removed the use of the list utility for reading the
  151.                            articles from the recognized newsfeeds.  This does
  152.                            two things...1) It speeds HEADLINER up IMMENSELY
  153.                            because it doesn't have to create all of those
  154.                            temporary files.  2) Makes it necessary for me to
  155.                            write a function in the program to allow for viewing
  156.                            of the article.  V1.00 here we come!
  157.           Oct 20 1991  (at my favourite time of the day)
  158.                  V1.00   - temporarily disabled the NewsBytes capabilities
  159.                            due to some strange problems resulting from the
  160.                            switch to the new file organization.
  161.                          - wrote the first incantation of the article browser.
  162.           Oct 30 1991
  163.                  V1.01   - Fixed the extra blank line insertion problem.  The
  164.                            article constructor was reading exactly 80
  165.                            characters and if the newline was in the 80th
  166.                            position then it appeared in a successive, empty
  167.                            line.  Forcing the reader to read more than 80
  168.                            characters per line fixed the problem.
  169.                          - Finally re-installed the NewBytes reader.  The
  170.                            NB files only have a linefeed while the others have
  171.                            carriage return AND linefeeds imbedded in the file.
  172.                          - Added a function to remove the leading blank lines
  173.                            from the reader.
  174.                          - The title now stays at the top of the screen for the
  175.                            entire read.
  176.           Nov 02 1991
  177.                  V1.02   - Won't load files that don't occur on the current
  178.                            disk.  This is a real problem for those who use
  179.                            scratch disks other than their home disks (ie. RAM
  180.                            drives).  Thanks go to Eric Decker for pointing this
  181.                            one out to me.
  182.                          - this caused some real seamy problems with PMDBM so
  183.                            I re-wrote the way that I find and open files.  It
  184.                            works much better now.  I don't know if it caused
  185.                            a problem with Deluxe².
  186.           Nov 03 1991
  187.                  V1.03   - Reworked the keyboard interface.  It was too
  188.                            complicated if I wanted to add any new keys to the
  189.                            control structure.
  190.                          - Added +/- keys to the reader section.  You can now
  191.                            press +/- to see next/previous article in the news
  192.                            file.
  193.           Nov 05 1991
  194.                          - fixed a rather peculiar memory allocation error.
  195.                          - Changed a few more key's functions.  ESC will now
  196.                            advance in the menu by one when leaving the reader.
  197.  
  198.           Nov 06 1991
  199.                  V1.04   - BBSNews!
  200.                          - cleaned up the file determination.  New feeds should
  201.                            be easy now.
  202. ===============================================================================
  203. REGISTRATION INFO
  204.  
  205.    HeadLiner V1.03 License fee:  $5.00
  206.  
  207.    Please make cheque or money order payable to:
  208.  
  209.    Kevin Morwood
  210.  
  211.    and mail it to:  (please include a copy of the registration form found
  212.                      at the bottom of this file.)
  213.  
  214.    Kevin Morwood
  215.    514 Lansdowne Ave. Apt. 2,
  216.    Toronto, Ontario,
  217.    M6H 3Y3
  218.  
  219. ==============================================================================
  220. REGISTRATION FORM
  221.  
  222. Your Name: _______________________________   Phone: ____________________
  223.  
  224. Address:   _______________________________     Network / Conference /
  225.                                                Username where you can
  226.            _______________________________     be reached:
  227.  
  228.            _______________________________   ___________________________
  229.  
  230.            _______________________________   ___________________________
  231.  
  232.    Country:_______________________________
  233.  
  234.  
  235. Payment Method:  Cheque [ ]     Money Order [ ]
  236.                                                  TOTAL      QTY.
  237.  
  238. License fee            @ C$ 5.00 / $ 5.00US     $_______    ____
  239.  
  240.              SUBTOTAL                           $_______    ____
  241.  
  242.       Canadian residents add 7% GST             $_______    ____
  243.  
  244.       Ontario residents add  8% PST             $_______    ____
  245.  
  246.                   TOTAL                         $_______    ____
  247.  
  248.  
  249. -------------------------------------------------------------------------------
  250.  
  251.