home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / EVENTS / WWNEWS11.ZIP / WWNEWS.DOC < prev    next >
Text File  |  1993-12-05  |  15KB  |  338 lines
  1.                                   WWNews v.1.1
  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 a news display program that only shows the NEW
  14.         news to your callers.  If the news has not been updated, they
  15.         won't keep reading the same old news over and over again.  When
  16.         you update the news through WWNews, though, the records are
  17.         reset and users will see your new news item plus, in the
  18.         registered version, a configurable number of old news items.
  19.  
  20.                 News updating takes place through a batch file that
  21.         calls your favorite DOS or WWIV editor.  If you choose to use a
  22.         WWIV editor such as WWIVEdit or FEdit, you can edit the news
  23.         remotely.
  24.  
  25.                 WWNews v.1.1 creates a separate, human-readable text
  26.         file and lets you configure one account to always read the news
  27.         (great for GSA accounts).
  28.  
  29.                 WWNews is an external program and requires NO MODDING of
  30.         ANY KIND.  It is a fine way to customize an unmodded WWIV BBS or
  31.         further customize a modded one.
  32.  
  33.         ────────────────────────────────────────
  34.         Initially Installing WWNews and NewsUtil
  35.         ────────────────────────────────────────
  36.  
  37.                 WWNews can be installed in any directory on your hard
  38.         drive and can even be placed in a directory with other files.
  39.         Once you have unzipped the entire WWNews archive, run
  40.         NEWSUTIL.EXE and answer the questions.  Some of the questions
  41.         you will be asked apply only to the registered version of the
  42.         program, but you must answer them in the shareware version as
  43.         well.  When you register, you'll be all set up!
  44.  
  45.                 The questions asked by NewsUtil are all pretty
  46.         straightforward, but here is some explanation:
  47.  
  48.         Banner (Registered Version)
  49.         ───────────────────────────
  50.  
  51.                 The banner is displayed between each news item.  If you
  52.         entered "────" for your banner, your news will look like this:
  53.  
  54.                                   WWNews v.1.1
  55.                             By Platypus Programming
  56.                       Registered to Calvin of Insomnia BBS
  57.  
  58.   ────────────────────────────────09-04-1993────────────────────────────────
  59.  
  60. This is a test news item
  61.  
  62.                 If you instead entered "════" as your banner, it would
  63.         look like this:
  64.  
  65.                                   WWNews v.1.1
  66.                             By Platypus Programming
  67.                       Registered to Calvin of Insomnia BBS
  68.  
  69.   ════════════════════════════════09-04-1993════════════════════════════════
  70.  
  71. This is a test news item
  72.  
  73.                 Note that the date appears in WWIV color 4, so it will
  74.         be offset from the rest of the banner.  Multiple news items look
  75.         like this (with "────" as the banner)
  76.  
  77.                                   WWNews v.1.1
  78.                             By Platypus Programming
  79.                       Registered to Calvin of Insomnia BBS
  80.  
  81.   ────────────────────────────────09-04-1993────────────────────────────────
  82.  
  83. This is the second test news item
  84.  
  85.   ────────────────────────────────09-04-1993────────────────────────────────
  86.  
  87. This is a test news item
  88.  
  89.                 In the shareware version, the banner is "/*/*".
  90.  
  91.         Max Number of News Items (Registered Version)
  92.         ─────────────────────────────────────────────
  93.  
  94.                 WWNews will retain a certain number of old news items,
  95.         and here is where you set that number.  This number applies both
  96.         to the main display and the GFiles news item (discussed next).
  97.         WWNews will automatically trim the file each time news is added.
  98.         In the unregistered version, there is no maximum number of news
  99.         items; none will be deleted.
  100.  
  101.         GFiles News Item
  102.         ────────────────
  103.  
  104.                 WWNews v.1.1 makes two separate copies of the news.  One
  105.         is in the special WWNews format; one is a normal, WWIV-colored
  106.         text file. If you select "yes" for GFiles News Item in NewsUtil,
  107.         you will be asked to specify a path and filename.  The
  108.         Human-readable news file will be placed there.  This is a handy
  109.         feature for your callers in that if they weren't paying
  110.         attention during their logon or merely want to read the news
  111.         again, you'll have it available to them in a GFiles directory.
  112.         Please note that when you specify a complete pathname (i.e.
  113.         \WWIV\GFILES\MISC\NEWS.TXT), all of the directories must already
  114.         exist, and that you'll have to manually add the file to your
  115.         GFiles area.
  116.  
  117.  
  118.         GSA Account
  119.         ───────────
  120.  
  121.                 This is a feature intended for systems that have a Guest
  122.         Sysop Account.  If you answer "yes" to this question, you will
  123.         be prompted for a user number.  Whatever user you select will
  124.         ALWAYS see the news.  In other words, while your other callers
  125.         may see the "news not updated since your last call" message,
  126.         this user will always see the full news file.
  127.  
  128.                 Again, this is handy for systems with a GSA...the
  129.         visiting sysop will always be up to date with the latest
  130.         happenings on your system.
  131.  
  132.         The .CFG File Format
  133.         ────────────────────
  134.  
  135.                 Just in case you need it, here is the file format for
  136.         the WWNEWS.CFG text file:
  137.  
  138.     Calvin                       <-Line 1--Sysop's Handle
  139.     Insomnia BBS                 <-Line 2--BBS Name
  140.     -=-=                         <-Line 3--Header characters
  141.     4                            <-Line 4--Maximum News Items
  142.     \WWIV\GFILES\MISC\NEWS.TXT   <-Line 5--Path to GFiles news (or NONE)
  143.     53                           <-Line 6--Exempt user (or 0)
  144.     \WWIV\CHAIN.TXT              <-Line 7--Path to CHAIN.TXT
  145.  
  146.                 You're now done with NewsUtil, and are halfway done with
  147.         installation.
  148.  
  149.         Making WWNews your Logon Event
  150.         ──────────────────────────────
  151.  
  152.                 Now that you've run NewsUtil, you need to install WWNews
  153.         into your logon event.  If you don't have a logon event, run
  154.         INIT.EXE and specify the full path to WWNews with the command
  155.         line parameter "-d".  For example:
  156.  
  157.         \WWIV\UTILS\WWNEWS -d
  158.  
  159.                 If you already have a logon event, you need to make a
  160.         batch file that is called from INIT and include the full path to
  161.         WWNews with the -d just as shown above.  Your LOGON.BAT might
  162.         look like this:
  163.  
  164.         @ECHO OFF
  165.         \WWIV\UTILS\WWNEWS -d
  166.         BIRTHDAY /L
  167.  
  168.         Installing the WWNews Editor into //CHAINEDIT
  169.         ─────────────────────────────────────────────
  170.  
  171.                 You are done installing WWNews as a display program.
  172.         Now you have to install the editing portion of WWNews.
  173.  
  174.                 WWNews uses two batch files called WWNSLOCL.BAT and
  175.         WWNSREMO.BAT to call your favorite editors for news editing.
  176.         When you enter your editor, you'll be editing a temporary file
  177.         and can feel free to use WWIV color codes, line drawing
  178.         characters, etc.  When you are finished, simply exit your
  179.         editor, saving the file you just worked on.  WWNews will
  180.         concatenate the new news with your existing news and update the
  181.         user data file.  (Note...if you decide you don't want to add any
  182.         news, exit your editor without saving the temp file)
  183.  
  184.                 The reason there are two batch files is so that WWNews
  185.         can call separate editors for local and remote use.  If your
  186.         editor is FEdit, WWIVEdit, or a similar WWIV full-screen editor,
  187.         they can be used for both.  If you do not have one of those, you
  188.         will have to use a DOS- based editor such as the fine QEdit
  189.         program or DOS' own EDIT.COM and will not be able to edit news
  190.         remotely (even though WWIV is trapping DOS interrupts, most
  191.         editors like QEdit use direct screen writes). Either way, sample
  192.         batch files are included in this archive and there are more
  193.         details there. Customize them to contain your preferred editor's
  194.         full pathname with a "%1" in place of the filename.
  195.  
  196.                 If you want to use WWIVEdit, you're going to need to use
  197.         the .DEF files included in this package.  By default, WWIVEdit
  198.         is set up to run under WWIV and expects WWIV to generate certain
  199.         files (like quoting text).  Since WWNews doesn't generate those
  200.         files, you need to make an alternate setup for WWIVEdit when
  201.         used with WWNews.  WWNSLOCL.DEF and WWNSREMO.DEF are included in
  202.         this package.  To use them, put them in your WWIVEdit CONFIG\
  203.         directory, then run "WWIVEdit -f".
  204.  
  205.         ***NOTE!!!  WWNSLOCL.BAT and WWREMO.BAT MUST go in your main BBS
  206.         directory.
  207.  
  208.                 Once you have customized the sample batch files, you
  209.         need to add WWNews to //CHAINEDIT.  Use this as your guide:
  210.  
  211.         A. Description  : WWNews Editor - add new news
  212.         B. Filename     : \full_pathname\WWNews
  213.         C. SL           : <-----your choice, see below
  214.         D. AR           : <-----your choice, see below
  215.         E. ANSI         : Optional
  216.         F. DOS Interrupt: Used
  217.         G. 300 Baud     : Allowed
  218.         H. Shrink       : No
  219.         I. Disable pause: No
  220.         J. Local only   : <-----your choice, see below
  221.  
  222.         Access
  223.         ──────
  224.  
  225.                 One of the advantages of setting up the WWIVNews editor
  226.         in CHAINEDIT is that you have complete control over who can post
  227.         news.  That control is flexible through the settings marked
  228.         "your choice", above.  (Note:  if you don't have WWIV v.4.22 or
  229.         higher, you probably won't see choice J.  That's okay, though;
  230.         it won't affect WWNews' functionality)  If you don't want anyone
  231.         but you to be able to edit the news, set the SL at 255.  If you
  232.         have other users that have 255 access but you don't want THEM to
  233.         add new news items, set up an AR for option "D" and then only
  234.         give it to yourself, or set option "J" (local only) to yes!
  235.  
  236.                 Anyone who has access to WWNews via //CHAINEDIT will be
  237.         able to post a message that will be displayed to all callers.
  238.         Let THAT be your guide as to how you set up WWNews access.
  239.  
  240.         ────────────
  241.         Registration
  242.         ────────────
  243.  
  244.                 WWNews costs only $2.  Please support the shareware
  245.         concept by evaluating the program for 30 days.  If you like it
  246.         and plan to continue using it, fill out the REGISTER.TXT form
  247.         and send in your check.  If you don't like it or don't plan to
  248.         continue using it, please discontinue its use.  Either way, pass
  249.         the shareware package (see README.1st) to friends and feel free
  250.         to post it for downloading on your BBS.
  251.  
  252.                 Upon registering WWNews, you will recieve a registered
  253.         version that will utilize the entire WWNEWS.CFG file you created
  254.         with NEWSUTIL.  That will show your users you've registered,
  255.         display the banner of your choice, and allow you to configure
  256.         the maximum news items.
  257.  
  258.                 Again, please read the REGISTER.TXT file for details on
  259.         the program registration, and how to save some dough on other
  260.         Platypus Programs.
  261.  
  262.         ────────────────────
  263.         WARRANTY INFORMATION
  264.         ────────────────────
  265.  
  266.                 THERE IS NO WARRANTY!  Platypus Programming disclaims
  267.         all warranties, either expressed or implied, including but not
  268.         limited to implied warranties of merchantability and fitness for
  269.         a particular purpose.  Should the program prove to be defective,
  270.         the user assumes the responsibility of paying the entire cost of
  271.         all necessary repairs, servicing, or any other consequential
  272.         damages.  In NO EVENT will Platypus Programming be liable for
  273.         any damages in any form (including without limitation damages
  274.         for loss of business profits, business interruption, loss of
  275.  
  276.         business information, etc.) arising from the use of or inability
  277.         to use this product.
  278.  
  279.                 Use of this software product for any period of time
  280.         constitutes assumed acceptance of this agreement and subjects
  281.         you to its contents.
  282.  
  283.                 Sorry to sound so rough, but them's tough biscuits.
  284.  
  285.                 Platypus Programming DOES, however, welcome comments on
  286.         all its programs.  See the next section for details!
  287.  
  288.         ─────────────────────────────────────
  289.         Platypus Programming Support Biscuits
  290.         ─────────────────────────────────────
  291.  
  292.         Platypus Programming offers support through WWIVNet, IceNet,
  293.         WWIVLink, ASSnet, and *many* other networks.  Look in your
  294.         SUBS.LST file for sub-type PLATPS!  Support is available through
  295.         that sub and that is probably the easiest way to reach the
  296.         authors.  The "home system" of Platypus Programming is WWIVLink
  297.         @18262, WWIVNet @8265, @TERRANet @8262, so feel free to send
  298.         mail to #1 on any of those networks.  You can reach us via
  299.         Internet at michael.lerch@hal9k.com
  300.  
  301.         Insomnia BBS is located at (812)466-4222 and has a GSA account
  302.         (logon as GUESTSYS, password "wwiv", phone number "0000").  You
  303.         can leave mail to the #1 account ("Calvin") or download the
  304.         latest Platypus Programs there.
  305.  
  306.         Feel free to write us via Snail Mail, as well.  Our address is:
  307.   
  308.                              Platypus Programming
  309.                                 P.O. Box 6095
  310.                          Terre Haute, IN  47802-6095
  311.  
  312.         We want to reiterate that we are willing to help you with
  313.         technical questions AND take your suggestions!  If you think
  314.         this program would be great "If it had..." then PLEASE let us
  315.         know!!  This release includes several features/improvements over
  316.         v.1.0 and it's because of the input we recieved from you!
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.                              █                   █
  325.                              █                   █
  326.                              █                   █
  327.                              █                   █
  328.                              █                   █
  329.                              █                   █
  330.                              █   ■           ■   █
  331.                              █                   █
  332.                               █                 █
  333.                                █████████████████
  334.  
  335.  
  336.                               Platypus Programming
  337.                          The difference is in the bill
  338.