home *** CD-ROM | disk | FTP | other *** search
/ Liren Large Software Subsidy 7 / 07.iso / c / c160 / 1.ddi / DOC / BROWSE.DOC < prev    next >
Encoding:
Text File  |  1990-07-25  |  21.4 KB  |  627 lines
  1.   
  2. Note for Code Base Developer
  3.  
  4.      This documentation can be used by the developer to assist in
  5. creating end user documentation.  This documentation was made with
  6. reference to a particular implementation of the browse routines.
  7. This implemenation can be seen in the file EXAMPLES\E4BROWSE.C.
  8.  
  9.   
  10.   
  11. BROWSE USER'S GUIDE  
  12.   
  13.   
  14. Contents  
  15.   
  16.      Learning Browse  
  17.  
  18.           Introduction  
  19.           Manual Conventions  
  20.           Basic Terms and Operations  
  21.           Getting Started  
  22.   
  23.      Browse Reference  
  24.  
  25.           Introduction  
  26.           Entry Areas  
  27.           Menu Selections  
  28.           Scrolling
  29.           Help                     
  30.           Modify Menu  
  31.           Add Menu
  32.           Position Menu
  33.           Find Menu
  34.           Edit/Browse Switch
  35.           Exiting Browse  
  36.   
  37.      Appendices  
  38.  
  39.           Appendix A - Compatibility              
  40.           Appendix B - Multiuser Requirements     
  41.           Appendix C - Error Messages  
  42.           Appendix D - Summary of Commands  
  43.   
  44.   
  45.  
  46. LEARNING BROWSE  
  47.   
  48.      Browse allows the user to easily scan through a database to
  49. modify and add records.  The user can search for given values and   
  50. reposition to any record in the database.  The switch between the 
  51. browse and edit screens is a single keystroke.  The ordering of the
  52. database records can be altered to reflect any index file that has   
  53. been specified.
  54.  
  55.      All levels of users, from the novice to the veteran, will find
  56. Browse easy to learn and use.  
  57.   
  58.      First time users should read the initial section, on Learning
  59. Browse, to understand the basic terms and operations of Browse. 
  60. The second section, on The Browse Editor, explains how to use the  
  61. browse and edit screens for entering and looking at data.
  62.  
  63.  
  64.  
  65. Manual Conventions 
  66.  
  67.      Some keys or key combinations are represented as one or
  68. two words with angle brackets around them.
  69.  
  70. Examples:
  71.  
  72.     Key            Description 
  73.  
  74.     <Esc>          Represents the <Esc> key. 
  75.  
  76.     <Ctrl Home>    Represents holding down the <Ctrl> key and
  77.                    pressing the <Home> key. 
  78.  
  79.     <Shift F1>     Represents holding a <Shift> key and 
  80.                    pressing the <F1> key. 
  81.  
  82.  
  83.  
  84. Basic Terms and Operations 
  85.  
  86.      Understanding the following terms and operations is essential
  87. because they are used throughout Browse.  For easiest understanding,
  88. read them in the order presented. 
  89.  
  90. File 
  91.  
  92.      A file is information which is saved on a computer disk.  
  93. Files have names which identify them.  These names are up to eight
  94. characters long and are optionally followed by a period and a file
  95. name extension which is up to three characters long.  MAILING.DBF
  96. is an example of a file name with the extension ".DBF". 
  97.  
  98. Database 
  99.  
  100.      A database is a special kind of file which stores your data. 
  101. For example, a mailing list database contains the names and 
  102. addresses of people. 
  103.  
  104. Record 
  105.  
  106.      Database information is organized into records.  Each record
  107. in a mailing list database contains information on one person. 
  108.  
  109. Index File
  110.  
  111.      It may be necessary to examine a database in different orders
  112. at different times.  A mailing list database might need to be sorted
  113. by last name sometimes and by address address at others.
  114. It would take a long time to re-sort a large database every time a
  115. new order was required.
  116.  
  117.      Consequently, index files are created to permanently contain 
  118. sorted information.  An index file contains one sort order for one
  119. database.  Because information is already sorted, Browse displays
  120. and locates records quickly using index files.
  121.  
  122. Window 
  123.  
  124.      A window is an area of the screen which is used to display and
  125. modify database information.  Windows are surrounded by a
  126. lined box.  
  127.  
  128. Current Record
  129.  
  130.      The current record is the record at which the cursor is 
  131. displayed.  When several records are displayed in a window, the 
  132. current record may be changed by pressing the <Up> and <Down>
  133. arrow keys.  Pressing <Up> moves the cursor to the previous record
  134. and pressing <Down> moves the cursor to the next record.
  135.  
  136. Menu
  137.  
  138.      A menu is a list of options from which you can select.  Press 
  139. <Enter> when you have the menu you want, and the menu's options 
  140. will appear.  The up and down arrow keys change the highlighted
  141. option.  When <Enter> is pressed, the menu's highlighted option is
  142. selected.
  143.  
  144. Entry Area 
  145.  
  146.      When information is typed in Browse, it is typed into the
  147. active entry area.  The active entry area is highlighted and 
  148. contains the cursor.  Pressing <Enter> changes the active entry 
  149. area to the next entry area.  When there are no more entry areas
  150. on the screen, pressing <Enter> enters the information.
  151.  
  152. Command Entry
  153.  
  154.      All Browse commands are initiated by pressing either a single key
  155. or a key combination.  For example, pressing T or <ALT T> initiates the
  156. Top command.  All the Browse commands can be initiated by pressing the
  157. appropriate letter, or by pressing the letter along with the <ALT> key.
  158.  
  159.      Some commands gain access to a menu and others request additional
  160. information.  Finish the command by selecting a menu option or
  161. entering additional information before initiating a new command.
  162.  
  163. Escape Key
  164.  
  165.      Pressing the <Esc> key either cancels or aborts an initiated, but
  166. not completed, command or menu option.
  167.  
  168.  
  169.  
  170. Getting Started
  171.  
  172.      Browse can be started with a database file name along with zero
  173. or more index file names as parameters.  The files used by BROWSE
  174. are dBASE compatible.  For example, BROWSE will edit a dBASE database
  175. with a dBASE index file.
  176.  
  177. Syntax:   BROWSE Database_File [Index_File] [Index_File] ...
  178.  
  179. Examples:
  180.  
  181.      1.   BROWSE MAILING.DBF
  182.      2.   BROWSE MAILING.DBF NAMES.NDX ADDRESS.NDX
  183.  
  184.      If no indexes are specified, the ordering of the records is the
  185. ordering in which they were entered (record number ordering).  With
  186. one or more indexes specified, the master index becomes the last
  187. index specified after the database file.  Note that the extensions do
  188. not need to be given.  Browse assumes that the first argument is the
  189. database (.dbf) file, and the other arguments (if given) are the 
  190. index (.ndx) files.  The master index can be changed from within browse.
  191.  
  192.  
  193.  
  194. BROWSE REFERENCE
  195.  
  196.      Browse may be used for browsing and editing a database, and to
  197. select index files for sorting and searching.
  198.  
  199.      The screen consists of a menu along the top of the screen, with
  200. the majority of the window going towards the displaying of the database,
  201. according to the sorted index.
  202.  
  203.      Once the database is displayed, records can be added, modified
  204. or deleted.  Records can also be located quickly by using index
  205. files or by scrolling.
  206.  
  207.  
  208.  
  209. Entry Areas
  210.  
  211.      When information is typed in Browse, it is typed into an Entry Area.
  212. For example, when modifying a record in the database, there will be one
  213. Entry Area for each piece of information to be entered.
  214.  
  215.      Entry Areas are not always associated with a database record.  For
  216. example, an Entry Area appears after the Find command is initiated.
  217.  
  218.      There are several special command keys which facilitate the entering
  219. of information into an Entry Area.
  220.  
  221.      Command Key     Effect
  222.  
  223.      <Ins>           Flips between Insert Mode and Replace Mode.  In 
  224.                      Replace Mode, the character typed replaces the 
  225.                      character under the cursor; in Insert Mode, the
  226.                      character typed is inserted before the character
  227.                      under the cursor.  When in Insert Mode, the cursor
  228.                      is slightly larger.
  229.  
  230.      <Del>           Deletes the character under the cursor.
  231.  
  232.      <Backspace>     Deletes the character to the left of the cursor.
  233.  
  234.      <Home>          Moves the cursor to the first character position
  235.                      in the Entry Area.
  236.  
  237.      <End>           Moves the cursor to the end of the entered 
  238.                      information.
  239.  
  240.      <Left>          Moves the cursor one position to the left.
  241.  
  242.      <Right>         Moves the cursor one position to the right.
  243.  
  244.      <Ctrl Y>        Deletes all the Entry Area characters under and to
  245.                      the right of the cursor.
  246.  
  247.      The following commands are used when entering information into a
  248. group of Entry Areas:
  249.      
  250.      Command Key     Effect
  251.  
  252.      <Enter>, or     Move to the next Entry Area.  If there is no next
  253.      <Tab>           Entry Area, then the group of Entry Areas are entered.
  254.  
  255.      <Shift Tab>     Move to the previous Entry Area.
  256.  
  257.      <Ctrl Home>     Move to the first Entry Area.
  258.  
  259.      <Ctrl End>      Move to the last Entry Area.
  260.  
  261.      <Ctrl W>, or    Enter the group of Entry Areas.  This is like pressing
  262.      <Ctrl E>        <Enter> when on the last Entry Area
  263.  
  264.      <Esc>           Abort the changes made in the Entry Areas.  The exact
  265.                      effect of aborting will be determined by the
  266.                      particular group of Entry Areas.
  267.  
  268.      <Up>            Move to the previous Entry Area.
  269.                     
  270.      <Down>          Move to the next Entry Area.
  271.  
  272.  
  273. Menu Selections
  274.  
  275.      Menus are used throughout Browse to choose from a list of available
  276. choices.  When <Enter> is pressed, the highlighted choice is selected.
  277. Two types of menus exist in Browse.  The first menu is present when Browse 
  278. is initiated.  For this menu, the following keys may be used to change  
  279. the highlighted choice:
  280.  
  281.      Key       Effect
  282.  
  283.      <Left>    The highlighted choice moves one to the left.
  284.  
  285.      <Right>   The highlighted choice moves one to the right.  
  286.  
  287. All other menus use the following keys to change the highlighted choice:
  288.  
  289.      Key       Effect
  290.  
  291.      <Up>      The highlighed choice moves up one.
  292.  
  293.      <Down>    The highlighed choice moves down one.
  294.  
  295.      <Home>    The top option becomes the highlighted choice.
  296.  
  297.      <End>     The bottom option becomes the highlighted choice.
  298.  
  299.      <Esc>     Aborts the menu.
  300.  
  301.      A - Z     Pressing a letter or number highlights the next available
  302.                option in the menu beginning with the character pressed.
  303.  
  304.  
  305. Scrolling
  306.  
  307.      Scrolling allows the user to browse through the database records.
  308.  
  309.      All scrolling is done relative to the current record.
  310.  
  311. Page Down (Press <PgDn>)   
  312.  
  313.      The Page Down command scrolls down one window of records.  If the
  314. window contains one record, the next record will be displayed.  If the
  315. window contains twenty records, the top record of the new window will
  316. contain the record after the last record of the old window screen.  If
  317. all the records fit within the window, the Page Down command will cause
  318. the cursor to position itself at the last record.
  319.  
  320. Page Up (Press <PgUp>)
  321.  
  322.      The Page Up command scrolls up one window of records; it has the 
  323. opposite effect of the Page Down command.
  324.  
  325. Down Arrow (Press <Down>)
  326.  
  327.      The Down Arrow command scrolls forward one record.
  328.  
  329. Up Arrow (Press <Up>)
  330.  
  331.      The Up Arrow command scrolls backwards one record.
  332.  
  333. Top (Press T)
  334.  
  335.      The Top command scrolls up to the first record.
  336.  
  337. Bottom (Press B)
  338.  
  339.      The Bottom command scrolls down to the last record.
  340.  
  341.  
  342.      The selected index file affects scrolling as it determines the 
  343. "first", "next", "previous", and "last" record.
  344.  
  345.  
  346.  
  347. Help (Press H)
  348.  
  349.      The Help option is one of the menu choices given in the main menu.
  350. When Help is selected, a window pops up which gives command keys which
  351. can be pressed.  Each command key corresponds to an option which could
  352. be selected from a menu.  Refer to Appendix F for a list of the
  353. command keys.
  354.  
  355.  
  356.  
  357. Modify Menu 
  358.  
  359. Modify Record (Press M)
  360.  
  361.      The Modify Record command is used to modify the current record.
  362.  
  363.      Press <Enter> until the active entry area corresponds to the 
  364. information to be modified.  Then complete the modification press 
  365. <Ctrl E> or <Ctrl W>.
  366.  
  367.      If <Esc> is pressed while modifying a record, the modifications 
  368. of the entire record are aborted.
  369.  
  370.   Pressing another command key using the <Alt> key also completes the
  371. modification.  In addition, it will initiate the command corresponding to
  372. the character entered.
  373.  
  374.  
  375. Delete Record (Press D)
  376.  
  377.      The Delete Record command flags the current record for deletion.
  378. An asterisk is displayed by the record to indicate that it is marked for
  379. deletion.  Note that the records are not actually removed and that
  380. a serparate program or utility must be used to actually remove the records.
  381.  
  382.  
  383. Undelete Record (Press U)
  384.  
  385.      The Undelete Record command removes the record deletion mark.  This
  386. reverses the effect of the Delete Record command.
  387.  
  388.  
  389. Add Blank (Press A)
  390.  
  391.      The Add Blank command takes a blank record and appends it to the 
  392. end of the database file.  After executing the command, the entry areas
  393. are highlighted.  Press <Enter> to move through the entry areas, and when
  394. you press the last <Enter> or <Ctrl W>, the record is added and 
  395. displayed in its proper position in the sorted index.
  396.  
  397.      If <Esc> is pressed while adding a record, the Add Blank command
  398. aborts and no record is added.
  399.  
  400.      Hint :    Pressing <ALT A> when adding a record adds the record and
  401.                starts adding a new record.  This is useful when adding
  402.                several records in a row.
  403.  
  404.  
  405. Add Copy (Press C)
  406.  
  407.      The Add Copy command is the same as the Add Blank command except
  408. the Add Copy command starts with a copy of the current record.
  409.  
  410.      
  411.  
  412. Position Menu 
  413.      
  414. Record (Press R)   
  415.  
  416.      The Record command locates a record by its record number.  Records
  417. are numbered in the order they were added.  For example, if there are 5
  418. records in the database, the last record added is record number 5.
  419.  
  420.      After initiating the Record command, enter the number of the 
  421. record to be located.  If the record number entered exists, the current
  422. record will become the entered record number.  The total number of
  423. database records will be displayed at the bottom of the screen.
  424.  
  425.      If <Esc> is pressed rather than entering a record number, the
  426. current record is not changed.
  427.  
  428.      If the number entered is negative, the current record will not
  429. change.  If real numbers are entered, the Record number will only look
  430. at the whole part of the number, not the fraction (ie. will truncate
  431. the remainder).  Record numbers that are out of range will not cause
  432. the current record to change.
  433.  
  434.  
  435. Top (Press T)
  436.  
  437.      After initiating the Top command, the current record will become
  438. the top record, according to the sort of the index file.
  439.  
  440.  
  441. Bottom (Press B)
  442.  
  443.      After initiating the Bottom command, the current record will
  444. become the bottom record, according to the sort of the index file.
  445.  
  446.  
  447.  
  448. Find Menu 
  449.  
  450.      To locate a record quickly, the Find command uses an index file.
  451. If the database has several index files, the Select Record Ordering
  452. Index command determines which index file is used.  The Select Record
  453. Ordering Index command also determines the order in which records are
  454. displayed.
  455.  
  456. Find (Press F)   
  457.  
  458.      The Find command locates a record using an index file.
  459.  
  460.      After initiating the Find command, a Find box appears in the
  461. middle of the screen.  The index being used is given on the first line.
  462. A prompt requesting the find information appears on the next line.  
  463.  
  464.      The information to be entered corresponds to the index file.
  465. For example, an index files might order a database according to
  466. the name of an individual.  In this case, you would enter the
  467. name of the person to search for.  It is not necessary to enter
  468. the complete search information or the completely correct 
  469. search information.  Browse will find the closest match it can.
  470.  
  471.      After the Find command is complted, the found record 
  472. becomes the current record.
  473.  
  474. Example:
  475.  
  476.    Entered Find Information --
  477.  
  478.         John
  479.  
  480.    Names in the database --
  481.         
  482.         Jackson
  483.         Kerns
  484.         Matheson
  485.  
  486.    The record with "Kerns" becomes the current record.  This is the name
  487. after 'John'.
  488.  
  489.  
  490. Select Record Ordering Index (Press S)
  491.  
  492.      The Select Record Ordering Index command accesses a menu containing
  493. the index files of the database and the option "Record Number Ordering".
  494.  
  495.      Example Menu Contents:
  496.  
  497.           1.   Record Number Ordering
  498.           2.   NAME.NDX
  499.  
  500.           In this case, the database only has the index file "NAME.NDX".
  501.  
  502.      The menu option corresponding to the current ordering option is 
  503. initially selected.  For example, if "NAME.NDX" was last selected, the 
  504. next time the menu appears, it will be highlighted.
  505.  
  506.      If "Record Number Ordering" is selected, the database will be
  507. displayed in the order the records were intially entered.  In addition, 
  508. the first index file on the Select Record Ordering Index menu will be used 
  509. by the Find commands.
  510.  
  511.      If an index file is selected, the database will be displayed in
  512. the order determined by the index file.  In addition, that index file
  513. will be used by the Find command.
  514.  
  515.  
  516. Edit/Browse Switch
  517.  
  518.      The Edit/Browse option allows the user to switch between edit mode and 
  519. browse mode.  In the browse mode, the user can look at many records at one 
  520. time and move freely among them.  Note that if all of the record does not fit
  521. in the window, only a subset will be displayed.  To see more of the records, you
  522. must select the Edit option.  Under the Edit option, only one record is 
  523. displayed at a time.  The same commands are available with the edit option as
  524. with the browse option.
  525.  
  526.  
  527. Exiting Browse
  528.  
  529.      The Exit command (Press X) is used to exit Browse.  Changes to the 
  530. contents of the database and index files were made immediately after each
  531. record was modified or added.  The records marked for deletion will 
  532. remain marked and continue to exist in the database until the database 
  533. file is packed.  Consequently, the Exit command has no effect on the
  534. changes made to the database and index files.
  535.  
  536.  
  537.  
  538. APPENDICES
  539.  
  540.  
  541. Appendix A - Compatibility
  542.  
  543.      Browse is a self contained database program.  However, its
  544. database and index files are compatible with dBASE III, dBASE III PLUS
  545. and dBASE IV.
  546.  
  547.      Some dBASE databases contain "memo fields".  Browse ignores "memo
  548. fields".
  549.  
  550.  
  551. Appendix B - Multiuser Requirements
  552.  
  553.      Any network which supports MS-DOS 3.0 (or higher) file sharing
  554. conventions.
  555.  
  556.      Examples:
  557.  
  558.      1.   Novell Advanced Net Ware.
  559.      2.   IBM PC Network Program.
  560.  
  561.      Browse will detect the presence of the network and automatically
  562. use its multiuser capabilities.  This means two workstations, both using
  563. Browse, can use the same database and index files at once.
  564.  
  565.  
  566. Appendix C - Error Messages
  567.  
  568.  
  569. 1.  120  Opening File
  570.  
  571.     This problem is usually caused by specifying a file which does
  572.     not exist.  If an improper .dbf file is specified, Browse is
  573.     terminated, and control is returned to DOS.  If improper index
  574.     files are specified, the rightmost .ndx file which is correctly
  575.     specified is used as the master index.  If all the index files
  576.     are incorrectly specified, record number ordering will be used.
  577.           
  578. 2.  Illegal Date 
  579.  
  580.     An illegal date error occurs when a date is entered that does not
  581.     have the proper month specification.  The user must correctly change the
  582.     month to a proper one, or press <Esc> to abort the entry.
  583.  
  584. 3.  Record Not Found
  585.  
  586.     An error message is given when the find information was not found.
  587.     This occurs only if there are no records after the find information.
  588.  
  589.  
  590. Appendix D - Summary of Commands
  591.  
  592.  
  593.      The commands can also be initiated by pressing the command key
  594. along with the <ALT> key.
  595.  
  596.      Command Name               Command Key     Description
  597.     
  598.      Add Blank                      A           Add a blank record
  599.      Bottom                         B           Move to the bottom 
  600.                                                 database record
  601.      Add Copy                       C           Add a record by copying
  602.                                                 the current record.
  603.      Delete Record                  D           Mark the current record
  604.                                                 for deletion
  605.      Edit                           E           Switch to the edit
  606.                                                 screen if possible
  607.      Find                           F           Find a record
  608.      Help                           H           Display the help screen
  609.      Modify Record                  M           Modify the current record
  610.      Record                         R           Enter a record to move to
  611.      Select Record Ordering Index   S           Select a record ordering
  612.                                                 index
  613.      Top                            T           Move to the top database
  614.                                                 record
  615.      Undelete Record                U           Remove the deletion mark
  616.                                                 from the current record
  617.      Browse                         Z           Switch to the browse
  618.                                                 screen if possible
  619.      Exit                           X           Exit
  620.      Page Up                     <Pg Up>        Move up one screen of
  621.                                                 records
  622.      Page Down                   <Pg Dn>        Move down one screen of
  623.                                                 records
  624.      Up                            <Up>         Move to the next record
  625.      Down                         <Down>        Move to the previous record
  626.  
  627.