home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / EVENTS / WW4QV30.ARJ / WW4QUOTE.DOC < prev    next >
Text File  |  1993-12-29  |  9KB  |  206 lines
  1.  
  2.                                 WW4QUOTE v3.0
  3.                     (c) 1992  by Datagen Software Designs
  4.                      written & programmed by John Dailey
  5.  
  6.                            WARRANTY and DISCLAIMER
  7.                            ───────────────────────
  8.  
  9.          This  software  is  provided  AS IS without any expressed or
  10.          implied warranties whatsoever. No warranty of fitness for  a
  11.          particular  purpose  is offered. The author of this software
  12.          cannot be held responsible for DIRECT, INDIRECT  INCIDENTAL,
  13.          CONSEQUENTIAL,  or  ANY OTHER damages due to your ability or
  14.          inability to use this software, even if the author has  been
  15.          advised of the possibility of such damages. The user assumes
  16.               full responsibility for the use of this software.
  17.  
  18. Files Included In This Package:
  19. ───────────────────────────────
  20.  
  21.           WW4QUOTE.DOC ─── WWIV Quote v3.0 Documentation File
  22.           WW4QUOTE.HIS ─── WWIV Quote v3.0 History File
  23.           WW4QUOTE.EXE ─── WWIV Quote v3.0 Executable File
  24.           WW4QUOTE.DAT ─── A Sample .DATa File
  25.           UPGRADE .EXE ─── Program To Upgrade Your .DATa File
  26.  
  27. What Is It?:
  28. ────────────
  29.  
  30.      WW4QUOTE is a simple program that allows random on-liners on any WWIV
  31. BBS, and in plain ole' regular DOS.  It is simple to setup, and very simple
  32. to use, and may be set up to run almost anywhere within your BBS - as a
  33. chain, or in the logon.bat file for example.
  34.  
  35. Upgrading From v1.0 Or v2.0:
  36. ────────────────────────────
  37.  
  38.      If you are upgrading from a previous version, and wish to use the same
  39. .DAT file with the new version of WW4Quote, then you need to place the
  40. UPGRADE.EXE program in the same directory as your WW4QUOTE.DAT file and type
  41. UPGRADE at the DOS prompt.  When asked if you wish to add the '|' symbol to
  42. existing lines, enter Y for yes.  Note that you need only to run this program
  43. one time.
  44.  
  45.      Be sure to read the rest of this document for information on what has
  46. been added to this version.
  47.  
  48. Installation:
  49. ─────────────
  50.  
  51.      First, before running the program, if you do not wish to use the already
  52. enclosed .DATa file, you must create one with any text editor that saves in
  53. simple ASCII format.  You may place the WW4Quote files in your main BBS
  54. directory, or in a directory by themselves.  Read on command line parameters
  55. for more information.
  56.  
  57.      The .DAT File:
  58.  
  59.      The WW4QUOTE.DAT file contains the quotes that are going to be displayed
  60.      by the program.  It's usage is simple, and it may be edited or created
  61.      with an editor that saves in plain ASCII format.  Each quote begins on
  62.      a new line, and ends with a pipe symbol (|), thus allowing you to have
  63.      quotes of more than one line.  There is no limit as to how long or short
  64.      your quote can be, just be sure to place a '|' symbol after the end of
  65.      each quote.  Previous versions of WW4Quote only allowed you to have
  66.      quotes of one line each - this is somewhat of an improvement!
  67.  
  68.      WW4Quote automatically picks a color to display each quote in when it is
  69.      ran, but you may override this by placing WWIV color codes in the
  70.      comment lines themselves.  The ASCII value for the heart symbol is 3. 
  71.      Here is an example of a few quotes from a .DAT file:
  72.  
  73.           This BBS Rules!|
  74.           WW4Quote is the best quoter program
  75.           in the whole world|
  76.           I love this thing|
  77.  
  78.      Notice that the first quote (This BBS Rules!) is only one line, while
  79.      the second quote consists of two lines because a pipe symbol is not
  80.      placed at the end of the first line.
  81.  
  82.      The Command Line Parameters:
  83.  
  84.           WW4QUOTE [<path>] [/CENTER] [/NOCOLOR] [/NOAD]
  85.  
  86.      The first (<path>) is simply where the location of WW4QUOTE.DAT is. 
  87.      This allows you to place all of the WW4Quote files in their own
  88.      directory,  instead of your main BBS directory, which probably already
  89.      has hundreds of files in it.  A backslash at the end of the path is
  90.      optional, and the whole <path> command line parameter is optional also. 
  91.      If you do leave it off, the program will simply look in the current
  92.      directory for the .DAT file.  Please note that this parameter, if
  93.      included, must be first.  All other parameters may go in any order.
  94.  
  95.      The second (/CENTER) tells WW4Quote to center all output to the screen. 
  96.      Just something that may look a little better with your BBS.  If a quote
  97.      from your .DAT file consists of more than one line, each line will be
  98.      centered with the screen.
  99.  
  100.      Next comes /NOCOLOR, which tells WW4Quote not to output WWIV Color
  101.      codes.  This is handy if you are running to program from DOS in your
  102.      AUTOEXEC.BAT file or something.  WWIV color codes are simply a heart
  103.      ASCII character (#3) followed by a number.
  104.  
  105.      Finally, the option that everyone has been waiting for... an option to
  106.      shut off the Datagen Software Designs plug that is displayed before the
  107.      quote.  Maybe it was a mistake to put this in the program (I'm sure
  108.      everyone who uses it will use this), but I'd rather have more people use
  109.      the program and the option, than no one use the program because they
  110.      couldn't shut off the plug.  Enjoy!
  111.  
  112.      Here are a few examples of command lines:
  113.  
  114.           \WWIV\QUOTE\WW4QUOTE C:\WWIV\QUOTE /NOAD /CENTER
  115.           WW4QUOTE /NOCOLOR /NOAD
  116.           WW4QUOTE C:\ /NOCOLOR
  117.  
  118.  
  119. Using WW4QUote In Your LOGON.BAT:
  120.  
  121.      To use the program in your logon batch file, all you need to do is call
  122. the program with it's command line parameters!  WWIV and the program will
  123. take care of the rest.  Here's an example of a LOGON.BAT file calling
  124. WW4Quote:
  125.  
  126.           @ECHO OFF
  127.           \WWIV\QUOTE\WW4QUOTE C:\WWIV\QUOTE /NOAD /CENTER
  128.  
  129.      You may want to add two lines to this to spruce up the display a little
  130. bit.  For example, right before calling WWIV Quote, use the ECHO command to
  131. print out a solid line, like so:
  132.  
  133.           ECHO ───────────────────────────────────────────────────────
  134.  
  135.      Then, call WWIV Quote, and finally, ECHO another sold line like above to
  136. get a "boxed-in" effect for your quote.  You could also draw an ANSI display
  137. file for the top and bottom instead of using the echo command and use the DOS
  138. TYPE command to display them.  The ideas are endless!
  139.  
  140.  
  141. Using WW4Quote As A On-Line Chain:
  142.  
  143.      To use the program in your chains area, simply set it up with these
  144. parameters:
  145.  
  146.      Description : WW4Quote v3.0
  147.      Filename    : path + WW4QUOTE.EXE + <command line parameters>`
  148.      DOS Calls   : MUST be used!  (Otherwise, users won't see anything!)
  149.      Shrink      : Optional.  I recommend not using it.
  150.  
  151.      And you're all set!
  152.  
  153. Registration:
  154. ─────────────
  155.  
  156.      No registration fee is required for this program, but you may make
  157. small donations to Datagen Software Designs to further our cause, and help
  158. in the production of more quality software.  You may distribute this program
  159. freely as long as all files are kept together in archived form and not
  160. modified in anyway.
  161.  
  162. Datagen Software Designs Support BBS Information:
  163. ─────────────────────────────────────────────────
  164.  
  165.      For information on becoming a respectable Datagen Software Designs
  166. support Bulletin Board System, simply mail the below address, with the
  167. following information:  (Note - you must include all information.)
  168.  
  169.           BBS Name,
  170.           BBS Phone Number,
  171.           BBS Type and Version,
  172.           BBS Net/Node (if applicable)
  173.           Disk Size (5 1/4" or 3 1/2")
  174.           Sysop Name,
  175.           Sysop Real Name,
  176.           Sysop Address,
  177.           Sysop Age,
  178.           How Long Your BBS Has Been Up,
  179.           And finally, your reason for wanting to become a support BBS.
  180.  
  181.      Sysop's requesting to become a support board will be notified as soon as
  182. possible on their request, and if accepted, will be eligible to receive
  183. Datagen's Support BBS Newsletter, technical support on all Datagen products,
  184. and MUCH more!  Send requests to:
  185.  
  186.           Support BBS Information
  187.           Datagen Software Designs
  188.           1732 Wind Drift Rd.
  189.           Orlando, FL  32809
  190.  
  191. Authors Notes And Credits:
  192. ──────────────────────────
  193.  
  194.      Questions, comments, complaints, or to receive a complete listing and
  195. description of all Datagen products, mail John Dailey at the below address,
  196. through Compuserve at 73124, 2612, through Internet at 73124.2612@cis.com,
  197. through Prodigy at ID# MKHH05B, or through WWIVNet at 23@4709 (Enigma).
  198.  
  199.      Thank you for your support!
  200.  
  201.           WWIV Quote v3.0
  202.           c/o John Dailey
  203.           1732 Wind Drift Rd.
  204.           Orlando, FL  32809
  205.  
  206.