home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / AB100B2.ZIP / AB.DOC next >
Encoding:
Text File  |  1995-03-26  |  19.8 KB  |  454 lines
  1.                        
  2.                        ┌──────╖ ┌─╖ ┌─╖ ┌─────╖ ┌──────╖
  3.                        │ ╓──┐ ║ │ ║ │ ║ └─┐ ╓─╜ │ ╓──┐ ║
  4.                        │ ╙──┘ ║ │ ║ │ ║   │ ║   │ ║  │ ║
  5.                        │ ╓──┐ ║ │ ║ │ ║   │ ║   │ ║  │ ║
  6.                        │ ║  │ ║ │ ╙─┘ ║   │ ║   │ ╙──┘ ║
  7.                        └─╜  └─╜ └─────╜   └─╜   └──────╜
  8.    ┌──────╖ ┌───╖ ┌──────╖ ┌──────╖ ┌──────╖ ┌──────╖ ┌─────╖ ┌─╖ ┌─╖ ┌─╖ ┌─╖
  9.    └┐ ╓─┐ ║ └┐ ╓╜ │ ╓──┐ ║ │ ╓────╜ │ ╓──┐ ║ │ ╓──┐ ║ │ ╓─┐ ║ │ ║ │ ║ │ ║ │ ║
  10.     │ ╙─┘ ║  │ ║  │ ║  │ ║ │ ║ ┌──╖ │ ╙──┘ ║ │ ╙──┘ ║ │ ╙─┘ ║ │ ╙─┘ ║ │ ╙─┘ ║
  11.     │ ╓─┐ ║  │ ║  │ ║  │ ║ │ ║ └┐ ║ │ ╓─┐ ╓╜ │ ╓──┐ ║ │ ╓───╜ │ ╓─┐ ║ └─┐ ╓─╜
  12.    ┌┘ ╙─┘ ║ ┌┘ ╙╖ │ ╙──┘ ║ │ ╙──┘ ║ │ ║ │ ╙╖ │ ║  │ ║ │ ║     │ ║ │ ║   │ ║
  13.    └──────╜ └───╜ └──────╜ └──────╜ └─╜ └──╜ └─╜  └─╜ └─╜     └─╜ └─╜   └─╜
  14.  
  15.  
  16.                          AutoBiography version 1.00ß2.
  17.  
  18.            Copyright 1994-1995 by Doug Kalman.  All rights reserved.
  19.  
  20.  
  21. ─────────────────────────────────────────────────────────────────────────────
  22.                               - Introduction -
  23. ───────────────────────────────────────────────────────────────────────────── 
  24.  
  25.  AutoBiography is an advanced User BIO System for DOOR.SYS compatible 
  26.  Bulletin Board Systems.
  27.  
  28.  Features     :  Support for up to 1000 database entries.
  29.                  
  30.                  Each entry can be comprised of up to 30 answers with a  
  31.                  maximum length of 60 characters each.
  32.  
  33.  Copyright    :  THE ENTIRE CONTENTS OF THE AutoBiography ARCHIVE ARE
  34.                  COPYRIGHT 1994-95 BY DOUG KALMAN.  ALL RIGHTS RESERVED.
  35.  
  36.  License      :  YOU HAVE BEEN GRANTED A 30 DAY LICENSE TO TRY AutoBiography.  
  37.                  IF YOU WISH TO CONTINUE USING AutoBiography AFTER THIS
  38.                  'TRIAL' PERIOD HAS EXPIRED, YOU *MUST* PURCHASE A LICENSE
  39.                  TO USE EACH COPY THAT YOU WISH TO RUN SIMULTANEOUSLY.
  40.                  MULTI NODE INSTALLATIONS THAT SHARE A COMMON DIRECTORY
  41.                  ONLY NEED TO REGISTER ONE COPY.  SEE THE FILE REGISTER.FRM
  42.                  INCLUDED IN THIS ARCHIVE.
  43.  
  44.  Warranty     :  THIS IS A BETA VERSION OF AutoBiography, THERE IS NO,
  45.                  ABSOLUTELY *NO* WARRANTY -- USE AT YOUR OUR OWN RISK.
  46.  
  47.  Requirements :  A Revision 5 Fossil Driver (X00/BNU/etc.)
  48.                  
  49.                  A BBS that is capable of generating a 52 line DOOR.SYS.
  50.  
  51.  Limitations  :  None, AutoBiography is not crippled in any way.
  52.  
  53.  
  54.                                  - Page 1 -
  55. ─────────────────────────────────────────────────────────────────────────────                
  56.                               - Installation -
  57. ─────────────────────────────────────────────────────────────────────────────
  58.  
  59.  Make a directory for AutoBiography. 
  60.  
  61.  Copy all the files contained in the AutoBiography archive to this directory.
  62.  
  63.  Add this directory to your path statement.
  64.  
  65.  Set the 'AB' environment variable to point to this directory.
  66.                 
  67.  Reboot your computer.
  68.  
  69.  AutoBiography is now installed.
  70.                                  
  71.  Once you have completed this section you can run AB.  
  72.  Simply invoke 'AB /L' from the command line.
  73.  
  74.  
  75.                                  - Page 2 -
  76. ─────────────────────────────────────────────────────────────────────────────
  77.                                - Invocation -
  78. ───────────────────────────────────────────────────────────────────────────── 
  79.  
  80.  AB.EXE is the AutoBiography main executable.
  81.  
  82.  AB.EXE can be executed from any directory as long as the AB system directory
  83.  has been added to your path and the 'AB' environment variable has been set.  
  84.  No batch file is necessary.  
  85.  
  86.  AB [/H] [/L] [/N#]
  87.  
  88.    /H          Run AutoBiography using handles instead of real names.  
  89.    /L          Run AutoBiography in LOCAL mode only.  
  90.    /N#         This parameter is used to specify the node number in a multi-
  91.                node system.  If this switch is omitted AutoBiography will
  92.                default to node 1.
  93.  
  94.  AB expects to be called from the individual node directory.  AB will create
  95.  the following files in the directory it is called from.
  96.  
  97.    AB###.LOG   This is the AutoBiography log file.  
  98.    ERRORS.LOG  This file is not currently used.
  99.  
  100.  AB will create the following files in it's system directory.
  101.  
  102.    AB.ASW      The AutoBiography User File.
  103.    AB.IDX      The AutoBiography User File Index.
  104.  
  105.  ABUTIL.EXE is a user notification utility.  Its main function is to notify
  106.  users that the AutoBiography door exists and that they have not yet
  107.  completed an entry.  ABUTIL is oftened invoked from the systems TOP menu, or
  108.  somewhere else so that it will only be executed once per logon.  
  109.  
  110.  ABUTIL [/H] [/L] [/N#] [/Tfilename]
  111.  
  112.    /H          Run AutoBiography Notification Utility using handles instead
  113.                of real names.
  114.    /L          Run AutoBiography Notification Utility in LOCAL mode only.
  115.    /N#         This parameter is used to specify the node number in a multi-
  116.                node system.  If this switch is omitted AutoBiography will
  117.                default to node 1.
  118.    /Tfilename  Specifies the textfile that ABUTIL will display to users who
  119.                have not yet created an AutoBiography entry.  Do not include
  120.                a file extension.
  121.  
  122.  ABUTIL expects to be called from the individual node directory.  
  123.  
  124.  If you're running AB with the [/H] parameter then you should run ABUTIL with
  125.  it as well. 
  126.           
  127.  ABUSER is a user index sorting utility.  This should be run during your
  128.  evening maintenance event.  Its sole purpose it to sort, alphabetically, the
  129.  users index file.  
  130.  
  131.  ABUSER can be called form anywhere, and makes use of the 'AB' environment
  132.  variable to find it's data files.
  133.  
  134.  ABUSER [/S]
  135.  
  136.    /S          Sort AutoBiography User File in ascending alphabetical order.
  137.  
  138.  Both the ABUTIL and the ABUSER programs are not required for the running or
  139.  maintenance of AutoBiography.  If you have no wish to use them then don't.
  140.  
  141.  ABDATA is a non-distributed program that will attempt to repair the
  142.  AutoBiography User and/or Index Files.  I have only had to resort to using
  143.  this program once!  If for some reason your AB.ASW or AB.IDX file gets hosed
  144.  you'll need to contact me and make arrangements to send me your AB user 
  145.  files.  
  146.  
  147.  The following installation example has been taken from my own RemoteAccess
  148.  system.  It will not work on your system and is included only as an
  149.  installation example.  One should also note that all commands and parameters
  150.  are case-insensitive and may be preceeded by either the '/' or '-' 
  151.  character.  AB.EXE -H /l IS THE SAME AS aB.eXE -L /h.
  152.  
  153.  Example for running the AB.EXE main executable.
  154.  
  155.    f:\tp\ab.exe /H /N3
  156.  
  157.      The file AB.EXE in the F:\TP directory will be executed using handles
  158.      instead of real names.  We are calling AutoBiography from BBS node 3.
  159.  
  160.  Example for running the ABUTIL.EXE notification executable.
  161.  
  162.    f:\tp\abutil.exe /H /N1 /TNOTIFY
  163.  
  164.      The file ABUTIL.EXE in the F:\TP directory will be executed using 
  165.      handles instead of real names.  
  166.      
  167.      We are calling AutoBiography from BBS node 1.
  168.      
  169.      The file NOTIFY.A?? will be displayed to users who have not yet created
  170.      an AutoBiography entry.  NOTIFY.ANS will be displayed to to ANSI callers
  171.      and NOTIFY.ASC will be displayed to ASCII callers.
  172.  
  173.      This should be configured to automatically execute just once per logon.
  174.  
  175.  Example for running the ABUSER.EXE maintenance executable.
  176.  
  177.    f:\tp\abuser.exe /s
  178.  
  179.      The file ABUSER.EXE in the F:\TP directory will be executed, user names
  180.      or handles will be sorted alphabetically in ascending order.
  181.  
  182.      This should be located somewhere in your maintenance batch file.
  183.  
  184.  AB.EXE and ABUTIL.EXE are complete doors, that is they both are user
  185.  interactive and hardware interactive.  Both programs will intitialize your
  186.  fossil driver and read information about the current user online from a BBS
  187.  generated DOOR.SYS file.  Both programs will watch carrier and abort back to
  188.  the calling BBS on carrier loss.  Both programs will also honor the users
  189.  time remaining and respectfully drop carrier, after sending a message to the
  190.  user notifying them of this.  Additionally, both programs are hard-coded 
  191.  with a 5 minute user time out, and will drop carrier if this is exceeded.  A
  192.  message will be displayed to the user notifying him of this.  I've pretty
  193.  much tried to plan ahead for any possible problem that might be encountered
  194.  while a user is in these doors.
  195.  
  196.  While a user is online or when executed locally both AB.EXE and ABUTIL.EXE
  197.  will display a status bar on the local screen.  Using the F keys you can 
  198.  cycle through 10 different status displays.  The status bar uses the bottom
  199.  two lines of the local screen by default.  Pressing the F8 key will force
  200.  the status bar to use only the bottom line of the local display.  This helps
  201.  simulate what the calling user sees, as most terminal software displays a
  202.  one line status bar.  F9 is a help screen, F10 turns off the status bar
  203.  completely.  It can, of course, be turned back on by pressing any other F
  204.  key.  Keys F1 through F7 give addiotnal information about the online user.
  205.  
  206.  Please note that pressing keys, other than the status bar keys will appear
  207.  on the remote callers screen as if they typed them.
  208.  
  209.  I have given you enough information to get AutoBiography installed.  The
  210.  distribution archive includes a working sample configuration.
  211.  
  212.  Of course this software is so configurable you'll want to jump right into
  213.  the advanced configuration.  This next section will explain what you need to
  214.  do in order to create a personalized version of the software.  ALL of the
  215.  configuration files can be 100% modified, making AutoBiography one of the
  216.  configurable doors out there, additionally all the textfiles are 100% 
  217.  editable in any ANSI editor.
  218.  
  219.  
  220.                                  - Page 3 -
  221. ─────────────────────────────────────────────────────────────────────────────                          
  222.                          - Advanced Configuration -
  223. ─────────────────────────────────────────────────────────────────────────────  
  224.  
  225.  This section specifically deals with customization of your copy of 
  226.  AutoBiography.  
  227.  
  228.  You should note that AutoBiography will expect to find an ANSI and ASCII
  229.  version of each supported textfile.  So the file GENERAL.A?? actually refers
  230.  to two files, one called GENERAL.ANS for ANSI users and one called 
  231.  GENERAL.ASC for ASCII users.  These are the only two emulations that are
  232.  currently supported.
  233.  
  234.  GENERAL.A??  : This file will be displayed to users who enter the door and
  235.                 have not yet created an AutoBiography entry.  This file will
  236.                 also be displayed when a user chooses the main menu command
  237.                 'G', for general.  It is completely editable in any ANSI
  238.                 editor.  Remember to save your changes to both the ANSI file
  239.                 and the ASCII file.
  240.  
  241.  MAINMEN1.A?? : This file will be displayed to users who enter the door and
  242.                 have not yet created an AutoBiography entry.  This file is
  243.                 completely editable in any ANSI editor.  Remember to save 
  244.                 your changes to both the ANSI and the ASCII file.
  245.  
  246.  MAINMEN2.A?? : This file is almost identical to the MAINMEN1 file except it
  247.                 is displayed to users who already have completed an 
  248.                 AutoBiography entry.  The difference between this file and 
  249.                 the MAINMEN1 file is MAINMEN1 has a 'C', for create, option
  250.                 and MAINMEN2 has an 'E'dit, for edit, option.  The difference
  251.                 between these function should be obvious.
  252.  
  253.  The above two files are the menus AutoBiography uses.  The following MENU
  254.  commands are supported.  Case is insensitive and capitals are used for
  255.  clarity in this documentation.
  256.  
  257.        G      : Displays the GENERAL file.  
  258.    
  259.        C      : Create your entry.  MAINMEN1 ONLY!
  260.  
  261.        E      : Edit your entry.  MAINMEN2 ONLY!
  262.  
  263.        U      : AutoBiography User Listing.
  264.  
  265.        L      : Look up a users entry.
  266.  
  267.        V      : Version Information.   
  268.    
  269.        X      : Return to the calling BBS.
  270.                 
  271.  ENTRY.A??    : This file is displayed when a user chooses the view another
  272.                 users AutoBiography entry.  This file can be fully edited in
  273.                 any ANSI editor.  
  274.                 
  275.  EDIT.A??     : This file is displayed when a user chooses to edit their own               
  276.                 entry, and is nearly identical to the ENTRY file.  This file 
  277.                 too, can be fully edited in any ANSI editor.
  278.                 
  279.  Additionally the files ENTRY and EDIT will parse the following case 
  280.  insensitive tokens.
  281.                                  
  282.       @N      : Translates to the users full name or handle.
  283.  
  284.       @S      : This translates to the users 'User Note'.
  285.  
  286.       %S      : This will translate to an answer in the users entry.
  287.                 This field is probably going to cause some confusion
  288.                 initially.  When the ENTRY or EDIT files are displayed each
  289.                 %S is replaced with an answer from the users entry.  The
  290.                 answers are displayed in ascending numerical order, so if the
  291.                 questionaire has 25 questions you'd want to have 25 %S
  292.                 tokens.  It should be noted that textfiles are displayed from
  293.                 left to right, top to bottom.  I strongly recommend that you
  294.                 study the ENTRY and EDIT files that are included with the
  295.                 distribution archive, before editing.  
  296.  
  297.  But wait, there are also several formatting codes that can be used with 
  298.  these tokens.
  299.  
  300.        +      : Left justifies the answer.
  301.  
  302.        -      : Right justifies the answer.
  303.  
  304.        #      : Centers the answer.
  305.  
  306.  And each of these formatting codes can be optionally combined with a field 
  307.  width.  Below are some examples of tokens, codes and field widths.
  308.             
  309.     %+35s   : Left justify an answer field, force width to 35 charatcers.
  310.  
  311.     %-10s   : Right justify an answer field, force width to 10 characters.
  312.  
  313.     @+40N   : Left justify a name field, force width to 40 characters.
  314.  
  315.     @#60S   : Center the 'User Note', field, force the width to 60 
  316.               characters.
  317.  
  318.  
  319.                                  - Page 4 -
  320. ─────────────────────────────────────────────────────────────────────────────                          
  321.                          - Advanced Configuration -
  322. ─────────────────────────────────────────────────────────────────────────────  
  323.  
  324.  AB.QUE       :  This file is the questionaire configuration file.  This file
  325.                  may contain up to 30 questions.  The format of a question is
  326.                  question number, maximum answer length, and question in that
  327.                  order.  
  328.  
  329.  Before getting into the syntax of the questionaire file it should be noted 
  330.  that their are several tokens that are available.
  331.  
  332.        ;      :  A semi-colon as the first character of any line will cause
  333.                  AutoBiography to treat any text on that line as a comment.
  334.  
  335.               :  A blank line is treated as a carriage return, line feed and
  336.                  will cause the local and remote display to skip a line.
  337.  
  338.    [color]    :  You can use any one of 16 color tokens to change the 
  339.                  foreground color of the text, as it's displayed both locally
  340.                  and remotely.  So if you want to change the foreground color
  341.                  to Yellow you would use the token [yellow], the case is not
  342.                  sensitive so YELLOW is the same as yELLow and YeLlOw.  The
  343.                  16 foreground colors are listed below.
  344.  
  345.                  Black, Blue, Green, Cyan, Red, Magenta, Brown, LightGray,
  346.                  DarkGray, LightBlue, LightGreen, LightCyan, LightRed, 
  347.                  LightMagenta, Yellow and White.
  348.  
  349.                  A color token starts a line and ends a line in the AB.QUE
  350.                  file, that is it gets its own line and starts at the first
  351.                  character on that line.  This too, may seem confusing at 
  352.                  first but in practice will become second nature quickly.
  353.  
  354.  The actual syntax of the AB.QUE file is very simple.  Each question, up to              
  355.  the maximum (30 questions) needs to have a question number, followed by a
  356.  maximum answer length, follwed by the question, of course.  To help explain
  357.  how this works, lets use an example.
  358.  
  359.  In this example lets assume the question number is one (1) and you'd like 
  360.  the users answer limited to one (1) character.  Let's say you want to ask a
  361.  users sex, and you'd like the answer to be in the form of (m/f).  A line by
  362.  line narration follws this example.  Please note that line numbers appear
  363.  below only for reference in this example and shouldn't be used when editing
  364.  the actual AB.QUE file.
  365.  
  366.  01   ;
  367.  02   ; Sample question number 1
  368.  03   ; Maximum answer length is 1
  369.  04   ;
  370.  05   ;
  371.  06   [Yellow]
  372.  07   Welcome to our sample questionaire.  This sample contains one question.
  373.  08
  374.  09   [White]
  375.  10   1
  376.  11   1
  377.  12   What is your sex (m/f)?
  378.  13   ;
  379.  14   ;
  380.  15   ; End of sample question number 1
  381.  
  382.  Line 1 is a control token that tells AutoBiography to treat the line as a 
  383.  comment, and not to process it.  This line is ignored.
  384.  
  385.  Line 2 is also a control token that instructs AutoBiography to treat the 
  386.  line as a comment, and not process it.  This line is also ignored.
  387.  
  388.  Lines 3, 4 and 5 are also comments.
  389.  
  390.  Line 6 instructs AutBiography to use the foreground color yellow.
  391.  
  392.  Line 7 is will be displayed in Yellow both locally and remotely verbetim.
  393.  That is any character ASCII #32 through #255 will be displayed.  This 
  394.  includes tabs, spaces, any punctuation.
  395.  
  396.  Line 8 is blank so AutoBiography will send a line feed and carriage return
  397.  to both the remote and local screens.  That's verbetim blank -- no spaces,
  398.  tabs, etc.
  399.  
  400.  Line 9 is also a color change.  The foreground color is now white.
  401.  
  402.  Line 10 tells AutoBiography to get ready to ask question number 1 and write
  403.  the users response to the database.
  404.  
  405.  Line 11 further instructs AutoBiography that the users response to question
  406.  number 1 should be limited to 1 character in length.  This line is actually
  407.  optional.  If omitted AutBiography will default to the maximum length of 60
  408.  characters.
  409.  
  410.  Line 12, at last we're ready to ask a the question.  Our question as with 
  411.  any text in the AB.QUE file is displayed locally and remotely verbetim.
  412.  This affords a high degree of customization within a single file with the
  413.  only a handful of control codes or tokens to learn.
  414.  
  415.  Lines 13, 14 and 15 are, of course, comments and are ignored.
  416.  
  417.  Included in this archive is a sample AB.QUE, that of course if fully 
  418.  functional.  Please use this file as a guide, or template.
  419.  
  420.  
  421.                                  - Page 5 -
  422. ─────────────────────────────────────────────────────────────────────────────                          
  423.                           - Contacting the Author. -
  424. ─────────────────────────────────────────────────────────────────────────────  
  425.  
  426.  Coming Attractions! BBS
  427.  
  428.   Node 1       : 908-972-8583  Zoom 14400
  429.   Node 2       : 908-972-4159  Practical 14400
  430.  
  431.  Netmail
  432.  
  433.   Doug Kalman @ 1:107/108.0
  434.  
  435.  InterNet
  436.  
  437.   dkalman@metronj.org
  438.  
  439.  US Mail
  440.  
  441.   Doug Kalman
  442.   5 Morris Court 
  443.   Morganville, New Jersey 07751
  444.  
  445.  Voice
  446.  
  447.   (908)536-9709  Eastern time -- normal business hours please
  448.  
  449.  
  450.                                  - Page 6 -
  451. ─────────────────────────────────────────────────────────────────────────────                          
  452.                                                           
  453. ─────────────────────────────────────────────────────────────────────────────  
  454.