home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / WILDCAT / WCINF10.ZIP / WCINFORM.DOC < prev    next >
Text File  |  1994-02-10  |  14KB  |  280 lines
  1. ╔════════════════════════════════════════════════════════════════════════════╗
  2. ║                            WCInform  Version 1.0                           ║
  3. ║                        (c)Copyright 1994, CompuCraft                       ║
  4. ║                             All Rights Reserved.                           ║
  5. ╚════════════════════════════════════════════════════════════════════════════╝
  6.  
  7. DISCLAIMER
  8. ----------
  9.  
  10.      This product contains no warranty, either expressed or implied.  Use
  11.      this software at your own risk.  CompuCraft will not be held responsible
  12.      for damages related to the use of this product.  This product has been
  13.      tested on many systems with no difficulties, but it is not possible to
  14.      test it on every type of system or configuration.
  15.  
  16.  
  17. Table Of Contents
  18. -----------------
  19.  
  20.                 1.0  Welcome To WCInform!
  21.                 1.1  Installation
  22.                 1.2  Running WCInform
  23.                 1.3  Using WCInform
  24.                 1.4  Registration
  25.                 1.5  Future Versions
  26.                 1.6  Additional Comments
  27.  
  28.  
  29. 1.0  Welcome To WCInform!
  30. -------------------------
  31.  
  32.      WCInform is a full-featured, easy to use Wildcat! BBS newsletter
  33.      generator featuring:
  34.  
  35.         *  Mouse-able Windowed Interface
  36.         *  Multiple Formats (Color & Monochrome .BBS, ANSI, RIP)
  37.         *  Shell To Your Favorite Editor
  38.         *  Overwrite, Append To Top, & Append To Bottom Options
  39.         *  Wildcat! @ code support
  40.  
  41.  
  42. 1.1  Installation
  43. -----------------
  44.  
  45.      WCInform may be placed in any directory that you wish, however, all
  46.      of the associated files must be in the same directory as WCINFORM.EXE.
  47.      I recommend creating a WCINFORM subdirectory and unzipping the contents
  48.      of the zip file into this directory.  If you are installing WCInform
  49.      from a floppy, use the standard DOS copy to copy the files from the
  50.      floppy into the specific directory.  For example:
  51.  
  52.      copy a:\*.* c:\wcinform
  53.  
  54.      where a: is the location of the floppy disk, and c:\wcinform is the
  55.      location of the directory where you would like to install WCInform.
  56.      WCInform will use approximately 178k of hard disk space.
  57.  
  58.  
  59. 1.2  Running WCInform
  60. ---------------------
  61.  
  62.      Before executing WCInform for the first time, you must edit the
  63.      WCINFORM.INI file with an ASCII editor and specify the appropriate
  64.      paths.  Below is an example of the WCINFORM.INI file:
  65.  
  66.              c:\wc30\wcinform\
  67.              c:\wc30\disp\newsltr.new
  68.              c:\wc30\disp\
  69.              c:\dos\edit.com
  70.  
  71.      The first line contains the path where you installed WCInform.  This
  72.      is where WCInform will look for it's files and save any changes to the
  73.      WCINFORM.INI file.  The second line contains the path of the ASCII
  74.      text file that will be converted to a Wildcat! newsletter.  You may
  75.      also specify the name of the text file on this line, as in the above
  76.      example.  The third line contains the output path of the newsletter
  77.      file.  It is not necessary to specify the filename, as this will be
  78.      determined during program execution.  The final line contains the
  79.      path and filename of your favorite ASCII text editor.  This editor will
  80.      be used during program execution to edit your text file if necessary.
  81.  
  82.      One important note - ensure that the paths in lines two and four of the
  83.      WCINFORM.INI file end with a backslash (\), otherwise WCInform will
  84.      generate an error requesting you to check the paths.
  85.  
  86.      WCInform must be executed from within the directory containing it's
  87.      files.  To execute WCInform, change to the directory where it is located
  88.      and type WCINFORM at the DOS prompt.  You may also create a batch file
  89.      to automatically execute WCInform.  Below is an one example of a batch
  90.      file to execute WCInform:
  91.  
  92.              @echo off
  93.              c:
  94.              cd \wc30\wcinform\
  95.              wcinform
  96.              cd \
  97.              @echo on
  98.  
  99.      Remember to replace lines two and three above with the specific
  100.      location where you installed WCInform.
  101.  
  102.  
  103. 1.3  Using WCInform
  104. -------------------
  105.  
  106.      Mouse
  107.  
  108.      After executing WCInform, you will be presented with the main menu.
  109.      If you are using a mouse, you may click on the appropriate button to
  110.      execute an option.  You may also select options from the File and Edit
  111.      pulldown menus by clicking them and clicking again on the desired menu
  112.      item.  All clicking is done with the left mouse button, the right button
  113.      is not used at this time.  The WCInform interface was designed to
  114.      operate like any standard windowed program, so learning it should be
  115.      fast and easy.
  116.  
  117.      Keyboard
  118.  
  119.      The TAB key will cycle through all of the available options on the
  120.      screen.  To execute an option, TAB to the appropriate option and hit
  121.      ENTER.  On certain selection options, such as the Newsletter Type, use
  122.      the arrow keys to select the option, then TAB to the next option.  The
  123.      Create RIP checkbox option may be toggled by tabbing to the checkbox and
  124.      hitting the SPACEBAR to toggle the check mark [X].  To access the File
  125.      and Edit pulldown menus, hit the ALT key to highlight the menu, then
  126.      hit ENTER to access the pulldown menus.  Make your selection using
  127.      the arrow keys, then hit ENTER to execute the option.
  128.      Although using the keyboard is not quite as easy as using the mouse,
  129.      it can be mastered with a little practice.
  130.  
  131.      In the following example, I will assume that you are using a mouse.
  132.      If you are using the keyboard, use the appropriate keystrokes to get
  133.      the desired result.  To create a newsletter in WCInform, use the
  134.      following instructions:
  135.  
  136.         1.  Click on the EDIT button located within the Paths section to
  137.             edit the current input and output paths.  If these paths are
  138.             already correct, you may skip this step.  In the Enter Paths
  139.             box, first enter the input path and filename of the ASCII
  140.             text file that you wish to use to create the newsletter.
  141.             This may be a filename that already exists, or a filename that
  142.             will be created when you invoke the editor.  If you make a
  143.             mistake, use the BACKSPACE key to correct the error.  When the
  144.             input path is correct, click on the output path box and enter
  145.             the output path.  You do NOT need to specify the filename, it
  146.             will be determined by the specific type of newsletter that
  147.             you will select later.  When the output path is correct click
  148.             on the OK button to close the dialog box.  If WCInform cannot
  149.             locate your specified paths, you will be prompted to reenter
  150.             them.  The input and output paths in the Paths section on the
  151.             main menu should now reflect the paths that you just entered.
  152.             If they do not, repeat this step.
  153.  
  154.         2.  If you would like to edit the input file, click on the Invoke
  155.             Editor button.  WCInform will then shell to the editor
  156.             specified in the WCINFORM.INI file.  If the input file doesn't
  157.             exist, it will be created.  If it does exist, it will be loaded
  158.             into the editor.  Edit the file using the instructions for your
  159.             specified editor.  Remember to save the file using your editor's
  160.             save command when you are finished.  After you have completed
  161.             the editing, exit the editor.  You will return to the main menu
  162.             of WCInform.
  163.  
  164.         3.  If you would like to create a new newsletter, select the
  165.             Create New/Overwrite Existing option in the Action section.
  166.  
  167.             WARNING:  If you select the Overwrite option, your current
  168.             newsletter will be deleted.
  169.  
  170.             If you would like to append the input file to the current
  171.             newsletter, you may do so in one of two different ways.  If
  172.             you would like the text to appear at the beginning of the current
  173.             newsletter, select the Append To Top option.  If you would
  174.             like the text to appear at the end of the current newsletter,
  175.             select the Append To Bottom option.
  176.  
  177.         4.  Select the type of newsletter that you wish to create.  WCInform
  178.             supports color Wildcat! BBS (newsltr.bbs), monochrome Wildcat!
  179.             BBS (newsltr.bbs), and color ANSI (newsltr.scr).  The color
  180.             BBS and ANSI formats support Wildcat! @ color codes.  The
  181.             monochrome BBS is basically a straight ASCII text file without
  182.             color codes.  WCInform will also create a Remote Imaging Protocol
  183.             (RIP) screen in addition to the above mentioned types.  To create
  184.             a newsltr.rip screen, make sure that an X appears in the Create
  185.             RIP checkbox.  You may toggle this option by clicking it, or
  186.             by tabbing to it and pressing the SPACEBAR.  Please note that
  187.             the RIP newsletter will be created in addition to the other
  188.             selected type.
  189.  
  190.         5.  Review the options that you have selected.  When you are
  191.             satisfied and are ready to create the newsletter, click the
  192.             Create Newsletter button.  WCInform will create the newsletter
  193.             file(s) in the specified output directory.
  194.  
  195.         6.  When you are finished, click on the EXIT button to leave
  196.             WCInform.
  197.  
  198.      There are a couple of points to remember when creating your
  199.      newsletter.  First, the input text file must be 80 columns or less.
  200.      Any text that extends beyond this point will be truncated.  Second,
  201.      the RIP newsletter will read 28 lines, pause, and clear the screen
  202.      for the next page.  You may need to adjust your input file to avoid
  203.      pages with only one or two lines.
  204.  
  205.  
  206. 1.4  Registration
  207. -----------------
  208.  
  209.      WCInform is not crippled in any way.  I believe that if a program is
  210.      good enough, it doesn't require crippling to force people to register.
  211.      The only difference between the unregistered and registered versions
  212.      is in the banner of the newsletter.  When you register, the banner will
  213.      contain "Registered To:  <Your Name>", instead of "UnRegistered
  214.      Evaluation Copy".  Registration of WCInform V1.0 is $5.00 US.  To
  215.      register, print the REGISTER.TXT file, and follow the instructions on
  216.      the form.  Registration is accomplished by use of a key file.  This file
  217.      will be created the day I receive payment.  You may acquire the key in
  218.      one of two ways:
  219.  
  220.             1.  You can download the key from C.C.S. OnLine! in
  221.                 Montgomery, Alabama.  To reduce long-distance charges,
  222.                 specify the log-in name and password that you want to
  223.                 use to log in on the registration form, and I will set
  224.                 up an account for you before you call.  Your key will
  225.                 be attached to a private message to you.  You may use
  226.                 the quick login, "*UserName Password" if you wish.
  227.  
  228.             2.  I will mail you the key file on a floppy disk.  You
  229.                 may specify the size that you require.  I will charge
  230.                 an additional $1.00 US for shipping/handling charges.
  231.                 The key will be mailed the following day that I receive
  232.                 your registration fee.
  233.  
  234.      Registering WCInform will get you the following:
  235.  
  236.             1.  Your newsletter will say "Registered To: <YourName>".
  237.             2.  All minor releases and bug fixes free of charge.
  238.             3.  Discount on any other shareware products that CompuCraft
  239.                 releases.
  240.  
  241.      Your registration provides feedback to me, telling me that my
  242.      effort was worthwhile and beneficial.  I hope that this program
  243.      will make your job as a SysOp a little easier.  Even if you decide
  244.      not to register, I would appreciate hearing your comments about the
  245.      program.
  246.  
  247.  
  248. 1.5  Future Versions
  249. --------------------
  250.  
  251.      The next version of WCInform is already in the planning stage.  I feel
  252.      that RIP graphics will soon be the standard for the BBS, so WCInform
  253.      will concentrate on improving RIP output.  Multiple RIP output screens,
  254.      perhaps even a modular system incorporating RIP modules, will be the
  255.      main focus in the next version.
  256.  
  257.  
  258. 1.6  Additional Comments
  259. ------------------------
  260.  
  261.      I tried to make WCInform as easy and intuitive as possible.  I hope
  262.      that you like WCInform and will support me in my first attempt at
  263.      a shareware product.  If you find any bugs in the program or have
  264.      any questions or suggestions for a future version, please leave me
  265.      feedback in the WC 3rd Party conference.  I may also be reached at
  266.      C.C.S. OnLine! in Montgomery, Alabama.  The number is (205) 281-9114 or
  267.      (205) 281-1331.  Both numbers support 1200 - 14.4 bps.  Leave E-Mail
  268.      to Steve Smith on the BBS, or just drop a comment to the SysOp, Kim
  269.      VanLandingham, and he will ensure that I get the message.
  270.  
  271.      Special Thanks to Kim VanLandingham for beta testing and distribution.
  272.  
  273.      Thank you for trying WCInform.......
  274.  
  275.      WCInform was written in Visual Basic for MS-DOS.
  276.      MS-DOS and Visual Basic for MS-DOS are registered trademarks
  277.      of Microsoft Corp.
  278.      Wildcat! BBS is Copyright (c) 1993, Mustang Software, Inc.
  279.      RIP is Copyright (c) 1992-1993, TeleGrafix Corp.
  280.