home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 511.lha / kd_freq.library_v3.00 / fr_user.doc.pp / fr_user.doc
Text File  |  1991-06-07  |  39KB  |  964 lines

  1.                           kd_freq.library  3.00
  2.  
  3.                      File Requester User Documentation
  4.                      ---------------------------------
  5.  
  6.                            By:  Khalid Aldoseri
  7.                            --------------------
  8.  
  9. A File Requester is used to select a file name from the existing files on a
  10. system, or to enter a new file name.  This file requester (FR) supports all
  11. normal features in a FR plus a lot of special features as desribed below.
  12.  
  13. ------------------------------------------------------------------------------
  14.                     BASIC FILE REQUESTER OPERATION
  15. ------------------------------------------------------------------------------
  16.  
  17. The File Requester has three essential parts for its operation:  The Path
  18. gadget, the File gadget and the File List:
  19.  
  20. The Path gadget contains the path to the currently displayed directory.  You
  21. can enter any directory name there directly if you like by clicking in it and
  22. editing the text there.  The FR also changes the Path name in many cases.
  23.  
  24. The File gagdet contains the currently selected file.  You can manually edit
  25. the filename by clicking in it and editing the text.
  26.  
  27. The File List is a list of file names that covers a major portion of the FR
  28. display.  This displays the contents of the directory in the Path gadget.
  29. This contains both directories and file names.  Every time you select a new
  30. directory the File List will start displaying the contents of that directory
  31. as it reads it from the device that directory exists on.  As this is
  32. happening, the FR will tell you how many files/dirs it has found so far in the
  33. status line at the bottom of the FR.  Once the FR has finished reading the
  34. directory, it will redisplay the File List starting with directories first
  35. and files second.
  36.  
  37. Notes:
  38.  
  39. - The FR stays 'live' while reading the directory, i.e. you can abort the
  40.   directory read at any time by selecting a new directory.  You can also
  41.   scroll through the file list or resize the window and the FR will keep on
  42.   reading the directory.
  43.  
  44. - The ':' (colons) in the 'Files: nnn  Dirs: nnn' display do not appear while
  45.   the directory is being read.  When they do show up, that means that the FR
  46.   is done reading in the directory.
  47.  
  48.  
  49. The File List Display:
  50. ----------------------
  51.  
  52. The File List display contains the following information:
  53.  
  54.     test.file  *         11381  09-Dec-89  11:50    ----rwed
  55.        |       |           |        |        |         |
  56.     filename   |          size     date     time   protection
  57.               filenote                                bits
  58.                marker
  59.  
  60. If the entry is a directory, it will be displayed in a different color and it
  61. will display '-dir-' instead of the file size.  Read the 'Window Resizing'
  62. section for more details on the File List display.
  63.  
  64. The job of the File List is to allow you to select an entry from the List.  To
  65. do that, just click on an entry.  That will have one of the following effects:
  66.  
  67. a. If the entry is a file:
  68.    The FR will copy that file's name into the File gadget and move the marker
  69.    to that entry.  If the file has a file note attached to it (i.e. it has a
  70.    filenote marker) then the file's filenote is displayed in its place as long
  71.    as you hold down the mouse button.
  72.  
  73.    If you double-click on the file entry, this will select that file and
  74.    immediately 'ok' the FR and exit it.
  75.  
  76. b. If the entry is a directory:
  77.    The FR will clear the File List and start displaying the contents of the
  78.    selected directory.
  79.  
  80.  
  81. The File List can be in normal or inverted colors.  This is intended to create
  82. a visual difference for two different functions, like normal for load, and
  83. inverted for save.
  84.  
  85.  
  86. File List Modes:
  87. ----------------
  88.  
  89. The File List can also contain other information.  Clicking the right mouse
  90. button while the pointer is on the File List area will cycle through one of
  91. three modes:
  92.  
  93.   a.  Normal mode:  File List shows the selected directory.
  94.   b.  Device list:  File List shows the currently mounted devices by
  95.                     their  volume names.
  96.   c.  Assign list:  File List shows all assigns.
  97.  
  98. If you return to the Normal mode by clicking several times, then the directory
  99. displayed previously will show up immediately.  Note that if you had toggled
  100. the mode before the directory was completely read in by the FR, it will not be
  101. complete when you get back to it and the FR will re-read it.
  102.  
  103. Notes:
  104.  
  105. - The File List display is updated when the FR is done reading the directory.
  106.   However, if the user clicks on any file before that, the FR will not update
  107.   the display when it is done reading the directory.  The user has to click
  108.   on the prop gadget or move the list around and the FR will update the
  109.   display.
  110.  
  111. - If you insert a disk into a drive that has been selected in the Path
  112.   gadget the disk's directory will automatically be read and displayed.
  113.  
  114. - If the current disk is removed from the drive, the FR will clear the file
  115.   list and bring up the device name (not the old disk name) in the Path
  116.   gadget.  This means that you can take a disk out of the drive and insert
  117.   a new one and the FR will keep up with you if the current device is the
  118.   one that you are using.  This only works for devices DF0: to DF3:.
  119.  
  120.  
  121. The Path:
  122. ---------
  123.  
  124. The Path is the string contained in the Path gadget.  It shows the name of the
  125. currently selected directory.  This can be changed in many ways:
  126.  
  127. a. Direct entry:
  128.    You just click in the gadget to activate it and edit it normally.  Hit
  129.    return when you're done with editing it so that the FR will start reading
  130.    the directory you selected.  If you enter the name of an actual file into
  131.    the Path gadget, then the name will be split into its path and filename
  132.    components and handled accordingly.
  133.  
  134.    If the selected directory does not exist the FR will ask you whether you
  135.    want to create it.  Read 'Create Directory' below for details.
  136.  
  137. b. File List entry:
  138.    If you click on an entry in the File List that is a child directory of the
  139.    current Path, then that child directory is added to the Path name and that
  140.    directory is displayed.
  141.  
  142. c. Parent:
  143.    If you click on the Parent gadget (up-arrow to the right of the Path
  144.    gadget) then the parent of the current Path is displayed, if it exists.
  145.    This can be clicked several times to go up to the root directory of the
  146.    current device.  You can also use a short-cut to get the root of the device
  147.    by just clicking the _right_ mouse button on the Parent gadget.
  148.  
  149. d. Disk Icons:
  150.    These are disk icons that represent the currently mounted storage devices
  151.    in the system.  If you click on any disk icon with the left mouse button
  152.    the root directory of the selected device will be displayed.  You can
  153.    scroll through the mounted disk list via the 'Disk Scroll Up' and 'Disk
  154.    Scroll Down' arrow gadgets.  (up and down arrows at the top right of the
  155.    window).  These only work if the number of available devices is too big to
  156.    fit in the current window.
  157.  
  158.    If you click on the right mouse button over any disk icon, you will get
  159.    info about the device displayed in the file list area.  The file list is
  160.    not erased from memory, you just have to click on the prop gadget or the
  161.    up or down scroll gadgets and the file list will reappear.
  162.    Note:  If there isn't enough space to display 4 lines in the file list
  163.    area, this function will not work.
  164.  
  165. e. Reset Path Gadget: (the 'Path' text)
  166.    Clicking on the Path: text will restore the contents of both the Path and
  167.    File gadgets to what they were when the FR came up.
  168.  
  169.  
  170. Exiting the File Requester:
  171. ---------------------------
  172.  
  173. You can exit the file requester with either an 'OK', which tells the calling
  174. program that you like what you selected, i.e. the Path/File selected.  Or by
  175. a 'CANCEL' which just aborts the FR.
  176.  
  177. You can OK the FR by:
  178.  
  179.     a. Clicking on the OK gadget.
  180.     b. Double-clicking on a filename.
  181.     c. Typing a filename in the File gadget and hitting return.
  182.  
  183. You can cancel the FR by:
  184.  
  185.     a. Clicking on the Cancel gadget.
  186.     b. Hitting the 'Escape' key.
  187.     c. Closing the FR window by clicking on the close window gadget.
  188.  
  189.  
  190. The File Gadget:
  191. ----------------
  192.  
  193. This is the most important gadget in the FR.  The selected file name is the
  194. contents of this gadget.  You can change the contents of the File gadget by
  195. any of the following ways:
  196.  
  197. a. You just click in the gadget to activate it and edit it normally.  If you
  198.    hit return when you're done editing it, the FR will immediately exit with
  199.    an OK status.
  200.  
  201. b. Clicking on a file in the File List.
  202.  
  203. c. Moving the marker around in the File List.
  204.  
  205. A special feature of this string gadget over other string gadgets is that you
  206. don't really need to click in it to activate it.  This is summarized by the
  207. following points:
  208.  
  209.  - Hitting any alphanumeric key when no string gadget is active appends the
  210.    key to the File gadget and activates it.
  211.  
  212.  - Hitting the DELETE key when no string gadget is active clears the File
  213.    gadget and activates it.  Hitting the Right Amiga-x key clears the File
  214.    gadget without activating it.
  215.  
  216.  - Hitting the TAB key will just activate the File gadget.
  217.  
  218.  - Hitting the BACKSPACE key when no string gadget is active deletes the
  219.    last character in the File string gadget and activates it.
  220.  
  221.  - If the FR is reading the directory, it will not activate the File gadget
  222.    but you can still type into it and edit it using any alphanumeric
  223.    character or any of the above keys.
  224.  
  225.  
  226. Moving Around The File List:
  227. ----------------------------
  228.  
  229. You can move around the File List in many ways.  The major control is the
  230. Prop (proportional) gadget, which represents the position of the currently
  231. displayed files in the File List in relation to the total files in the
  232. selected directory.  You can move around the list by holding down the Prop
  233. gadget with the left mouse button and moving the gadget up and down.
  234.  
  235. You can also you click the right mouse button over the Prop gadget it will
  236. move to the top of the File List, unless it is already at the top in which
  237. case it will move to the bottom of the list.
  238.  
  239. Another way is to use the Scroll gadgets.  These are two gadgets above and
  240. below the Prop gadget.  The Scroll Up gadget (above the Prop gadget) scrolls
  241. the file list up at a slow speed if you click it  with the left mouse button,
  242. or it will scroll the file list down if you click it with the right mouse
  243. button.  If you hold down both buttons at the same time, the right button will
  244. take priority.  The Scroll Down gadget (below the Prop gadget) does the same
  245. as the Scroll Up gadget expect that it moves the list a lot faster and the
  246. mouse button directions are reversed.  Try it, it'll make sense.
  247.  
  248.  
  249. The Marker:
  250. -----------
  251.  
  252. The marker is a small arrow that points to an entry in the File List.  This is
  253. used to control the FR via the keyboard.  The marker is normally not visible
  254. unless you control it in one of the following ways:
  255.  
  256. a. Clicking on any entry in the File List will move the marker to that entry.
  257.  
  258. b. The cursor up/down keys move the marker up/down one entry at a time.
  259.  
  260. c. The shift cursor up/down keys move the marker up/down one page at a time.
  261.    (a 'page' is the number of files that can be shown in the File List area)
  262.  
  263. d. The alt cursor up/down keys move the marker all the way to the top or the
  264.    bottom of the File List.
  265.  
  266. As the marker moves outside the currently visible File List entries, the File
  267. List will be paged up or down to show more entries.
  268.  
  269.  
  270. Moving the marker to an entry will have the following effects:
  271.  
  272. a. If the entry is a file, the name of that file will be copied into the File
  273.    gadget.
  274.  
  275. b. If the entry is a directory name, then the File gadget will be cleared.
  276.    To display that marked directory, hit the cursor right key to enter it.
  277.  
  278.  
  279. Window Resizing:
  280. ----------------
  281.  
  282. The amount of data displayed in the File List depends on the size of the FR's
  283. window.  The FR is resizable by the user.  The resize gadget is invisible, but
  284. it actually occupies the bottom 5 lines across the window.  Just click there
  285. and resize the window.  The whole requester will resize accordingly.
  286.  
  287. Resizing the window horizontally will make space for more information in the
  288. File List to be displayed.  This is based on the following method:  The FR
  289. checks to see the longest file name in the list and it fits in whatever extra
  290. data it can starting with the file date, file time and finally protection bits.
  291.  
  292. There are also three small gadgets at the bottom right corner of the FR that
  293. immediately resize the FR to small, normal, and full screen respectively from
  294. left to right.  This action will also automatically centers the FR in the
  295. screen.  If the FR is already at the requested size, then this request will be
  296. ignored.
  297.  
  298. The FR will always try to come back up where it was previously, and in the
  299. same size.  If it can't do that, it will move/resize to attempt to be as close
  300. as possible to what it was.
  301.  
  302. ------------------------------------------------------------------------------
  303.                              THE RETURN KEY
  304. ------------------------------------------------------------------------------
  305.  
  306. The Return key has so many functions that it is worth devoting a section to
  307. it.  Normally hitting the Return key while a string gadget is active will
  308. 'accept' that gadget and deactive it.  The following is a description of the
  309. effect of the Return key on each string gadget:
  310.  
  311.  
  312. General Return Key Functions:
  313. -----------------------------
  314.  
  315. a. Hitting Shift-Return will activate the File gadget or Path gadget
  316.    alternatively.  The cursor is positioned at the end of the current text in
  317.    the gadget.
  318.  
  319. b. Hitting RightAmiga-Return on any string gadget will just ignore the hit and
  320.    deactivate that gadget.  i.e. if a string gadget was active and you wanted
  321.    to use the keyboard controls, you just hit RightAmiga-Return.
  322.  
  323.  
  324. The Path gadget:
  325. ----------------
  326.  
  327. a. Hitting return when the Path gadget is active tells the FR to start reading
  328.    in a new directory.  (Note that if the directory is the same as the one
  329.    currently displayed and it has not changed since the last time it was read
  330.    the FR will not re-read the directory)
  331.  
  332. b. Hitting Shift-Return when the Path gadget is active will just deactivate
  333.    the Path gadget and activate the File gadget.
  334.  
  335. c. Hitting RightAmiga-Return when the Path gadget is active will only
  336.    deactivate the Path gadget.
  337.   
  338.  
  339. The File Gadget:  (also applies if no string gadget is active)
  340. ----------------
  341.  
  342. a. Hitting Return will OK the requester.
  343.  
  344. b. Hitting Alt-Return will call up Auto-Complete.
  345.  
  346.    Auto-Complete:
  347.    --------------
  348.    If you type the first few characters of a file name into the File gadget
  349.    and hit Alt-Return, the first matching filename from the file list will be
  350.    used to complete the filename in the File gadget.
  351.  
  352. c. Hitting Control-Return in the Extended Select mode will call up Wildcard
  353.    Extended Select.   (Read 'Extended Select' section for details)
  354.  
  355. d. Hitting LeftAmiga-Return will call up the String Search feature.
  356.  
  357.    String Search:
  358.    --------------
  359.    If you type a string in the File gadget then hit LeftAmiga-Return, the FR
  360.    will search through the files currently in the File list for the string
  361.    you specified.  The actual sequence is as follows:
  362.  
  363.    a. all marked files will be unmarked.
  364.    b. the marker will point to each file as it is being searched through.
  365.    c. if the requested string is found in the current file, it will be marked
  366.       and the status line at the bottom will update the marked files count.
  367.    d. this will continue until the last file is searched thru.
  368.  
  369.    Notes:
  370.  
  371.    - The string search is case-insensitive.
  372.  
  373.    - You can abort the search by hitting the right mouse button or the space
  374.      bar.  This will stop the search at whatever stage it got to.
  375.  
  376.    - The search only works correctly with text files so far... binary files
  377.      don't really work.. this will be fixed.
  378.  
  379.    - At the moment, it allocates memory for each file in one chunk, so it may
  380.      fail if the file it too large.  It will only ignore that file and
  381.      continue with the rest of the files.
  382.  
  383.    - This feature works in all modes except when the File List is displaying
  384.      the device or assign list or the Select List.
  385.  
  386.  
  387. e. Hitting Shift-Alt-Return will call up the File Finder feature.  (see the
  388.    'File Finder' section for details.)
  389.  
  390. ------------------------------------------------------------------------------
  391.                             WILDCARD PATTERNS
  392. ------------------------------------------------------------------------------
  393.  
  394. Wildcard Patterns:
  395. ------------------
  396.  
  397. There are two string gadgets that allow you to specify what files to show in
  398. the File List.  These are the 'Show Wildcard' gadget and the 'Hide Wildcard'
  399. gadget.  Both gadgets expect a wildcard pattern (as described below in
  400. 'Supported Wildcard Patterns').
  401.  
  402. As the FR reads a directory's contents, it will apply both wildcards to
  403. control what files it will display.  The Show pattern tells the FR to 'show
  404. only files that match this pattern' and the Hide pattern tells it to 'don't
  405. show files that match this pattern'.  This allows you to specifically select
  406. what files you want to see.
  407.  
  408. Both wildcards default to 'show all files' unless the calling program sets
  409. them to something else.
  410.  
  411.  
  412. Supported Wildcard Patterns:
  413. ----------------------------
  414.  
  415. The supported wildcards in pattern are:
  416.  
  417. 1. Standard AmigaDOS Wildcards:
  418.  
  419.    ?   Matches any single character
  420.    #p  Match any number of occurences of the pattern p
  421.    %   Matches the null string
  422.    ()  Make a group of characters into a single pattern
  423.    |   The OR operator
  424.    '   Disable wildcard interpretation of next character
  425.        (unless it is an extended wildcard as shown below.)
  426.  
  427. 2. Extended Wildcards:
  428.  
  429.    These are wildcards not supported by the standard AmigaDOS
  430.    convention, but expand it to make it more versatile.
  431.  
  432.    'd  Matches any single digit.  (0 to 9)
  433.    'a  Matches any single alpha character. (a to z)
  434.    'n  Matches any single alphanumeric character.
  435.  
  436.  
  437.    For examples of standard wildcard usage look up any AmigaDOS tutorial book.
  438.  
  439.    Examples of extended wildcards:
  440.  
  441.    Pattern     Matching possibilities
  442.    -------     ----------------------
  443.    test'n      test0, test1, test9, testa, testA, testz, testZ
  444.    test'd      test0, test1, test9
  445.    test'a      testa, testA, testz, testZ
  446.    test 'd     test 1, test 2, test 9
  447.    test#'d     test1, test100, test10234
  448.    #'a#'d      a1, ab12, abc1, abc123, adks34234
  449.                (matches any string with some or no alpha characters,
  450.                then some or no digits.)
  451.    #'a'd#'d.c  a1.c, a203.c, 100.c, 1.c, adsdfs931234.c
  452.                (matches any string that starts with some or no alpha
  453.                characters, then at least 1 or more digits, and ends with .c)
  454.  
  455.    Note:  You can use the '*' instead of '#?'.  It will be automatically
  456.           expanded into '#?'.
  457.  
  458.  
  459. Size Wildcards:
  460. ---------------
  461.  
  462. If the first character of the Show wildcard is an equals, greater than, or
  463. less than sign, then that is used to control which files are shown by their
  464. size.  i.e..
  465.  
  466. Show:  "=232"   Shows only files that are 232 bytes in size.
  467. Show:  ">232"   Shows only files that are larger than 232 bytes.
  468. Show:  "<232"   Shows only files that are smaller than 232 bytes.
  469.  
  470. The same applies to the Hide wildcard, only in the opposite manner:
  471.  
  472. Hide:  "=232"   Hide any files that are 232 bytes in size.
  473. Hide:  ">232"   Hide any files that are larger than 232 bytes.
  474. Hide:  "<232"   Hide any files that are smaller than 232 bytes.
  475.  
  476. You can use both the Show and Hide wildcard size features to specify a range
  477. of sizes to show.
  478.  
  479.  
  480. Reset Wildcards Gadget:
  481. -----------------------
  482.  
  483. If you click on the Reset Wildcards gadgets (click on the 'Show' text) both
  484. wildcards will reset to "#?" and "".
  485.  
  486. ------------------------------------------------------------------------------
  487.                               FILE FINDER
  488. ------------------------------------------------------------------------------
  489.  
  490. File Finder searches through all your devices for a file or directory that
  491. matches a wildcard pattern.  It is based on a program called 'Find' by
  492. Larry Phillips and uses Find's data file.  As such, you have to have Find
  493. before you can use this facility.  The Find package is included in its own
  494. arc file.  You should follow Find's documentation and try it out before
  495. trying to use the FR's File Finder.
  496.  
  497. To invoke the File Finder, type a valid wildcard pattern (or just a filename)
  498. into the File string gadget and then hit shift-alt-return.  The file list
  499. will go blank and you will see a counter showing how many files/directories
  500. have been found so far.  
  501.  
  502. Once the search is complete, you will see a list of files/directories in
  503. the file list.  The complete path to each is displayed in the file list.
  504. To select a file, just move the marker to it and hit return, or click on
  505. it.  If you need to see the directory itself, either click on the entry or
  506. move the marker to it and hit the cursor left button.
  507.  
  508. To abort the search, hit the right mouse button or the space bar.  This will
  509. stop the search at whatever stage it got to.
  510.  
  511.  
  512. Notes:
  513.  
  514. - File Finder is only effective when you have a hard disk.
  515.  
  516. - This mode requires that a file called "FindDB:find.codes" exists.  If
  517.   it doesn't, then it won't operate.  This file is generated by a program
  518.   called "UpdateDB" which is part of the Find package.
  519.  
  520. - Using a wildcard like "test#?" is fairly fast, while "#?test" is slower
  521.   because of the nature of the pattern matching logic.
  522.  
  523. - There is a maximum limit of 200 matches.  You will be informed if the
  524.   search is aborted because of too many matches.  You can then use a more
  525.   precise pattern.  E.g. if you use "inf#?" and you get too many matches,
  526.   you might then use "inform#?".
  527.  
  528. - The Extended Select mode does not operate in the Find List mode.
  529.  
  530. - CED Pro uses the right alt/right shift/return combination to invoke the
  531.   editor.  If you have CED Pro running, you should use the left alt/left
  532.   shift/return combination instead.  (both work when CED Pro is not running)
  533.  
  534. - Many many thanks to Larry for allowing me to use Find.  and:
  535.   FIND, Copyright © 1989, by Larry Phillips.
  536.  
  537.   You will need the Find package.  It is included in this package as Find.LZH
  538.   (it contains 3 files, Find, Find.DOC and UpdateDB)
  539.  
  540. ------------------------------------------------------------------------------
  541.                               HELP FACILITY
  542. ------------------------------------------------------------------------------
  543.  
  544. The FR supports two methods of online help.  The first is pointer-relative.
  545. All you need to do is move the pointer on top of something in the FR's window
  546. and hit the F1 key.  As long as you hold down the F1 key you will see a help
  547. message telling you what the right mouse button and the left mouse button do
  548. in this position.  e.g. 'L: do this'  'R: do that'  in this case the left
  549. button will 'do this' and the right button will 'do that.'  If only one entry
  550. is shown, then it relates to the left button.
  551.  
  552. The second method just displays a screen that summarizes all the available
  553. keyboard commands.  To call this up, hit the Shift-F1 key and you will get
  554. that screen.  You can then hit any key to get back to the FR.  You can also
  555. access this via the Help gadget.  Just click on the Help gadget and the Help
  556. screen will show up.  Click on that screen again and the FR will return.
  557.  
  558. If you hit the HELP key, you will get a message telling you to use either F1
  559. or Shift-F1.
  560.  
  561. ------------------------------------------------------------------------------
  562.                              EXTENDED SELECT
  563. ------------------------------------------------------------------------------
  564.  
  565. In some cases, it is necessary (or desirable) to select more than one file
  566. from a single directory.  If the Select List mode (see below) is enabled or
  567. the Extended Select mode is enabled, then the user can mark multiple files
  568. from a single directory for further operation.
  569.  
  570. When this mode is active, there are several ways to mark a file:  (In all
  571. cases, the file itself is shown in inverted video on the screen to show that
  572. it is marked)
  573.  
  574. 1. Clicking on a file (from the file list) while holding down one of the
  575.    shift keys on the keyboard.  (Shift-click)
  576.  
  577. 2. Keyboard methods:
  578.  
  579.    a.  Wildcard Extended Select: 
  580.        -------------------------
  581.        You can mark multiple files by entering a valid wildcard pattern in
  582.        the File string gadget and hitting Control-Return.  This will mark
  583.        all the files in the File List that match the pattern.
  584.        For Example:  #?.c will highlight all files that end with .c
  585.  
  586.    b.  The Cursor Right Key:
  587.        ---------------------
  588.        If the current entry is a file, then hitting the Cursor Right key will
  589.        toggle the file between marked and not-marked.
  590.  
  591.    c.  Alt-Cursor Right and Shift-Cursor Right:
  592.        --------------------------------------
  593.        Alt-Cursor Right clears all marked files.
  594.        Shift-Cursor Right marks all files.
  595.  
  596.  
  597. If there is one or more selected files, the number of files selected will be
  598. shown at the bottom of the file list.
  599.  
  600.  
  601. Note:
  602.  
  603.     The marked files list is not the same as the currently selected file
  604.     (the one in the File gadget.)   The calling program can (if it so wishes)
  605.     differenciate between the two types of files.
  606.  
  607.  
  608. ------------------------------------------------------------------------------
  609.                             THE SELECT LIST
  610. ------------------------------------------------------------------------------
  611.  
  612. The FR can allow the user to select multiple files instead of just one file.
  613. This is accomplished by a 'Select List'.  It is up to the calling program to
  614. decide whether the user is allowed to select multiple files or not.  If the
  615. Select List mode is enabled, two gadgets will show up at the top right corner
  616. of the FR window, labelled 'Select' and 'Show SL'.
  617.  
  618. The Select List is a list of files that the user selects.  Each file can be
  619. from a different directory, which is why the Select List display shows the
  620. full path to each file.
  621.  
  622. You can add a file to the Select List by moving the marker to that file and
  623. then clicking on the 'Select' gadget.  To view the Select List, click on the
  624. 'Show SL' gadget.  The Select List Display show the files in the Select List
  625. in the File List display.
  626.  
  627.  
  628. The Select Gadget:
  629. ------------------
  630.  
  631. Adds files marked for selection using the shift-click or the cursor-right key
  632. using Extended Select.  These are added to a seperate list called the 'Select
  633. List'. Files that already exist in the Select List are ignored.  All marked
  634. files in the current directory are then unmarked.
  635.  
  636. If no files are currently marked, then the current file in the File gadget is
  637. added to the Select List.  If the File gadget is empty, then nothing happens.
  638.  
  639.  
  640. The Show SL Gadget:
  641. -------------------
  642.  
  643. 'Show Select List'.  Clicking on this gadget will bring up the Select List in
  644. the File List display.  You can move around this display but you cannot select
  645. any files.  Hitting this gadget again will return you to the previous display.
  646. Selecting a disk icon or any other method of changing the directory will do
  647. the same thing as well.  Entries in the Select List are shown as
  648. path/filename.. i.e. the full path to the file.
  649.  
  650.  
  651. The Path/Name Gadget:
  652. ---------------------
  653.  
  654. When the FR is in the Select List display mode, the Select gadget will change
  655. and show either 'Path' or 'Name'.  You can toggle between those by clicking on
  656. the gadget.  This allows you to change the display of the Select List from the
  657. full path to a file to only the filename itself and back.
  658.  
  659.  
  660. Removing Entries from the Select List:
  661. --------------------------------------
  662.  
  663. Clicking on any entry in the Select List will remove that entry from the list.
  664.  
  665.  
  666.  
  667.  
  668. ------------------------------------------------------------------------------
  669.                         OTHER KEYBOARD COMMANDS
  670. ------------------------------------------------------------------------------
  671.  
  672. The Cursor Left Key:
  673. --------------------
  674.  
  675. Changes the display to the parent of the current directory.
  676.  
  677. Note:
  678.  
  679. The Parent function (whether called from the keyboard or the mouse) 
  680. brings up the 'Storage Device List' if the Path was already at the root
  681. of a device.  Using the Parent function again after that will bring up
  682. the 'Logical Device List'.
  683.  
  684.  
  685. Control-Cursor Keys:
  686. --------------------
  687.  
  688. - Control-Cursor (left, right, up or down):
  689.   Resizes the window in the direction selected by 24 pixels.
  690.  
  691. - Control-Alt-Cursor (left, right, up or down):
  692.   Resizes the window in the direction selected all the way to the limit of
  693.   the screen or the minimum window height/width size possible.
  694.  
  695. - Control-Shift-Cursor (left, right, up or down):
  696.   Moves the window in the direction selected by 24 pixels.
  697.  
  698.  
  699. Function Keys:
  700. --------------
  701.  
  702.    Normal:
  703.  
  704.    F1   Help about gadget/item under pointer
  705.    F2   Toggle 'File List/Device List/Assign List'
  706.    F3   Go to next device from disk list
  707.    F4   Go to Root Directory
  708.    F5   Go to Parent Directory
  709.    F6   Restore startup directory and file name
  710.    F7   Next Buffer
  711.    F8   Toggle 'Show Info Files' on/off
  712.    F9   Display info about current device
  713.    F10  Create Directory
  714.  
  715.    Shifted:
  716.  
  717.    F1   Display Keyboard Help Screen
  718.    F2   Delete File
  719.    F3   (unused)
  720.    F4   Print Current Directory
  721.    F5   Reset wildcard pattern to "#?"
  722.    F6   Tiny size
  723.    F7   Medium size
  724.    F8   Full screen size
  725.    F9   Scroll Device List Up
  726.    F10  Scroll Device List Down
  727.  
  728.  
  729. Examples Of Keyboard Usage:
  730. ---------------------------
  731.  
  732.    - Selecting a specific file from the current directory:
  733.  
  734.      a. Using the Cursor up/down keys, move the marker until you find the
  735.         file, and hit return.
  736.      
  737.      b. Type the first few letters of the file name, then hit alt-return.
  738.         If the file that shows up is the one you want, then hit return.
  739.         Otherwise, use the cursor up/down keys to track it down.
  740.  
  741.  
  742.    - To display a subdirectory:
  743.  
  744.      -  Using the Cursor up/down keys, move the marker until you find the
  745.         directory, and hit the cursor left key.
  746.  
  747.  
  748.    - To display a directory's parent:
  749.  
  750.      -  Hit the cursor right key.
  751.  
  752.  
  753.    - To display a different device:
  754.    
  755.      a. Hit F2 to display the Device List, then use the cursor keys to select
  756.         the device.  Hit the left cursor key to select that device.
  757.  
  758.      b. Hit the right cursor key multiple times until you get the Device List.
  759.         (then same as above.)
  760.  
  761.      c. Hit F3 until the device you want shows up in the Path gadget.
  762.  
  763.  
  764. ------------------------------------------------------------------------------
  765.                              OTHER FEATURES
  766. ------------------------------------------------------------------------------
  767.  
  768. Create Directory:
  769. -----------------
  770.  
  771. To create a directory, enter its name into the Path gadget and hit return.
  772. If that directory doesn't already exist, the FR will inform you of that and
  773. also asks you to "Hit F10 to create it."  If it can't create the directory,
  774. it will complain.  Hitting F10 on an existing directory has no effect.
  775.  
  776. Note: The new directory requested must have a valid parent.  If it doesn't,
  777.       the FR will tell you that it can't create the directory.
  778.  
  779.  
  780. Print Directory:
  781. ----------------
  782.  
  783. To get a hard copy of the currently displayed directory onto the printer,
  784. click on the 'Prt' gadget or hit the Shift-F4 key.  The printout will be
  785. sent to the currently selected printer in Preferences.  If the printer is
  786. busy, the FR will complain and abort the print.  (output is sent to PRT:)
  787.  
  788. This function recognizes if the printer is not available and complains
  789. instead of just waiting around for it.  It recognizes the following
  790. cases:  printer offline, printer off, paper out, printer not selected.
  791.  
  792. If the current directory is empty, the print will abort.
  793.  
  794.  
  795. Delete File:
  796. ------------
  797.  
  798. You can delete the currently selected file in the File gadget by hitting
  799. Shift-F2.  The FR will bring up a requester asking you if you're sure you want
  800. to delete the file.
  801.  
  802.  
  803. Directory Buffers:
  804. ------------------
  805.  
  806. The File Requester has multiple directory buffers.  A directory buffer is a
  807. temporary storage area for the contents of a directory.  Normally, the FR
  808. will come up displaying directory buffer # 1.  You can use up to 5 buffers to
  809. store directory contents.  The Next Directory gadget allows you to move to
  810. another buffer.  If no other buffer exists, it will provide you with a new
  811. buffer.  As you use the Next gadget, the buffer number will be shown at the
  812. bottom of the FR.  This is a circular gagdet that moves between buffer 1 to
  813. 5 and then back to buffer 1.
  814.  
  815. As you move between buffers, the directory in the buffer to be displayed is
  816. shown immediately and does not have to be read back again from the drive,
  817. unless the directory has been changed since it was last read, in which case,
  818. the FR will re-read the directory.
  819.  
  820. The directory buffers store the following information:
  821.  
  822.  - The full path name of the directory.
  823.  - All the files in the directory along with their sizes, date, time and
  824.    protection settings, and marked files.
  825.  - The number of files and directories in the directory.
  826.  - The position where the scroll bar was in.  (This means that when you return
  827.    to a directory, the file list will be exactly where you left it.)
  828.  - The current filename in the File gadget.
  829.  
  830.  
  831. For your information, each buffer used allocates memory in 2k chunks as it
  832. needs them.  Average memory usage is 70 files for a 2k buffer.  The only limit
  833. to the number of files per directory buffer is available memory.  If the FR
  834. runs out of memory, it will inform you that the directory was truncated.
  835.  
  836.  
  837. Buffered directories between FR calls:
  838. --------------------------------------
  839.  
  840. A special feature of the FR is that it can store all 5 directory buffers
  841. between calls to it if the calling program requests it to do so.
  842.  
  843. In this mode, the FR will not clear its buffers upon exit and will come up
  844. the next time with all the directories intact.  This means that the FR does
  845. not need to re-read the directories, unless these directories have changed
  846. since the last time they were read.  This will only be done for the first
  847. buffer that shows up, and will be done later for each other buffer as the
  848. Next gadget is used to move between buffers.
  849.  
  850.  
  851. Sort Mode:
  852. ----------
  853.  
  854. The File Requester sorts the files in the File List display as it reads them
  855. from the directory.  The files are sorted either alphabetically, or by their
  856. size or their date.
  857.  
  858. The 'Sort Mode' gadget allow you to toggle between these modes.  The gagdet's
  859. text changes between the following states:
  860.  
  861. "FILE"  The File list is sorted by the file name. (default mode)
  862.  
  863. "SIZE"  The File list is sorted by the file size.
  864.         (files with matching size are sorted by name)
  865.         (files are shown largest first)
  866.  
  867. "DATE"  The File list is sorted by the file date and time.
  868.         (files with matching date & time are sorted by name)
  869.         (files are shown newest first)
  870.  
  871.  
  872. The No .Info Gadget:
  873. --------------------
  874.  
  875. The No .Info Gadget is a small box with 'I' in it, below the 'Next' gadget.
  876. If the No .Info Gadget is active, it will be a blank box, or will have an 'I'
  877. in it is it isn't active.  This tells the FR not to display files ending with
  878. '.info' in the file list.  This gadget is actually a toggle switch.  In most
  879. cases the default setting for this gadget is ON.
  880.  
  881. Note: 
  882.  
  883. When moving from off to on, the FR will remove all entries in the File List
  884. ending with .info.  When moving from on to off, it will re-read the directory.
  885.  
  886.  
  887.  
  888. File Requester Look:
  889. --------------------
  890.  
  891. The FR borders have two different looks.  One is the standard look that is
  892. designed for a normal screen.  The second look is designed to match the look
  893. that Workbench 2.0 uses and is almost identical to it.  The FR automatically
  894. detects if it is running under 2.0 and will switch to that look.
  895.  
  896.  
  897. Error Messages:
  898. ---------------
  899.  
  900. If the FR cannot access a device, it will report one of the following errors:
  901.  
  902.   - No disk in drive.     (drive empty)
  903.   - Not a DOS Disk.       (bad or kickstart disk)
  904.   - Can't find Path.      (bad device or directory name)
  905.   - Output Device.        (device selected is not a disk.)
  906.   - DOS Error: xxx.       (where xxx is the DOS error number.)
  907.  
  908.  
  909. ------------------------------------------------------------------------------
  910.  
  911.                    SUMMARY OF FILE REQUESTER GADGETS
  912. ------------------------------------------------------------------------------
  913. Gadget Name            | Gadget Position
  914. -----------------------|------------------------------------------------------
  915. Path Gadget            | String gadget at top of window
  916. File Gadget            | string gadget below File List
  917. File List              | set of gadgets that display the file list
  918. OK Gadget              | bottom left of window
  919. Cancel Gadget          | bottom right of window
  920. Close Window Gadget    | standard close window gadget
  921. Show Wildcard Gadget   | string gadget below Path gadget
  922. Hide Wildcard Gadget   | string gadget to the right of Show gadget
  923. Scroll Up Gadget       | up-arrow above the proportional gadget
  924. Scroll Down Gadget     | down-arrow below the proportional gadget
  925. Prop Gadget            | proportional gadget across the center of the window
  926. Parent Gadget          | up-arrow to the right of the Path string gadget
  927. Disk Icons             | set of disk icons across the right side of the FR
  928. Disk Scroll Up Gadget  | top right, up-arrow
  929. Disk Scroll Down Gadget| top right, down-arrow
  930. Resize Gadget          | bottom 5 lines across window
  931. Next Directory Gadget  | bottom right, marked 'Next'
  932. Reset Path Gadget      | the 'Path' text
  933. Reset Wildcard Gadget  | the 'Show' text
  934. Print Gadget           | bottom right,  marked 'Prt'
  935. Help Gadget            | bottom right, marked 'Help'
  936. Sort Mode Gadget       | bottom right, marked 'File' 'Date' or 'Size'
  937. Preset Resize Gadgets  | 3 small box gadgets, below Sort Mode and Next gadgets
  938. No .Info Gadget        | small box gadget below Next gadget
  939. ------------------------------------------------------------------------------
  940.  
  941. ------------------------------------------------------------------------------
  942.  
  943. Quick installation instructions:
  944.  
  945. 1. Copy the kd_freq.library file into your LIBS: directory.
  946. 2. Copy the FR_Bypass file into your C: directory.
  947. 3. Put the following line into your startup-sequence:
  948.        FR_Bypass
  949.  
  950. ------------------------------------------------------------------------------
  951.  
  952. -   Please send any comments, suggestions, bug reports, etc. to me either on
  953.     Compuserve (75166,2531) or to:
  954.  
  955.                       /-------------------\
  956.                       | Khalid Aldoseri   |
  957.                       | P.O. Box 3300     |
  958.                       | Manama, Bahrain.  |
  959.                       | Fax: (973) 694777 |
  960.                       \-------------------/
  961.  
  962.                Copyright 1990,1991  Khalid Aldoseri.
  963.                            10 May 1991.
  964.