home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / EVENTS / UROV10.EXE / URONLINE.DOC < prev    next >
Text File  |  1994-04-14  |  18KB  |  384 lines
  1.                               UR On-Line v1.0
  2.                      (c) 1994 Datagen Software Designs
  3.                     written & programmed by John Dailey
  4.  
  5.                            WARRANTY and DISCLAIMER
  6.                            ───────────────────────
  7.  
  8.          This  software  is  provided  AS IS without any expressed or
  9.          implied warranties whatsoever. No warranty of fitness for  a
  10.          particular  purpose  is offered. The author of this software
  11.          cannot be held responsible for DIRECT, INDIRECT  INCIDENTAL,
  12.          CONSEQUENTIAL,  or  ANY OTHER damages due to your ability or
  13.          inability to use this software, even if the author has  been
  14.          advised of the possibility of such damages. The user assumes
  15.               full responsibility for the use of this software.
  16.  
  17. Files Included In This Package:
  18. ───────────────────────────────
  19.  
  20.           URONLINE.DOC ─── UR On-Line v1.0 Documentation File
  21.           URONLINE.REG ─── UR On-Line v1.0 Registration Form
  22.           URONLINE.EXE ─── UR On-Line v1.0 Executable File
  23.           URCONFIG.EXE ─── UR On-Line v1.0 Configuration Program
  24.           DBCONFIG.EXE ─── UR On-Line v1.0 Database Configuration Program
  25.           SAMPLE  .DBS ─── UR On-Line v1.0 Sample Database Structure
  26.  
  27.           [6 Files]
  28.  
  29. What Is It?:
  30. ────────────
  31.  
  32.      UR On-Line is a simple, yet powerful on-line user registry program for
  33. use with WWIV BBS Software!  It allows the sysop to configure exactly what
  34. kind of questions to ask the user, letting them limit the number of
  35. characters allowed for input, the type of input (such as numbers or letters),
  36. and the maximum number of lines.
  37.  
  38.      The main program itself features color configuration, browsing through
  39. the database, or listing each user.  You can also do searches by a user's
  40. name, or by a match in one of the answers that they have entered.
  41.  
  42.      A sample database structure is included that will probably fit most
  43. sysop's needs, but feel free to modify it for your BBS.
  44.  
  45. Installation:
  46. ─────────────
  47.  
  48.      Installation of UR On-Line is as simple as any other Datagen Software
  49. Designs on-line package.  First, you should place all of UR On-Line's files
  50. in their own directory off of your main BBS directory.  For example purposes,
  51. we'll assume that this directory is C:\WWIV\URONLINE.
  52.  
  53.      Next, you will need to create a batch file in your main BBS directory
  54. (in this case, C:\WWIV) so that it contains the following lines:
  55.  
  56.           CD\WWIV\URONLINE
  57.           URONLINE %1 %2
  58.           CD\WWIV
  59.  
  60.      The "%1" and "%2" command line parameters will be replaced by the
  61. calling program with information pertinent to UR On-Line's successful
  62. operation.
  63.  
  64.      The first command line parameter specifies the name and location of your
  65. database structure file, and the second specifies the name and location of
  66. the BBS door information file.  ie.  CHAIN.TXT or DORINFO.DEF
  67.  
  68.      After creating the batch file, you will need to set up your BBS to call
  69. that batch file.  This procedure will vary from software to software.  For
  70. the most part it is essentially the same.  Make your BBS run the batch file,
  71. followed by two parameters.  For example, if you were going to use the
  72. SAMPLE.DBS database structure included with this archive, and you were
  73. running WWIV BBS Software, your call to the batch file would be like so:
  74.  
  75.           URONLINE.BAT SAMPLE CHAIN.TXT
  76.  
  77.      In your chains area of WWIV, the following setup would be made:
  78.  
  79.      Description:   UR On-Line User Registry v1.0
  80.      Filename:      URONLINE.BAT SAMPLE %1 
  81.                          (the %1 will be replaced with CHAIN.TXT's name
  82.                           and location by WWIV)
  83.      DOS Calls:     NOT used
  84.      ANSI Required: Yes
  85.  
  86.      That's all there is too it.  If you've created the batch file, are
  87. calling that batch file with the two important parameters after it, and have
  88. created your database structure as explained below in this documentation, the
  89. door should run just fine!
  90.  
  91. Database Basics:
  92. ────────────────
  93.  
  94.      Before going into detail about setting the database structure for UR On-
  95. Line, we should describe and explain some of the basics of database use. 
  96. Although simple, some sysops new to this method of record-keeping may not
  97. fully understand, and this section will hopefully remedy that problem.
  98.  
  99.      First, thing of a database as an address book.  This is by far the
  100. easiest way to understand.  In an address book, you have a collection of the
  101. same information, over and over again.  Each one of these entries in the
  102. address book is called a record.  In each record (entry in the address book),
  103. there are so many different lines of data, ie.  Name, Address, City, State,
  104. etc.  These lines of information are called fields.  So, each record contains
  105. a specific number of fields.
  106.  
  107.      John Doe                 (Field #1)     ┐
  108.      123 Anywhere St.         (Field #2)     ├── Record #1
  109.      Somewhere, USA  12345    (Field #3)     ┘
  110.  
  111.      Mary Doe                 (Field #1)     ┐
  112.      987 Anywhere Place.      (Field #2)     ├── Record #2
  113.      Somesmalltown, USA  725  (Field #3)     ┘
  114.  
  115.      Simple!  This list of records can be as big, or small as you want.  In
  116. database structure designing, each field of a record is designated by a
  117. variable, or a word that the program uses to associate with each field.  In
  118. the above example, the first field's variable could be "NAME," while the
  119. second could be "STREETADDRESS," and the third "CITYSTATEZIP."  Some database
  120. programs may actually use numbers to identify each field.
  121.  
  122.      Now that you know something about database structures, read on to find
  123. out how to configure your own database of questions.
  124.  
  125. Running The Database Configuration Program:
  126. ───────────────────────────────────────────
  127.  
  128.      The purpose of using the database configuration program, is so that you,
  129. the sysop, can define a database of questions to ask your users in their
  130. registry.  Each question is considered a record, and all you have to do is
  131. define each record.  UR On-Line already has a pre-defined template for each
  132. field in the record.  For example, each question will need the following
  133. information defined by you:
  134.  
  135.      The question to be asked                     (Field #1)     ┐
  136.      A short description of the question          (Field #2)     │
  137.      The maximum characters allowed for input     (Field #3)     ├── Record
  138.      The type of input allowed                    (Field #4)     │
  139.      The maximum number of lines allowed          (Field #5)     ┘
  140.  
  141.      The question to be asked will be displayed to the user when they are
  142. entering their registry for the first time, or when editing their entry.  The
  143. short description is used when browsing through users information, or listing
  144. the users.  For example, if the question was "What Is Your Age?," the short
  145. description might be "Age," or "User's Age."
  146.  
  147.      Before we explain the maximum characters allowed, let's take a look at
  148. the type of input allowed.  This field may be defined as one of the
  149. following:  Character, Integer, or Boolean.  A character definition means
  150. that the user will be allowed to type in all alpha-numeric characters (A-Z,
  151. 0 - 9, punctuation, etc.).  Integer means that the user will be allowed to
  152. enter a valid number, and the Boolean definition means that a true or false,
  153. yes or no answer my be entered by the user.
  154.  
  155.      Now, the length of a character entry may be defined as anywhere between
  156. 1 and 74 characters.  An integer value may be defined between 1 and 4 numbers
  157. in length (0 - 9999), and a boolean value may have a definition of only one
  158. character (T, F, Y, N).  UR On-Line will automatically set the maximum
  159. characters allowed if you select the boolean value.
  160.  
  161.      The maximum number of lines allowed is only valid for character type
  162. entries in the database.  This value can range from 1 - 10.  We suggest that
  163. if you use a value great than 1, that you also set the maximum character
  164. length to the maximum of 74.
  165.  
  166.      To load the database structure utility, type DBCONFIG at the DOS prompt
  167. while in the same directory that you will running UR On-Line from.  The
  168. program will load, and display a screen with a menu bar.  Pressing the left
  169. and right arrow keys will allow you to choose each menu option at the top of
  170. the screen.  Press <ENTER> to execute the currently high-lighted option.  A
  171. the bottom of the screen is a display line that will give information on the
  172. currently highlighted option, or explain a question that UR On-Line's
  173. database structure editor is asking you.
  174.  
  175.      Edit - Picking this option will allow you to modify the currently
  176.      displayed record.
  177.  
  178.      Insert - Will insert a new question (record) before the currently
  179.      displayed record.
  180.  
  181.      Delete - Will delete the current question (record) from the database.
  182.  
  183.      New - Choose this option to start a new database structure.  A small
  184.      editing screen will be displayed, and you will be able to edit each
  185.      record from there.
  186.  
  187.      Save - Saves the current database structure to a filename that you
  188.      specify.  UR On-Line automatically appends the extension "DBS" to the
  189.      filename, signifying that the file is a database structure file.
  190.  
  191.      Load - Loads a previously saved database structure into the program.
  192.      Again, the extension "DBS" is automatically added to the filename.
  193.  
  194.      Quit - Quits the program and returns to the operating system.  If any
  195.      changes were made to the structure, it will prompt you to save your
  196.      changes first.
  197.  
  198.      Use the up and down arrow keys to move through the database records.  Up
  199. moves up one record, and down moves down one record.  Moving past the last
  200. record will display a blank entry, allowing you to edit and add a new record
  201. to the database.  You may also press the home and end keys to move to the
  202. beginning and end of the structure file respectively, for ease in adding new
  203. records.
  204.  
  205.      While entering new record information, you may press <ESC> at any time
  206. to abort the changes, or press enter on a blank field line.
  207.  
  208.      After entering all the questions that you wish to ask the user, save
  209. your structure definition with a unique filename.  You will use the first
  210. eight characters of this name as your first command line parameter when
  211. calling the main program from your BBS.  For example, if you are creating a
  212. database structure, and save it as "MYSTRUCT.DBS," you would call the program
  213. like so:
  214.  
  215.      URONLINE MYSTRUCT <door information filename>
  216.  
  217. Running The Configuration Program:
  218. ──────────────────────────────────
  219.  
  220.      You may want to have different colors from the default settings that UR
  221. On-Line has.  To facilitate this, we've included a small configuration
  222. program that will allow you to change the colors for everything displayed
  223. inside the door.
  224.  
  225.      Type URCONFIG at the DOS prompt to load the configuration editor. 
  226. Displayed will be a two short menus, and a display area showing the current
  227. settings.  If a configuration file already exists, the configuration program
  228. will automatically load it when you start the program.
  229.  
  230.      Press the left or right arrow keys to move the main menu bar left and
  231. right.  Press the up and down arrow keys to select which color option to
  232. change.  Pressing 'F' will increase the foreground color, while 'f'
  233. (lowercase) will decrease the foreground color.  Pressing 'B' will increase
  234. the background color, and pressing 'b' will decrease it.
  235.  
  236.      When you've acquired the color scheme that you like, you can press 'S'
  237. or move the main menu bar to Save and press <ENTER>.  Pressing 'Q' or
  238. choosing quit from the main menu will return you to DOS.
  239.  
  240. Running The Main Program:
  241. ─────────────────────────
  242.  
  243.      After successfully loading the main program, UR On-Line will initialize
  244. the current user into the user listing.  The user may then, according to the
  245. menu, browse through the users, list, edit, search or quit.  If a user enters
  246. the door, and they have not yet filled out their registry.  UR On-Line will
  247. first display a little note to them to press "E" to enter thier registry.
  248.  
  249.      Browse - Allows the user to "browse" through each user's name, with the
  250.      option of viewing that user.  Selecting "View"  while browsing through
  251.      users names displays that user, and the information that they have
  252.      entered for their registry.  "Next" and "Previous" move up and down
  253.      respectively though the user database.  "Quit" quits browse mode.
  254.  
  255.      List - List's each user by name, and the last database record
  256.      information.  For example, if the last record you defined in the
  257.      structure was "Please Summarize Yourself," and the short description was
  258.      "User Summary," that entry would be displayed alongside their name in
  259.      the listing.
  260.  
  261.      Edit - Will allow the user to enter their own registry, or, if they
  262.      already have, will let them edit a specific entry in their registry.
  263.  
  264.      Search - Allows the user to search for a particular user, or users. 
  265.      Using this option will ask if you wish to search by name or match. 
  266.      Choosing name will prompt you for a name, or part of a name to search
  267.      for.  Each user that has your search text in their name will be listed
  268.      in browse format.  Choosing match will bring up each question record, as
  269.      defined by the sysop, and ask which one you wish to search in.  Next,
  270.      you are prompted for the text to search for.  If you're searching a
  271.      number field, a number will be asked, and likewise, if searching a
  272.      yes/no/boolean field, a yes or no response will be asked.
  273.  
  274.      Quit - Quits UR On-Line and returns to the BBS.
  275.  
  276.      At the bottom of the screen is a sysop information bar displaying the
  277. current user in the door, along with their number, baud rate, and the actual
  278. account reference number in the user listing.
  279.  
  280.      Pressing F10 from inside UR On-Line will initiate two-way split-screen
  281. chat.  Press F10 or <ESC> to exit chat mode at any time.
  282.  
  283. Registration Of UR On-Line v1.0:
  284. ────────────────────────────────
  285.  
  286.      UR On-Line v1.0 is being released under the Shareware policy.  You may
  287. use UR On-Line for a trial period of 30 days free of charge.  After that
  288. time, if you find that you enjoy using UR On-Line and plan on using it in
  289. the future, you must register your copy of the program for $5.00 U.S.
  290. currency.
  291.  
  292.      Registration of the program entitles you to free updates of the same
  293. version number (ie. 3.x), along with a registered copy of the version you are
  294. registering.   Registration also adds you to the Datagen Software Designs
  295. Preferred Mailing List, and keeps you up to date on what's new with Datagen
  296. Software Designs.
  297.  
  298.      Your registration will help Datagen Software Designs in our goal to
  299. produce tons of quality, low cost software.
  300.  
  301.      To register your copy of UR On-Line v1.0, please fill out the enclosed
  302. registration file (URONLINE.REG), and mail it to the address indicated on the
  303. form.  Be sure to enclose a check or money order payable to "Datagen Software
  304. Designs c/o John Dailey" for $5.00 U.S., and also be sure that all
  305. information is filled out correctly and completely.  Your registration will
  306. be processed as soon as possible, and a registration diskette mailed to you
  307. in a few weeks.
  308.  
  309.                Datagen Software Designs Support BBS Application
  310.                ________________________________________________
  311.  
  312.   For application to become a  respectable Datagen Software Designs support
  313.   Bulletin Board System, simply fill out the following information and mail
  314.   to the below address.  Please be sure to include all information.
  315.  
  316.   Name   __________________________________________________________________
  317.           Last,                          First                          MI
  318.  
  319.   Age    ______       Phone  _________________________
  320.                              Area Code
  321.   Address__________________________________________________________________
  322.           Street
  323.  
  324.          __________________________________________________________________
  325.  
  326.          __________________________________________________________________
  327.          City,               State                    Zip
  328.  
  329.  
  330.   BBS Name ________________________________________________________________
  331.  
  332.   BBS Sysop Handle ________________________________________________________
  333.  
  334.   BBS Number ________________________  BBS Baud Rates _____________________
  335.              Area Code
  336.  
  337.   BBS Hours
  338.  
  339.   [  ] 24 hours    [  ] Part-Time (Specify Hours) _________________________
  340.  
  341.   BBS Type And Version ____________________________________________________
  342.  
  343.   BBS Net/Node (If Applicable) ____________________________________________
  344.  
  345.   BBS Time Running (Continuously) _________________________________________
  346.  
  347.   Disk Information
  348.  
  349.   [  ] 3 1/2" Diskette    [  ] 5 1/4" Diskette
  350.   [  ] High Density       [  ] Double Density
  351.  
  352.   Reason For Wanting To Become A Support BBS:
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.   Sysop's requesting to become a  support board will be notified as soon as
  361.   possible on their request once received.  Send all applications to:
  362.  
  363.           Support BBS Applications
  364.           Datagen Software Designs
  365.           1732 Wind Drift Rd.
  366.           Orlando, FL  32809
  367.  
  368. Authors Notes And Credits:
  369. ──────────────────────────
  370.  
  371.      Questions, comments, complaints, or to receive a complete listing and
  372. description of all Datagen products, mail John Dailey at the below address,
  373. through Compuserve at 73124, 2612, through the worldwide Internet network at
  374. 73124.2612@compuserve.com, or through WWIVNet at 166@4701 (The Lair of the
  375. Wolverine).
  376.  
  377.      Thank you for your support!
  378.  
  379.           UR On-Line v1.0
  380.           c/o John Dailey
  381.           1732 Wind Drift Rd.
  382.           Orlando, FL  32809
  383.  
  384.