home *** CD-ROM | disk | FTP | other *** search
/ Archive Magazine 1996 / ARCHIVE_96.iso / _textfind / _help < prev    next >
Text File  |  1996-09-14  |  7KB  |  133 lines
  1.  
  2.         !TextFind - Fast text search for the Archive CD
  3.         ===============================================
  4.  
  5. This program will search the text files of the Magazine, Hints and Tips
  6. or Products Available on the Archive Magazine CD. It is not intended to
  7. 'search and display'. You can do this using any good text editor.
  8. Instead it will produce a list of references with the issue and line
  9. numbers where a match was found together with a copy of the line. You
  10. can then use this list, with 'goto line' in your text editor, to jump to
  11. the sections of the files you wish to read.
  12.  
  13.         The control window
  14.         ------------------        
  15.  To use the program run it in the usual way and then click SELECT on the
  16. icon. The main control window will then open.
  17.  
  18. At the left-hand side are three option buttons, 'Case sensitive', 'Whole
  19. words' and 'Confirm'.
  20.  
  21. If 'Case sensitive' is ON only text which matches the case of the search
  22. string will be found, if it is OFF case is ignored. If the search string
  23. is 'Test' then with this option ON only exact matches will be found, if
  24. OFF 'test', TEST, etc. will also be matched.
  25.  
  26. If 'Whole words' is ON then the matched text will need to be complete
  27. words. For example, with this off, if you were searching for 'test'
  28. words like 'latest', 'tests', 'testing' would also be found. With it ON
  29. only the word 'test' would be found. (Please see the notes under
  30. 'Problems' before using this option).
  31.  
  32. 'Confirm' changes the way in which the program operates when a match is
  33. found. If it is OFF then the program just counts the matches found in
  34. each file in the small display icon at the right hand side of the
  35. window. If is is ON then it will pause when it finds a match and display
  36. the line where it was found at the top of the window. The small display
  37. icon then tells you which line the match was found. You must then click
  38. on either 'Include' (to have that reference included in the search list)
  39. or 'Skip' to have it ignored.
  40.  
  41. The three radio buttons in the centre of the window choose which
  42. sections of the magazine will be searched. As the Products Available and
  43. Hints and Tips sections are very much smaller than the whole magazine
  44. searching just one of these will be much quicker. Don't forget that the
  45. magazine itself includes these two sections, so if you choose to search
  46. the whole magazine you will also find all references which are in the
  47. Hints and Tips and Products Available sections.
  48.  
  49.         Using TextFind
  50.         --------------
  51.  Now that the various controls have been explained using the program
  52. should be self evident. There only remains one control to be explained,
  53. this is the display icon labelled 'From' with its two 'bump' icons. This
  54. selects which issue of the magazine the search will begin from. If you
  55. don't want it to start from the first issue (for example, if you only
  56. want recent references to an item) then just use the bump icons to
  57. change it. The number can go right down to 1, although the magazine
  58. actually begins at issue 4. This is because the Hints and Tips and
  59. Products Available sections do go right back to issue 1.
  60.  
  61. When you have entered the search string (which must have at least three
  62. characters) and set the various buttons as you want them just click on
  63. 'Begin' or press RETURN. The '#' (hash) character is used as a
  64. 'wildcard' which means it will match any single character. For example,
  65. 'de#d would match 'dead' or deed'.
  66.  
  67. Unless you have selected 'Confirm' all you will see until the search
  68. is complete is the name of the file(s) being searched and the matches in
  69. each file being counted.
  70.  
  71. When the search is complete the top icon in the window is used to tell
  72. you how many matched were found and a 'Save' window will open. You can
  73. drag the file icon in this window to any filer window (changing the
  74. filename first if you wish) or directly to your text editor. If you
  75. close the SaveAs window before you save the file then it can be opened
  76. again from the icon bar menu.
  77.  
  78. If you save a file to disc then the name in the 'Saveas' window will
  79. then include the full path/filename of the file as it was saved. It will
  80. then be possible to save subsequest files by just pressing RETURN with
  81. the caret in the filename icon, changing the leafname first if you wish,
  82. and the file will be saved in the same directory as the first.
  83.  
  84. 'Stop', as the name suggests, will abort the search at any stage. If some
  85. matches have been found when you click on 'Stop' then the SaveAs window
  86. will open so you can save the results of the partial search. There might
  87. be a slight delay before this happens.
  88.  
  89.  
  90.         Technical notes and possible problems
  91.         -------------------------------------
  92.  The program has been (fairly) thoroughly tested using the 1995 Archive
  93. CD, so it should be error free. However, if you do have any problems
  94. please report them directly to me (see the end of this file) and not to
  95. N.C.S., as they will probably not be able to help.
  96.  
  97. To make the search fast the program loads whole files into memory and
  98. uses machine code search routines. This means that you must have enough
  99. free RAM available to hold the largest file needed and the whole of the
  100. 'found' list. The files used are the Hints and Products files for a
  101. complete year and the individual issue magazine files. The largest of
  102. these is around 400K, so with the program itself and some RAM for the
  103. list you will need at least 450K of free RAM. This should be within the
  104. capabilities of any machine provided you do not have too many other
  105. applications running at the same time.
  106.  
  107. The 'Whole words' system is not completely foolproof. A 'terminating
  108. character' is regarded as anything other than the letters a-z, A-Z or
  109. the figures 0-9. A word must also begin with one of these characters, a
  110. pound sign (ú) or an exclamation mark (!) so words which start with
  111. 'foreign' characters or any other symbols will NOT be found when this
  112. option is on. In practice, provided you are aware of this limitation, it
  113. is not likely to cause problems. If in doubt switch off 'Whole words'
  114. since if the word or phrase you are looking for does contain this type
  115. of character you are not likely to have many false matches anyway.
  116.  
  117. The three 'option' buttons are checked before each file is searched so
  118. if they are changed while the program is working the change will take
  119. effect when the next file is loaded. Changing the 'From' icon or the
  120. section of the magazine have no effect once the search has begun.
  121.  
  122.  
  123.         Any problems or suggestions please contact -
  124.  
  125.                 David Holden
  126.                 39 Knighton Park Road
  127.                 Sydenham
  128.                 London  SE26 5RN
  129.  
  130.                 email - info@apdl.co.uk
  131.  
  132.  
  133.