home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1993 #2 / Image.iso / database / qrdb39b.zip / QRDB.DOC < prev    next >
Text File  |  1993-07-30  |  45KB  |  900 lines
  1.  
  2.  
  3.  
  4.                            QRDB  Vers 3.9b               30 July 93
  5.                       Mountain Retreat Software
  6.  
  7.                                 QRDB
  8.                 (c) Copyright 1992 by John Jamieson
  9.                          All Rights Reserved
  10.  
  11.  
  12. Intro:
  13.  
  14.   QRDB/QRDBMgr is a Data Base system for BBS's that use Door.Sys or
  15.   DorInfo1.Def. QRDB is a multi-node compatable BBS Data Base door and
  16.   QRDBMGR is the Data Base Manager. Although QRDB was designed to be
  17.   used as a BBS door it can be used by users without a BBS if needed. A
  18.   BBS is not required in order to run the program, it will run in local
  19.   mode. QRDB requires 400k of memory.
  20.  
  21.  
  22. QRDB/QRDBMgr offers three types of Data Base.
  23.  
  24.   Type 1 will import any text file in which the data is layed out in
  25.   columns. The imported Data Base can then be made available to BBS
  26.   users for searches or sorted list displays. Up to five keys can be
  27.   designated making five sorted lists available to the user.  This Type
  28.   1 Data Base is not editable and a Data Record is limited to 80
  29.   characters. An example of a file suitable for import is the Darwin BBS
  30.   listing.
  31.  
  32.   Type 2 is a build from scratch Data Base. The user can Add, Edit and
  33.   Delete records in the Type 2 Data Base. Read, Write and Edit/Del
  34.   levels are established by the Sysop. A log is maintained of all
  35.   Additions, Edits and Deletes made by users. This type 2 Data Base can
  36.   contain up to 25 fields per Record with a maximum of 5 Key fields. 5
  37.   display lines with 5 fields per line max.  Fields can be designated as
  38.   input optional or input required. QRDB can import comma delimited
  39.   files into the type 2 Data Base.
  40.  
  41.   Type 3 will display data in dBase .DBF data files and .DBT memo files.
  42.   The dBase Data can then be made available to BBS users for searches or
  43.   sorted list displays. Up to five keys can be designated making five
  44.   sorted lists available to the user. The user can Add, Edit and Delete
  45.   records in the Type 3 Data Base. Read, Write and Edit/Del levels are
  46.   established by the Sysop. A log is maintained of all Additions, Edits
  47.   and Deletes made by users. All fields except the Memo's are searched
  48.   when using the Search function.
  49.   QRDB does not use dBase Index files, it uses it's own indexing system.
  50.   QRDB LIMITS on dBase files are as follows. QRDB will only handle
  51.   dBase records with 20 or less fields. The number of memo's is limited
  52.   to 3 per record and the lines in a memo are limited to 20 with a
  53.   maximum line length of 76 characters.
  54.  
  55. User Access to data
  56.  
  57.   Access to files is controlled by Levels established for each DataBase.
  58.   Read, Write and Edit/Delete levels are seperatly controlled.
  59.   In addition to access provided under level control, a user is given
  60.   access to any record that he/she creates. This Record access is
  61.   controled by the index files identified *O.IDX. This feature can be
  62.   disabled by deleting the *O.IDX file after the user exits QRDB. QRDB
  63.   will build a new empty *O.IDX if it dosen't find one.
  64.   An example of the posibilities:
  65.   A user can be given Add, Edit/Delete access and No Read access. In
  66.   this situation a user database, that only the Sysop or CoSysops with
  67.   read access would have access to all the records, could be built and
  68.   maintained by users.
  69.  
  70. When run in local mode or stand-alone full access to all features is
  71. given and levels do not apply.
  72.  
  73. The advantages/disadvantages of each type are as follows:
  74.     Type 1: Imports text layed out in columns.
  75.             Only displays, no edits.
  76.             User Read Access controlled by security level
  77.  
  78.     Type 2: Data base can be built on line.
  79.             Imports comma delimited files
  80.             Exports to comma delimited files
  81.             User access to Read, Add, Edit and/or Delete controlled
  82.             by user Level
  83.  
  84.  
  85.     Type 3: Data base uses dBase .DBF and .DBT files
  86.             Checks date entries for validity
  87.             Checks numeric entries
  88.             dBase Memo capability, a great feature
  89.             Requires dBase Compatable files
  90.             User access to Read, Add, Edit and/or Delete controlled
  91.                 by user Level
  92.  
  93.             dBase Compatable files can be created with the Shareware
  94.             utility dBuddy. Additional dBuddy info is below.
  95.  
  96.  
  97. Example QRDB main Menu and Status Bar:
  98.  
  99. ╔════════════════════════════════════════════════════════════════════════╗
  100. ║            ░░▒▒▓▓██  Q R D B    M A I N    M E N U  ██▓▓▒▒░░           ║
  101. ║                                                                        ║
  102. ║  ░▒              Mountain Retreat DataBase Selection               ▒░  ║
  103. ╠════════════════════════════════════════════════════════════════════════╣
  104. ║  A    Fido Net BBS's in North America                                  ║
  105. ║  B    Fido Net BBS's Outside N. America                                ║
  106. ║  C    Darwin National BBS List                                         ║
  107. ║  D    System User's                                                    ║
  108. ║  E    WildCat BBS's in the North America                               ║
  109. ║  F    User Generated List of Area Code 408 BBS's                       ║
  110. ║  G    Hardware/Software Industry Support BBS's                         ║
  111. ║  H    User Generated List of Out of Area Boards                        ║
  112. ║  I    Computer Hwd/SW Suppliers support (Not BBS's)                    ║
  113. ║                                                                        ║
  114. ║  ?    Help                                                             ║
  115. ║  X    Exit QRDB                                                        ║
  116. ╠════════════════════════════════════════════════════════════════════════╣
  117. ║      QRDB Door - Mt. Retreat Software - Support BBS (408)335-4595      ║
  118. ╚════════════════════════════════════════════════════════════════════════╝
  119.  Selection:
  120.  
  121. ┌───────────────────────────────────────────────────────────────────────────┐
  122. │John Jamieson                 Level=100     Baud=2400        Graphics=On   │
  123. │Felton, Ca                    Min's Left=67                  Alt-H= Hangup │
  124. └───────────────────────────────────────────────────────────────────────────┘
  125.  
  126.  
  127.  
  128. Quick Start:
  129.  
  130.     a. To Run QRDB add the Environment Variable SET QRDB=C:\QRDB, set it
  131.        to whatever directory QRDB is located in. If the Environment
  132.        Variable is not set you must run QRDB from the QRDB directory.
  133.        QRDB uses the Environment Variable to locate the the QRDB data
  134.        files and key file, if they are not found you will get the error
  135.        message "QRDB.KEY not found or Corrupt.
  136.     b. QRDB requires 400k of memory to run. If your BBS is capable of
  137.        swaping to EMS or disk when running a door use that option.
  138.        Most likely you won't have enough memory to keep the BBS in
  139.        memory and still have 400k for QRDB. Most Systems have a batch
  140.        file/errorlevel system that will free enough memory for QRDB.
  141.     c. If Running MultiNode, run QRDB from a different directory for
  142.        each node. Example C:\BBS\Node0, C:BBS\Node1, etc. QRDB needs
  143.        to find either Door.Sys or DorInfo1.Def in the node directory.
  144.        DorInfo2.Def won't do if your system uses a DorInfo other than
  145.        1, rename it. QRDB expects to find either Door.Sys or DorInfo1.Def
  146.        in the directory it is run from.
  147.     d. QRDB defaults to Local mode, without a status line, if it can't
  148.        find DorInfo1.Def or Door.Sys. It will also run in Local mode,
  149.        but with a status line if the baud rate it finds in DorInfo1.Def
  150.        or Door.Sys is 0.
  151.     e. The Main menu can be bypassed. A couple of reasons for bypassing
  152.        are; if only one data base is to be included or the sysop would
  153.        rather use the BBS menus to access the data bases. Bypassing is
  154.        accomplished by executing QRDB with the name of the CL file as a
  155.        command line parameter. Example C:\QRDB\QRDB.EXE CHAPLIN.3CL
  156.        or if running stand-alone local mode  QRDB.EXE CHAPLIN.3CL. To
  157.        run in stand-alone local mode, but monochrome use  QRDB.EXE /M
  158.        CHAPLIN.3CL.
  159.     f. A few sample Data Bases are included in the package. Just place
  160.        the QRDB package of files in their own directory and run QRDB or
  161.        QRDB /M for Local in monochrome, and follow the Prompts. The
  162.        Darwin Data Base related files included with the package contains
  163.        a setup only, no data, it's use will be discussed later. Feel
  164.        free to use any of the examples on your BBS or delete them using
  165.        the QRDBMgr or DOS. It is suggested that you review the Example
  166.        setups prior to deleting them. Run the QRDBMgr and press F2 to
  167.        call up the control file editor. The editor can be used to review
  168.        the setups.
  169.     g. If you are running QuickBBS or RA
  170.        After seting the Environment variable,  create a QuickBBS/RA type
  171.        7 menu type and in the Optional data field just place the command
  172.        C:\QRDB\QRDB.EXE *M  that's all their is to it. To bypass the
  173.        QRDB main menu use  C:\QRDB\QRDB.EXE CHAPLIN.3CL *M
  174.        (*M is a QuickBBS/RA option telling the BBS to swap to EMS or Disk)
  175.     h. Maximus or Virtual BBS check the files Maximus.BBS or Virtual.BBS
  176.        for additional info.
  177.     I. Other systems,  jot down your installation procedure and send it
  178.        to me. I'll include it in the next release of QRDB. It could save
  179.        another sysop a lot of headaches.
  180.  
  181.  
  182.  
  183. Files:
  184.  
  185.   A set of files will be created for each Data Base
  186.    .1CL,.2CL or .3CL  Control file; a Type 1,2 or 3
  187.    .Dat     Data file;  for type 1 & 2 only, type 3 uses your.DBF file
  188.    .IDX     Index file; 1 to 5 as specified during setup
  189.  
  190.   A QRDB general help file will be displayed from the main menu, if you
  191.   name it QRDB.HLP. You can also create a .HLP file for each Data Base by
  192.   using the same name as your Data Base. If a help file is found it will
  193.   be offered to the user in the QRDB menus. .HLP files are just text
  194.   files.
  195.  
  196.   When assigning file names you will be allowed 7 characters instead of
  197.   the usual 8. QRDB needs that 8th character.
  198.  
  199.   A Data Base consisting of a set of the above files is a stand alone
  200.   package. It can be copied/moved to another BBS that uses QRDB or it
  201.   can be deleted from your QRDB directory. QRDBMgr has a delete function,
  202.   it's there only for convenience DOS is all that is needed.
  203.  
  204.   The files provided with the package are the following :
  205.  
  206. QRDBMGR.EXE     The QRDB Manager used to set up data bases for QRDB
  207. QRDB.EXE        The QRDB BBS Door
  208. QRDB_FOS.EXE    The QRDB BBS Door Fossil Version
  209. QRDB.TTL        A file that stores the title you give to the QRDB Main Menu
  210. QRDB.DOC        This File
  211. QRDB.KEY        Key to QRDB operation
  212. QRDB.HLP        A Sample general help file
  213.  
  214.      ** The following files are example files and can
  215.          be deleted when you are finished with them.
  216.  
  217. SUPPORT.1CL     Type 1 Sample Control File  (List of Support BBS's)
  218. SUPPORT.DAT     Type 1 Sample Data File
  219. SUPPORT.HLP     Support Data Base Help File (Text)
  220. SUPPORT1.IDX    Type 1 Sample Index file #1
  221. SUPPORT2.IDX    Type 1 Sample Index file #2
  222. SUPPORT.TXT     Text file used in the creation of the Type 1 Sample
  223.  
  224. BBSLIST.2CL     Type 2 Sample Control File (User generated BBS List)
  225. BBSLIST.DAT     Type 2 Sample Data File
  226. BBSLIST.HLP     BBSList Data Base Help File (Text)
  227. BBSLIST1.IDX    Type 2 Sample Index file #1
  228. BBS.LST         A sample comma delimited file for import into
  229.                  the BBSLIST data base
  230.  
  231. WGUIDE.2CL      Type 2 Sample Control File (Wine Guide)
  232. WGUIDE.DAT      Type 2 Sample Data File
  233. WGUIDE.HLP      WGuide Data Base Help File (Text)
  234. WGUIDE1.IDX     Type 2 Sample Index file
  235. WGX.CTL         Control file for Export of WGuide to Comma Delimited file
  236. WGX.TXT         Comma Delimited Exported database
  237.  
  238. USERDAT.2CL     Type 2 Sample Control File (User DataBase)
  239. USERDAT.DAT     Type 2 Sample Data File
  240. USERDAT1.IDX    Type 2 Sample Index
  241.  
  242. USERINF  3CL    Type 3 Sample Control File (User DataBase as above but dB3)
  243. USERINF  DBF    dBase .DBF file used by QRDB
  244. USERINF  DBT    dBase .DBT Memo file used by QRDB
  245. USERINF1 IDX    Type 3 Sample Index
  246.  
  247. CHAPLIN.3CL     Type 3 Sample Control File  (Chaplin dBase Data Base)
  248. CHAPLIN.DBF     dBase .DBF file used by QRDB
  249. CHAPLIN.DBT     dBase .DBT Memo file used by QRDB
  250. CHAPLIN.HLP     Chaplin Data Base Help File (Text)
  251. CHAPLIN1.IDX    Type 3 Sample Index file
  252.  
  253. USBBS.1CL       Type 1 Sample Control File (Setup for Darwin USBBS list)
  254. USBBS.DAT       Empty Type1 Sample Data File
  255. USBBS.HLP       USBBS Data Base Help File (Text)
  256. USBBS1.IDX      Type 1 Sample Index file #1
  257. USBBS2.IDX      Type 1 Sample Index file #2
  258. USBBS3.IDX      Type 1 Sample Index file #3
  259.  
  260. MAXIMUS.BBS     Info on setting up under Maximus.BBS
  261. VIRTUAL.BBS     Info on setting up under Virtual.BBS
  262.  
  263. The complete chaplin dBase package can be download from Mountain Retreat
  264. only the .DBF & .DBT file are included here. The Complete package
  265. includes Chaplin.FMT. Since QRDB only reads .DBF and .DBT files I didn't
  266. include the conplete package.
  267.  
  268. The files provided will appear in the QRDB main menu as follows:
  269.  
  270. ╔════════════════════════════════════════════════════════════════════════╗
  271. ║            ░░▒▒▓▓██  Q R D B    M A I N    M E N U  ██▓▓▒▒░░           ║
  272. ║                                                                        ║
  273. ║  ░▒                  Your BBS DataBase Selection                   ▒░  ║
  274. ╠════════════════════════════════════════════════════════════════════════╣
  275. ║  A    Computer Hardware/Software Support                               ║
  276. ║  B    Darwin National BBS List                                         ║
  277. ║  C    User List of Favorite BBS's                                      ║
  278. ║  D    User Data Base                                                   ║
  279. ║  E    Central California Winery Guide                                  ║
  280. ║  F    A Data Base of Chaplin Movies                                    ║
  281. ║  G    DataBase of BBS user info                                        ║
  282. ║                                                                        ║
  283. ║  ?    Help                                                             ║
  284. ║  X    Exit QRDB                                                        ║
  285. ╠════════════════════════════════════════════════════════════════════════╣
  286. ║      QRDB Door - Mt. Retreat Software - Support BBS (408)335-4595      ║
  287. ╚════════════════════════════════════════════════════════════════════════╝
  288.  Selection:
  289.  
  290.   In the menu above the "User Data Base" is a type 2 data base and
  291.   "DataBase of BBS user info" is a similar data base useing a type
  292.   3 data base with memo's
  293.  
  294.  
  295. Trouble shooting the QRDB door installation:
  296.  
  297.   The Status bar can be an aid in trouble shooting the door installation.
  298.   a.  QRDB looks in the directory it is run from for Door.Sys and if it
  299.       is not found it looks for DorInfo1.Def. It then uses the environment
  300.       variable QRDB to locate the QRDB key and data files.
  301.   b.  If you get the Error message QRDB.Key not found or Corrupt, make
  302.       sure you have the environment variable set, before looking for
  303.       other problems. Example QRDB=C:\QRDBDIR set it to the directory
  304.       that QRDB is located in.
  305.   c.  No status bar indicates that the Door.Sys or DorInfo1.Def file was
  306.       not found and QRDB is running in local mode.
  307.   d.  A status bar with a Baud rate other than 0 indicates the Door.Sys
  308.       or DorInfo1.Def file has been read, QRDB has Config and user info
  309.       and is running as a door.
  310.   e.  If the status bar shows a baud rate of 0 then Door.sys or
  311.       DorInfo1.Def has been Read and QRDB is running in local mode.
  312.   f.  If double spaceing or blank lines in a occure in records when
  313.       displaying it's probably due to, too much data being placed on a
  314.       line. Go back to the QRDBMgr and do some rearranging.
  315.  
  316.  
  317. QRDBMgr:
  318.  
  319.   QRDBMgr.EXE is used to setup a data base, create/edit control files,
  320.   import data and generate index files.
  321.  
  322.   QRDBMgr can be used with or without a mouse. If running without a
  323.   mouse use the arrows keys to select menu items and the Tab key to
  324.   Select Entry fields or Buttons. Main menu items are selected by
  325.   pressing the Alt key plus the HighLighted letter in the menu item
  326.   description.
  327.  
  328.   The diagram below shows the menu selections that are available in
  329.   QRDBMgr.
  330.  
  331.   Remember the Data_Base_Setup functions only put together a control
  332.   file. If you are creating a type 1 data base you will still need to
  333.   import the data using the Import_Type_1_DB_Data function.  In the case
  334.   of a type 3 data base the Build_Type_3_DB_Index function will create
  335.   the necessary indexes to the .DBF file. QRDB does NOT use dBase index
  336.   files.
  337.  
  338.   Qnce a Data Base contains Data/Indexes, changes to certain fields will
  339.   no longer be allowed. You will receive a message telling you which
  340.   fields can't be edited when you attempt to edit a Data Base containing
  341.   data. If you need to edit one of those fields the only way is to Erase
  342.   the data using the Manager's "Erase QRDB Index/Data" function, make
  343.   the necessary changes and then Import, Build or Re-enter the data.
  344.  
  345.   The Erase QRDB Index/Data function works differently on each dB type.
  346.  
  347.     a. The Erase QRDB Index/Data function does not erase dBase .DBF or
  348.        .DBT files, use dBase to erase those. The Erase QRDB Index/Data
  349.        function does erase Type 3 indexes.
  350.  
  351.     b. In the case of the type 2 database Data and Indexes are Erased by
  352.        the Erase QRDB Index/Data function.
  353.  
  354.     c.  When used on a type 1 database the Erase QRDB Index/Data
  355.         function will omly delete Indexes.
  356.  
  357.   The delete function will in addition to accomplishing the erase function
  358.   above will also delete the associated QRDB setup.
  359.  
  360.  
  361.  
  362. ┌──────────────────────────────────────────────────────────────────────────┐
  363. │ Exit  Data_Base_Setup           Operations        Shell_to_QRDB          │
  364. └──────────────┬───────────────────────┬─────────────────┬─────────────────┘
  365.                │                       │                 │
  366.                │                       │                 │
  367.                │                       │                 │
  368.   ┌────────────┴─────────────┐         │                 │
  369.   │ Edit a DB Setup       F2 │         │                 │
  370.   │ Make a New Type 1 DB  F4 │         │                 │
  371.   │ Make a New Type 2 DB  F5 │         │                 │
  372.   │ Make a New Type 3 DB  F6 │         │                 │
  373.   └──────────────────────────┘         │                 │
  374.                                        │                 │
  375.                             ┌──────────┴───────────────┐ │
  376.                             │ Main Menu Title Edit     │ │
  377.                             │ Import Type 1 DB Data    │ │
  378.                             │ Read in Type 2 DB Data   │ │
  379.                             │ eXport Type 2 DB Data    │ │
  380.                             │ Build Type 3 DB Index    │ │
  381.                             │ Copy a QRDB Setup        │ │
  382.                             │ Delete a DataBase        │ │
  383.                             │ Erase QRDB Index/Data    │ │
  384.                             └──────────────────────────┘ │
  385.                                                          │
  386.                                                     ┌────┴───────┐
  387.                                                     │ Color   F8 │
  388.                                                     │ Monochrome │
  389.                                                     └────────────┘
  390.  
  391.  
  392. Creating a Type 1 Data Base  ********
  393.  
  394.   To create a Type 1 Data Base you will need a text file to import. The
  395.   USBBS list by Darwin Systems is a good file to start with. Any list
  396.   you chose to create a Type 1 Data Base from must be one in which the
  397.   data is arranged in columns. QRDB will extract it's keys from those
  398.   columns during conversion. Remove any material that isn't a part of
  399.   the structured data, such as column descriptions or List name. Column
  400.   descriptions are entered during setup, using QRDBMgr. Other info
  401.   removed from the list can be placed in the USBBS.HLP help file if
  402.   desired. A Data Base has already been setup for the USBBS list, select
  403.   the menu item Edit_a_DB_Setup or press F2 to review the setup. If you
  404.   are not going to use the Darwin USBBS list in your Data Base you can
  405.   delete it with the Delete a Data Base Function. If you are going to
  406.   use the USBBS you will need to obtain and edit a copy. Remove all text
  407.   at the begining and end of the list that isn't in structured in
  408.   columns. When you are ready to import your USBBS list select menu item
  409.   Import_Type_1_DB_Data from the Operations menu. A Dialog box will be
  410.   presented listing available control files, select USBBS.1CL, next
  411.   enter the name of the USBBS list that you want to import. After you
  412.   have imported the list you can select menu item Shell_to_QRDB and
  413.   review the new data base.
  414.  
  415.   To create a Data Base other than the USBBS that was provided. Start by
  416.   determining what fields that you want to be key fields, you can have up
  417.   to 5. Now Press F4 to bring up the Make Type 1 DB Dialog Box. You will
  418.   enter Database Name, Data Base Title, Display Header and Read Level.
  419.   The Data Base title is the title that will be displayed in the QRDB
  420.   main menu. The header will be displayed with each page of data. Read
  421.   level is the minimum user level required for access to the data. Use
  422.   the Tab or Mouse to select fields.
  423.  
  424.   Example:
  425.  
  426.      Database Name      SUPPORT
  427.  
  428.      Data Base Title    Computer Hardware/Software Support
  429.  
  430.      Display Header       Company Name            Phone Number     Remarks
  431.  
  432.      Read Level         1
  433.  
  434.  
  435.   Press OK when done or press enter. Next a Dialog Box will be presented
  436.   for the defining of keys.
  437.                                          Key
  438.     Key                      Key         Position
  439.     Search Prompt            Length      in Line
  440.  
  441.     Phone Number             12          31
  442.     Company Name             5           25
  443.  
  444.   At least one Key must be defined. Key Search Prompt is the Prompt QRDB
  445.   will use to describe the key to the user. Key Length is the length of
  446.   the key and Key Position in Line is the starting column that QRDBMgr
  447.   will use when extracting keys during import. 
  448.  
  449.   After the setup has been completed the function Import_Type_1_Db_Data
  450.   will import your textfile into the data base, the function builds
  451.   indexes and a .DAT file. QRDB limits the width of text imported into
  452.   this type 1 data base to 79 characters. More than one text file of
  453.   identical structure can be imported if necessary.
  454.  
  455.   The import feature can be used to add a chunk to an existing data
  456.   base, it is suggested you backup any existing work before importing
  457.   additional data. QRDBMgr does not check the data you are importing and
  458.   improperly structured input could corrupt the data base.
  459.  
  460. Creating a Type 2 Data Base  ********
  461.  
  462.   A couple of sample Type 2 Data Base files have been provided. To
  463.   review their control files, run QRDBMgr press F2 and select
  464.   either of the .2CL files.
  465.  
  466.   Prior to creating a Type 2 Data Base you should first decide on the
  467.   layout of the data that will be presented to the user. The number of
  468.   lines it will take to display a record and the layout of each line. A
  469.   maximum of 5 lines and a maximum of 5 fields per line are allowed.
  470.   Decide witch fields will be (K)ey fields, input (R)equired Fields or
  471.   Input (O)ptional fields. All Key fields are also input required
  472.   fields. The space used to display fields on a line can't add up to
  473.   more than 80 characters. Space required to display a field is the
  474.   length of the data field + the length of the Data Label + a colon and
  475.   a space between label and data. If not enough space is available
  476.   for the full field of the last record on a line the field will be
  477.   truncated.
  478.  
  479.   Note that the QRDB (L) and (B) functions will use the first key
  480.   assigned for their sort order. Another thing to consider is that the
  481.   QRDB (B)rowse function first displays that first key, then starting at
  482.   the first field in the record it displays fields until 80 characters
  483.   are displayed then goes to the next record. If the Key field displayed
  484.   at the beginning of the line is incountered it is skiped. Spacing used
  485.   by (B)rowse is Field Length plus 2 spaces unless the length or the
  486.   display label is greater than the field length, in which case (B)rowse
  487.   will use the display label length.
  488.  
  489.   When the layout has been planed, press F5 or select Add_a_type_2_DB
  490.   from the menu to bring up the Make Type 2 Dialog Box. Fill in the
  491.   Database Name, Read Write and Edit/Del Security Levels and the Data Base
  492.   Title. Use the Tab or Mouse to select fields.
  493.  
  494.   Example:
  495.  
  496.      Database Name:   AREA408
  497.  
  498.      Security Levels  Read      Write     Edit/Del
  499.                        5         5         100
  500.  
  501.      Data Base Title:  User Generated List of Area Code 408 BBS's
  502.  
  503.  
  504.   Press OK when done or press enter. Next a Dialog Box will be presented
  505.   for the defining the first line of the Data Base. You can have up to 5
  506.   lines. The inputs required to define a line are as follows.
  507.  
  508.  
  509.   Example:
  510.  
  511.  ┌─────  Input  ────────────────────────┐ ┌──────────  Display  ──────────┐
  512.  │(K)ey                                 │ │                         Label │
  513.  │(R)eq                           Field │ │                         Start │
  514.  │(O)pt Prompt                    Length│ │Label                    Column│
  515.    K    Phone Number [XXX-XXXX     8       Phone                     1
  516.    K    City                       25      City                      21
  517.    O    Max Baud                   5       Max Baud                  56
  518.                                    0                                                                       0
  519.  
  520.  
  521.   Up to 5 fields per line can be defined, but only a total of 5 keys in
  522.   the 5 lines are all that is allowed. Remember that the total of fields
  523.   and field labels can't add up to more than 80. Oh also allow for
  524.   spaces between fields and Colons after labels.
  525.  
  526.   Maximum key length is 15 characters if a field longer than 15
  527.   characters is designated as a key only the 1st 15 characters in the
  528.   field will be used in the index.
  529.  
  530.   When you have defined the first line press Alt N or use the mouse to
  531.   select the next line button or you can press enter. When you have
  532.   defined the last line that you want to use Select the Done button.
  533.  
  534.  
  535.   Input Info .......
  536.  
  537.   (K)ey-(R)eq-(O)pt    decide if the field will be a (K)ey field, an input
  538.                        (R)equired Field or an Input (O)ptional field. All
  539.                        Key fields are also input required fields.
  540.  
  541.   Prompt               This is the Prompt QRDB will use when asking for Input
  542.                        or describing the sorted lists that are possible.
  543.  
  544.   Field Length         This is the Maximum length of an entry in this field.
  545.                        If it is a Key field it is also the length of the Key
  546.                        unless the field is longer than 15 characters in
  547.                        which case the Key length is set to 15 characters.
  548.  
  549.   Display Info .....
  550.  
  551.   Label                This is the label placed ahead of the data when the
  552.                        line is displayed, when displayed a colon will be added
  553.                        to the label.
  554.  
  555.   Label Start Column   This is column that the first character in the label
  556.                        will be placed in. When a field is displayed the
  557.                        label is followed by a colon and a space and then
  558.                        the data. Labels are not displayed if the field
  559.                        is empty.
  560.  
  561.  
  562.   The data base can be left empty for user input or a comma delimited
  563.   file of data can be imported into the data base using the Operations
  564.   PullDown Menu item (Read in Type 2 DB Data). Data for import must be
  565.   set up as follows. Each record to be created must contain the same
  566.   number of lines that you have established for display by QRDB. Use a
  567.   comma to identify the end of a field's input. A comma is required for
  568.   every field in the record, including blank fields. Remember not to use
  569.   comma's in your data as they would throw things off. See the following
  570.   example.
  571.  
  572. A record from the Example Data Base "User List of Favorite BBS's"
  573.  
  574. │Phone: 408-335-4595   St: Ca    City: Felton
  575. │BBS Name: Mountain Retreat
  576. │MaxBaud: 14400   Size: 660Meg
  577. │Comment: Specializing in Pascal Programming
  578.  
  579. A comma delimited text file for import would look as follows
  580.  
  581. 408-371-7654,Ca,Campbell,
  582. Brown Bag Software,
  583. 2400,,
  584. Brown Bag software support board,
  585. 201-471-6391,Nj,Passaic,
  586. The Passaic/NJPCUG BBS,
  587. 9600,,
  588. Fido Net Node 1:107/559,
  589. 714-824-4328,Ca,Loma Linda,
  590. LLUMC Online Medical Library,
  591. 2400,120Meg,
  592. ,
  593.  
  594.   In summary:
  595.   No blank lines, one line for each line in the record, Comma at the end
  596.   of each field including blank fields. No testing of your input is done
  597.   by QRDBMgr so make sure your input is correct and if you are adding to
  598.   an existing data base you should probably back up the data base before
  599.   starting.
  600.  
  601.   If you are going to import a comma delimited list; select menu item
  602.   Read_In_Type_2_DB_Data from the Operations menu. A Dialog box will be
  603.   presented listing available control files, select the .2CL control
  604.   file for the data base you want to add to, next enter the name of the
  605.   list that you want to import. After you have imported the list you can
  606.   select menu item Shell_to_QRDB and review the new data base.
  607.  
  608.   The import feature can be used to add a chunk to an existing data
  609.   base, it is suggested you backup any existing work before importing
  610.   additional data. QRDBMgr does not check the data you are importing and
  611.   improperly structured input could corrupt the data base.
  612.  
  613. Exporting Type 2 Data
  614.  
  615.   QRDB will Export Type 2 DB Data to a Comma delimited file. Output will
  616.   be based on the record structure and will be in the format required
  617.   for import. Or you can format the data thru the use of a control file.
  618.   Control File structure is as follows, You will need a line in the
  619.   control file for each line of record output required. Identify the
  620.   line with the line number preceded by "L" as L1. Then on that line
  621.   identify the fields that are to be placed on the line using a
  622.   combination of Line that the record is found on a Dos Pipe character
  623.   and the position of the field on the line.
  624.  
  625.   Control files must have the Extension .CTL and the same name as the
  626.   Comma delimited Text file being created. Example if WGX1.TXT is the
  627.   name of the text file being created then WGX1.CTL would be the name to
  628.   use for the control file
  629.  
  630.   The following is an example control file. It consists of the one line:
  631.  
  632. L1  2|1 1|1
  633.  
  634.   The above will export the BBS name and Phone number from the example
  635.   "User List of Favorite BBS's" to a comma delimited file. The name and
  636.   phone number will appear on one line in the output. In order to place
  637.   the data on two lines the control file would look as follows
  638.  
  639. L1  2|1
  640. L2  1|1
  641.  
  642.   To export to a comma delimited file, in which records are written one
  643.   to a line, you would use something like the following. The fields can
  644.   be placed in any order required.
  645.  
  646. L1 1|1 1|2 1|3 2|1 3|1 3|2 4|1
  647.  
  648.  
  649. Creating a Type 3 Data Base ********
  650.  
  651.   A sample Type 3 Data Base has been provided. To review it's
  652.   control files, run QRDBMgr and press F2 and select the .3CL file.
  653.  
  654.   As with the type 2 data base you should have a plan as to how you want
  655.   the data to be displayed. Note that the QRDB (L), (M) and (B) functions
  656.   will use the first key assigned for their sort order. Another thing to
  657.   consider is that the QRDB (B)rowse function first displays that first
  658.   key, then starting at the first field in the record it displays fields
  659.   until 80 characters are displayed then goes to the next record. If the
  660.   Key field displayed at the beginning of the line is incountered it is
  661.   skiped. Spacing used by (B)rowse is Field Length plus 2 spaces unless
  662.   the length or the display label is greater than the field length, in
  663.   which case (B)rowse will use the display label length.
  664.  
  665.   The dBase date field is converted to MM/DD/YYYY when displayed. When
  666.   listing by date field order when the date field is a Key field, QRDB
  667.   converts user input from ,MM/DD/YYYY, MM-DD-YYYY, or MM/DD/YY to the
  668.   dBase format YYYYMMDD. If users will be wanting to search for dates
  669.   that are in dBase date fields, it would be a good idea to make the
  670.   date field a Key field as the search function does not do any
  671.   converting.  Look at the chaplin dbase file and help screen for an
  672.   example.
  673.  
  674.   When you have a plan press F6 or select Add_a_type_3_DB from the menu
  675.   to bring up the Make Type 3 Dialog Box. Fill in the Name of the .DBF
  676.   file you are going to use. If the dBase file is not in the QRDB
  677.   directory you will need the Full Path Name. A minor problem created by
  678.   the Full Path Name is if the database is passed to another system the
  679.   dBase file must be placed in a directory with the identical name, not
  680.   a problem if the database is used on one machine. Next input Security
  681.   Levels and the Data Base Title. Use the Tab or Mouse to select fields.
  682.  
  683.   Example:
  684.  
  685.     .DBF file Name:    CHAPLIN.DBF  (or C:\dBase\Chaplin.Dbf)
  686.  
  687.     Read Security Level:   1
  688.  
  689.     Data Base Title:     A data base of Chaplin movies
  690.  
  691.   Press OK when done or press enter. Next a Dialog Box will be presented
  692.   for the defining the layout of the dBase data on the screen.
  693.  
  694.   Example:
  695.  
  696. ╔═[■]═══════════════════════ Type 3 Db  Fields  ════════════════════════
  697. ║ ┌─ dBase Field ───┐ ┌────────── QRDB Handling Instructions ──────────┐
  698. ║ │                 │ │(N)/A                                           │    ║
  699. ║ │                 │ │(O)pt                                           │    ║
  700. ║ │                 │ │(R)eq                                           │    ║
  701. ║ │Name      Typ Len│ │(K)ey  Display Label                   Line Col │    ║
  702. ║
  703. ║  TITLE      C  30      O     Title                           1    1
  704. ║  COMPANY    C  15      O     Company                         1    38
  705. ║  RELEASE_D  D  10      K     Released                        4    1
  706. ║  DIRECTOR   C  30      O     Director                        3    1
  707. ║  WRITER     C  30      O     Writer                          3    38
  708. ║  FEETLENGT  N  5       N                                     0    0
  709. ║  FEET_SHOT  N  6       N                                     0    0
  710. ║  REELS      N  4       N                                     0    0
  711. ║  MINUTELEN  N  3       N                                     0    0
  712. ║  START_DAT  D  10      N                                     0    0
  713. ║  END_DATE   D  10      N                                     0    0
  714. ║  ACTOR      C  30      O     Actor                           2    1
  715. ║  ACTRESS    C  30      K     Actress                         2    38
  716. ║  SUPPORT    M  10      O     Support Memo                    5    1
  717. ║  MUSIC      M  10      O     Music Memo                      5    26
  718. ║  CREDITS    M  10      O     Credits Memo                    5    52
  719. ║
  720.  
  721.  
  722.  
  723.   dBase Field Info .......
  724.  
  725.                        The dBase field Name, Type and Length are
  726.                        displayed as an aid in working out the Handling
  727.                        info required by QRDB.
  728.  
  729.   QRDB Handling Info .......
  730. ║ │                 │ │(N)/A                                           │    ║
  731. ║ │                 │ │(O)pt                                           │    ║
  732. ║ │                 │ │(R)eq                                           │    ║
  733. ║ │Name      Typ Len│ │(K)ey  Display Label                   Line Col │    ║
  734.  
  735.  
  736.  (N)/A-(O)pt-(R)eq-    Decide if the field will be a (K)ey field, a (D)isplay
  737.               (K)ey    Field or a (N)ot Required Field. Fields coded (N)
  738.                        are not used by QRDB. Memo fields must be coded (O)
  739.                        or (N), they can NOT be a key field. In the example
  740.                        the fields SUPPORT, MUSIC and CREDITS are memo
  741.                        fields.
  742.                        A numeric field as a key can have problems
  743.                        indexing. Depending on how the key field was
  744.                        input. dBase, dBuddy or QRDB. Don't use a numeric
  745.                        field as a key unless all input is via one
  746.                        system.
  747.  
  748.   Display Label        This is the Label QRDB will use when displaying the
  749.                        associated field data.
  750.  
  751.   Line                 This is the line that the Label and the Field data
  752.                        data will be placed on when QRDB is displaying the
  753.                        data.
  754.  
  755.   Col                  This is column that the first character in the label
  756.                        will be placed in. When a field is displayed the
  757.                        label is followed by a colon and a space and then
  758.                        the data. Labels are not displayed if the field
  759.                        is empty.
  760.  
  761.   After the above Setup is complete go to the operations menu and Build
  762.   the Type 3 DB Index. You must Build indexes even if you are starting
  763.   with a empty database. If ever changes are made to the .Dbf database
  764.   files outside of QRDB you will have to repeat this Build function.
  765.   This function can be time consuming, I just indexed a 39,945 record
  766.   dBase file. The .dbf file size is 5073k and the setup uses 3 key
  767.   fields. Indexing on a 386sx 20Mz machine took 15 Hours. As a
  768.   comparison, indexing a file of 2,348 records that had 2 key fields and
  769.   a dBase .dbf file size of 761k took less than 2 minutes. The increase
  770.   in time required for the Build process is not linear as you can see.
  771.  
  772.   If you would like to use the type 3 data base, let's say for it's Memo
  773.   display capability and don't use a dBase compatable Data Base program.
  774.   You can use the Shareware program dBuddy to create the required files.
  775.   dBuddy (Data Base Buddy) is a dBase tool, it will build dBase III or
  776.   IV compatable Dbf and .Dbt files, either empty dBase files or it can
  777.   extract data from text files. dBuddy will Export to character
  778.   delimited files or text files, memo's are also exported. dBuddy is
  779.   available on Mountain Retreat 1:216/506, 408-335-4595. It can be
  780.   Freq'd under the magic name dBuddy.
  781.  
  782.   When used to create a new type 3 setup the copy function will copy and
  783.   create a empty .dbf file. QRDBmgr does not create associated memo
  784.   files and complains that they are missing, not a problem, as QRDB will
  785.   create the memo files the first time a memo is added.  The empty file
  786.   can be replaced with a file containing data as long as the fields are
  787.   an exact match.
  788.  
  789.   Disclaimer agreement
  790.  
  791.     Users of QRDB and QRDBMGR must except the following disclaimer
  792.     agreement:
  793.  
  794.     QRDB and it's utilities are provided AS IS. The Author makes no
  795.     Warranty of any kind, expressed or implied. In addition THE AUTHOR
  796.     ASSUMES NO LIABILITY FOR DAMAGES WHICH MAY RESULT WHICH MAY RESULT
  797.     FROM THE USE OF QRDB, QRDBMGR or associated utilities.
  798.  
  799.    History
  800.  
  801.     Version 1.00    Initial Release
  802.     Version 1.01    Added a Main Menu help function
  803.     Version 1.02    Added a type 2 data import function and fixed
  804.                     a bug in the type 3 data dase setup functions
  805.     Version 1.03    Changed screens and added local mode default.
  806.     Version 1.04    MultiNode support added
  807.     Version 1.05    Beta Release switched to use of DorInfo1.Def
  808.                     in order to make the door useable on more systems.
  809.     Version 1.06    Release of DorInfo1.Def version
  810.     Version 1.07    Added support for dBase III and dBase IV memos
  811.                     Added support for dual word searches
  812.     Version 1.08    Improved dBase searches added dual word searches
  813.                     and speed.
  814.     Version 1.09    Miner changes mainly in docs to aid in setup
  815.     Version 2.0     Changed QRDBMgr to allow the rebuilding of Index
  816.                     files if changes have been made to the dBase
  817.                     .DBF files. Changed QRDB to allow smoother exit
  818.                     from Search functions.
  819.     Version 2.1     Added Browse function to type 2 and 3 database
  820.                     menus. Added a Pause Page Toggle to all types.
  821.                     Stoped scrolling the screen when displaying
  822.                     the number of records searched. QRDB now overwrites
  823.                     the message for a cleaner display.
  824.     Version 2.2     In type 2 database if Read access was not given then
  825.                     then Write access was locked out. QRDB will now
  826.                     allow you to give a user Write access without giving
  827.                     read access.
  828.     Version 2.3     Improved Browse feature. Added capability to a Type 2
  829.                     database to a comma delimited file.
  830.     Version 2.3a    Main menu can be bypass, command line option, fix.
  831.     Version 2.3b    Program now gives full pathname in .Key not found
  832.                     Error message. Moved the Browse function to the
  833.                     top position in the menu. Changed the timer routine
  834.                     I was using, it could possibly lock a system.
  835.     Version 2.4     Added additional drop carrier protection, added
  836.                     escape from data entry feature.
  837.     Version 3.0     Beta version, Major upgrade, adds edit to type 2
  838.                     database and adds Add, Edit and Delete to type 3.
  839.                     User has edit/delete access to any record he creates.
  840.             3.0B    Fixed level problem, a level equal to or greater than
  841.                     the level set in QRDB now has access. Prior to fix
  842.                     user level had to be greater for access.
  843.             3.1     Beta status Removed, Main Menu Help problem fixed and
  844.                     Memo Display bug fixed.
  845.             3.2     Type 3 Browse Bug fix.
  846.             3.3     Cosmetic Bug fix, the word changed is no longer
  847.                     displayed when entering a dBase record.
  848.             3.4     dBase file handler Bug Fix.
  849.             3.5     Fixed disappearing cursor problem,
  850.                     Improved "Build Type 3 DB Index" routines.
  851.                     Added type 3 db to QRDBMgr copy function
  852.                     Fixed problem QRDB had in using a empty type 3 .dbf
  853.             3.6     Beta Version Will now use Door.Sys or DorInfo1.Def
  854.             3.7     Door.Sys version as yet not reported OK
  855.                     Dos 6 NO GO fixed.
  856.             3.7a    Beta Status removed, Documentation change only.
  857.             3.8     Type 3 Bug Fix
  858.             3.9a    Fixed linecount problem and problem of two keys
  859.                     being left at times, when a keyfield was edited.
  860.                     The new key and the old key both pointing to the
  861.                     same record.
  862.             3.9b    The routine I was using to check for adequate memory
  863.                     did not work properly on all systems. I have removed
  864.                     it from the program.
  865.  
  866.  
  867.     QRDB is ShareWare, a $25 registration fee is required. When you
  868.     register send me a 65 character message of your choice. You will be
  869.     sent a new QRDB.KEY file. Your 65 character message will replace the
  870.     following line in the QRDB menu.
  871.  
  872.   ╠════════════════════════════════════════════════════════════════════════╣
  873.   ║      QRDB Door - Mt. Retreat Software - Support BBS (408)335-4595      ║
  874.   ╚════════════════════════════════════════════════════════════════════════╝
  875.     In addition this new Key will prevent the QRDBMGR from displaying
  876.     it's startup message.
  877.  
  878.  
  879.     If you decide to continue useing QRDB after a 90 day trial period
  880.     you are expected to register. This is a one time registration your
  881.     key will work with all revisions.
  882.  
  883.     Please send your registration fee to:
  884.  
  885.              John Jamieson
  886.              Mountain Retreat Software
  887.              555 Buckeye St.
  888.              Felton Ca, 95018
  889.  
  890.     For support contact:
  891.  
  892.              Fidonet 1:216/506
  893.              Internet John.Jamieson@f506.n216.z1.FIDONET.ORG
  894.              BBS phone (408)335-4595
  895.              Voice (408)335-4672
  896.  
  897.  
  898.  
  899.  
  900.