home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 8 / CDASC08.ISO / VRAC / WWNEWS10.ZIP / WWNEWS.DOC < prev   
Text File  |  1993-09-03  |  13KB  |  290 lines
  1.                                   WWNews v.1.0
  2.                                   ────────────
  3.  
  4.                       -Shareware by Platypus Programming-
  5.                            Documentation and Program
  6.                       Copyright 1993 Platypus Programming
  7.                   WWIV is a registered trademark of Wayne Bell
  8.  
  9.     ─────────────────
  10.     BRIEF DESCRIPTION
  11.     ─────────────────
  12.  
  13.                 WWNews is really two programs in one.  Program one is a
  14.         simple but functional news editor that you can put up in
  15.         //CHAINEDIT so that you and your co-sysops can quickly and easily
  16.         edit the news at the keyboard or remotely.
  17.  
  18.                 Program two is a news display program that *only shows
  19.         the NEW news* to your callers!  If the news has not been
  20.         updated, they don't have to keep reading the same old news over
  21.         and over again.  When the news IS updated, however, the news
  22.         display program is already in your LOGON.BAT, ready to go.
  23.  
  24.     ────────────────────────────────────────
  25.     Initially Installing WWNews and NewsUtil
  26.     ────────────────────────────────────────
  27.  
  28.                 WWNews DOES need to be in your main BBS directory.  We
  29.         realize that by now your main BBS directory is probably getting
  30.         cramped, but...  If you really would like WWNews to be able to
  31.         run from a separate directory, let us know and we'll incorporate
  32.         that into a future release.  The two files in particular that
  33.         need to go in your main BBS dir are NEWSUTIL.EXE and WWNEWS.COM.
  34.  
  35.                 Once they are in place, run NEWSUTIL and answer the
  36.         questions.  Note that the first two items, sysop name and BBS
  37.         name, are read directly out of CONFIG.DAT.  The next question,
  38.         "Banner" means the banner that is displayed between messages.
  39.         For instance, if you entered "────" for your banner, your news
  40.         will look like this:
  41.  
  42.                                   WWNews v.1.0
  43.                             By Platypus Programming
  44.                       Registered to Calvin of Insomnia BBS
  45.  
  46.   ────────────────────────────────09-04-1993────────────────────────────────
  47.  
  48. This is a test news item
  49.  
  50.         If you instead entered "════" as your banner, it would look like
  51.         this:
  52.  
  53.                                   WWNews v.1.0
  54.                             By Platypus Programming
  55.                       Registered to Calvin of Insomnia BBS
  56.  
  57.   ════════════════════════════════09-04-1993════════════════════════════════
  58.  
  59. This is a test news item
  60.  
  61.         Note that the date appears in WWIV color 4, so it will be offset
  62.         from the rest of the banner.  Multiple news items look like this
  63.         (with "────" as the banner)
  64.  
  65.                                   WWNews v.1.0
  66.                             By Platypus Programming
  67.                       Registered to Calvin of Insomnia BBS
  68.  
  69.   ────────────────────────────────09-04-1993────────────────────────────────
  70.  
  71. This is the second test news item
  72.  
  73.   ────────────────────────────────09-04-1993────────────────────────────────
  74.  
  75. This is a test news item
  76.  
  77.                 The last question NEWSUTIL asks is the maximum number of
  78.         news items you ever want displayed.  WWNews will only display
  79.         the news when it is new, BUT it will keep however many old news
  80.         items you wish in there too.
  81.  
  82.                 If you make a big mistake while using NEWSUTIL, here is
  83.         the format of the file:
  84.  
  85.         Calvin          <-Line 2 -- Sysop's Handle
  86.         Insomnia BBS    <-Line 3 -- BBS Name
  87.         -=-=            <-Line 4 -- Header characters
  88.         4               <-Line 1 -- Maximum News Items
  89.  
  90.         ** Shareware Note!!! **
  91.         ───────────────────────
  92.  
  93.                 **NOTE!!**  The WWNEWS.CFG file is NOT read with the
  94.         Shareware version of the program.  In the Shareware version,
  95.         the banner defaults to "/*/*" and the max number of news items
  96.         is infinity.  The second you upgrade to the registered version,
  97.         the items in WWNEWS.CFG will take affect.
  98.  
  99.     ──────────────────────────────
  100.     How to use WWNews - The Editor
  101.     ──────────────────────────────
  102.  
  103.                 WWNews utitilizes WWIV's internal, proprietary color
  104.         scheme, so it is best run from within WWIV.  The best way to do
  105.         THAT is to put WWNews right in your main BBS directory, then go
  106.         into //CHAINEDIT and make these settings:
  107.  
  108.         A. Description  : WWNews Editor
  109.         B. Filename     : WWNews
  110.         C. SL           : <-----your choice, see below
  111.         D. AR           : <-----your choice, see below
  112.         E. ANSI         : Optional
  113.         F. DOS Interrupt: Used
  114.         G. 300 Baud     : Allowed
  115.         H. Shrink       : No
  116.         I. Disable pause: No
  117.         J. Local only   : <-----your choice, see below
  118.  
  119.         Access
  120.         ──────
  121.  
  122.                 One of the advantages of setting up the WWIVNews editor
  123.         in CHAINEDIT is that you have complete control over who can post
  124.         news.  That control is flexible through the settings marked
  125.         "your choice", above.  (Note:  if you don't have WWIV v.4.22 or
  126.         higher, you probably won't see choice J.  That's okay, though;
  127.         it won't affect WWNews' functionality)  If you don't want anyone
  128.         but you to be able to edit the news, set the SL at 255.  If you
  129.         have other users that have 255 access but you don't want THEM to
  130.         add new news items, set up an AR for option "D" and then only
  131.         give it to yourself, or set option "J" (local only) to yes!
  132.  
  133.                 Anyone who has access to WWNews via //CHAINEDIT will be
  134.         able to post a message that will be displayed to all callers.
  135.         Let THAT be your guide as to how you set up WWNews access.
  136.  
  137.         Using The Editor Now That You Have Access
  138.         ─────────────────────────────────────────
  139.  
  140.                 The WWNews editor is a simple but functional one, very
  141.         similar to WWIV's internal editor.  You may edit each line, but
  142.         once you've pressed enter, that line is there for good.  You may
  143.         find it necessary, if you've totally messed it up, to go and
  144.         edit WWNEWS.TXT with a text editor like QEdit if you run into
  145.         problems.
  146.  
  147.                 NOTE!  There *seems* to be a bug that we *absolutely*
  148.         cannot duplicate with the editor part of WWNews.  Basically,
  149.         you'll type away on your news file, and then it'll have garbage
  150.         in it when you're done.  We CAN'T get it to happen, though!  If
  151.         you get garbage in your news file, please let us know.  We
  152.         REALLY want to get the editor up to speed with the display part
  153.         of the program, but can't duplicate this error!  If you can
  154.         actually e-mail us the resulting WWNEWS.TXT or something, that'd
  155.         be great!
  156.  
  157.                 In both senses, the editor function of WWNews is
  158.         optional. If you have access problems, or just don't like it,
  159.         use a text editor to edit/create your news file.  IF YOU DO
  160.         THIS, HOWEVER: be SURE to delete the file called WWNEWS.USR.
  161.         ALSO, the "max number of news items" part of WWNEWS.CFG is
  162.         totally irrelevant, since that happens during the editing of new
  163.         news.  You will control the news by the way you lay out the text
  164.         file.
  165.  
  166.     ─────────────────────────────────────
  167.     How to use WWNews - The Logon Display
  168.     ─────────────────────────────────────
  169.  
  170.                 To use the news display part of WWNews, you need to set
  171.         it up to be called during your logon event. It should be called
  172.         like this...
  173.  
  174.         WWNEWS -d
  175.  
  176.                 This puts the program into "Display Mode" and displays
  177.         either the news or a message telling your users that the news
  178.         has not been updated since their last call.  This can be done in
  179.         one of two ways.  Both ways involve running INIT.EXE.
  180.  
  181.                 If you DON'T HAVE a logon event, go into INIT.EXE, under
  182.         the heading "External programs (zip, terminal, etc)".  Move to
  183.         the line that says "Logon event" and enter "WWNEWS -d".
  184.  
  185.                 If you DO have a logon event set up in the fashion we
  186.         just described, you're going to have to create a batch file.
  187.         Go into INIT as described above and change whatever you
  188.         currently have as your "Logon event" and change it to
  189.         "LOGON.BAT".  Now load up your favorite text editor and create
  190.         LOGON.BAT in your main BBS directory.  Inside LOGON.BAT put
  191.         whatever USED to be in the "Logon event" part of INIT.EXE and on
  192.         a second line put "WWNEWS -d".
  193.  
  194.                 If you already have a logon batch file, put the line
  195.  
  196.         "WWNEWS -d" somewhere in it.  If you have trouble with this or
  197.         any other aspect of WWNews, please get ahold of us through the
  198.         various ways we provide support (described in the "Platypus
  199.         Programming Support Biscuits" section of this doc!)
  200.  
  201.         ────────────
  202.         Registration
  203.         ────────────
  204.  
  205.                 WWNews costs only $2.  Please support the shareware
  206.         concept by evaluating the program for 30 days.  If you like it
  207.         and plan to continue using it, fill out the REGISTER.TXT form
  208.         and send in your check.  If you don't like it or don't plan to
  209.         continue using it, please discontinue its use.  Either way,
  210.         pass the shareware package (see README.1st) to friends and feel
  211.         free to post it for downloading on your BBS.
  212.  
  213.                 Upon registering WWNews, you will recieve a registered
  214.         version that will utilize the WWNEWS.CFG file you created with
  215.         NEWSUTIL.  That will show your users you've registered, display
  216.         the banner of your choice, and configure the maximum news items.
  217.  
  218.                 Again, please read the REGISTER.TXT file for details on
  219.         the program registration, and how to save some dough on other
  220.         Platypus Programs.
  221.  
  222.         ────────────────────
  223.         WARRANTY INFORMATION
  224.         ────────────────────
  225.  
  226.                 THERE IS NO WARRANTY!  Platypus Programming disclaims
  227.         all warranties, either expressed or implied, including but not
  228.         limited to implied warranties of merchantability and fitness
  229.         for a particular purpose.  Should the program prove to be
  230.         defective, the user assumes the responsibility of paying the
  231.         entire cost of all necessary repairs, servicing, or any other
  232.         consequential damages.  In NO EVENT will Platypus Programming
  233.         be liable for any damages in any form (including without
  234.         limitation damages for loss of business profits, business
  235.         interruption, loss of business information, etc.) arising from
  236.         the use of or inability to use this product.
  237.  
  238.                 Use of this software product for any period of time
  239.         constitutes assumed acceptance of this agreement and subjects
  240.         you to its contents.
  241.  
  242.                 Sorry to sound so rough, but them's tough biscuits.
  243.  
  244.                 Platypus Programming DOES, however, welcome comments on
  245.         all its programs.  See the next section for details!
  246.  
  247.         ─────────────────────────────────────
  248.         Platypus Programming Support Biscuits
  249.         ─────────────────────────────────────
  250.  
  251.         Platypus Programming offers support through WWIVNet, IceNet,
  252.         WWIVLink, ASSnet, and *many* other networks.  Look in your
  253.         SUBS.LST file for sub-type PLATPS!  Support is available
  254.         through that sub and that is probably the easiest way to
  255.         reach the authors.  The "home system" of Platypus Programming is
  256.         WWIVLink @18262, WWIVNet @8265, so feel free to send mail to #1
  257.         on any of those networks.  You can reach us via Internet at
  258.         michael.lerch@hal9k.com
  259.  
  260.         Insomnia BBS is located at (812)466-4222 and has a GSA account
  261.         (logon as GUESTSYS, password "wwiv", phone number "0000").  You
  262.         can leave mail to the #1 account ("Calvin") or download the
  263.         latest Platypus Programs there.
  264.  
  265.         Feel free to write us via Snail Mail, as well.  Our address is:
  266.   
  267.                              Platypus Programming
  268.                                 P.O. Box 6095
  269.                          Terre Haute, IN  47802-6095
  270.  
  271.         We want to reiterate that we are willing to help you with
  272.         technical questions AND take your suggestions!  If you think
  273.         this program would be great "If it had..." then PLEASE let us
  274.         know!!
  275.  
  276.                              █                   █
  277.                              █                   █
  278.                              █                   █
  279.                              █                   █
  280.                              █                   █
  281.                              █                   █
  282.                              █   ■           ■   █
  283.                              █                   █
  284.                               █                 █
  285.                                █████████████████
  286.  
  287.  
  288.                               Platypus Programming
  289.                          The difference is in the bill
  290.