home *** CD-ROM | disk | FTP | other *** search
/ PC/CD FUN 24 / cdimage.iso / Vrac / Win95 / FDREPL95 / Fdrepl95.txt next >
Text File  |  1996-11-17  |  11KB  |  210 lines

  1. Application Synopsis
  2. Search/Replace Application Synopsis Version 4.1.0 for Win95/NT4.0
  3.  
  4. This Win95/NT4.0 Windows Search/Replace application was built to allow
  5. application developers, html writers, system/network administrators,
  6. and others to change multiple instances of a key word, phrase,
  7. sentence, or paragraph in many text files quickly and efficiently.
  8. It was designed to be used stand-alone by developers, administrators,
  9. HTML authors, et. al. who need to change a piece of information in
  10. multiple lines of many files located in multiple directories.  It can
  11. also be wired it into the Microsoft C++ visual work bench through its
  12. Options/Tools menu to enrich the editing capability.
  13.  
  14. Search/Replace allows you to:
  15. o   define the search and replace strings or use
  16.     previously defined strings;
  17. o   search and replace across multiple lines new in
  18.     Version 3.2;
  19. o   display multiline search and replace results on
  20.     multiple lines new in Version 3.4;
  21. o   define search/replace strings up to 2000
  22.     characters new in Version 3.2;
  23. o   define long search/replace strings using an
  24.     extended edit dialog to accommodate up to 2000 characters new in
  25.     Version 3.3;
  26. o   define DOS file like wild cards in the search
  27.     string new in Version 4.0;
  28. o   use a set of special characters (discussed below)
  29.     enhanced in Version 3.2;
  30. o   define whether or not the search will be case
  31.     sensitive (replace is always as entered);
  32. o   define whether or not it must find the search
  33.     string as a whole word or allow it to be embedded;
  34. o   control whether the replace operation will be
  35.     global or a confirmation is required for each replace (it will allow
  36.     you to change from confirm each to global during the confirmation
  37.     process plus other options);
  38. o   automatically switches between a small and large
  39.     query replace dialog (new in Version 4.1) for enhanced decision
  40.     making during replace;
  41. o   select one or more files you want it to search in
  42.     one or more directories using an extended file dialog (all customers)
  43.     or new in Version 3.0 to specify a starting directory and file filter
  44.     and let the application add the qualifying files to the list
  45.     (registered customers only);
  46. o   define whether to replace all instances in a line
  47.     or only the first;
  48. o   define the file extensions you want to Always
  49.     Search or Exclude (prompts you when it encounters an extension not on
  50.     one of these two lists or allows you to add it to one of two
  51.     additional lists which are search/exclude for this session only;
  52. o   include an extension to search, for this session
  53.     only, from its Always Exclude list;
  54. o   define whether the files it searches conform to
  55.     the UNIX file type rules for end-of-line (discussed below);
  56. o   abort/stop in the middle of a replace session
  57.     when confirm each is selected;
  58. o   abort in the middle of a global replace session
  59.     by double left clicking on a displayed line in the active window
  60.     during a global replace;
  61. o   control whether or not the back up file that is
  62.     created to allow abort/restore is retained or automatically deleted;
  63. o   control how to create the backup (by prepending a
  64.     character to the existing extension or new in Version 3.1 by defining
  65.     your own replacement back up extension); and
  66. o   change from search/replace to insert a string at
  67.     a specific column in every line of the files you select (discussed
  68.     below). 
  69. Search/Replace also:
  70. o   remembers its last screen/toolbar position;
  71. o   remembers the last drive/directory you searched;
  72. o   allows you to define how many previous
  73.     search/replace strings to remember;
  74. o   allows you to close all open display windows with
  75.     one button click (new in Version 4.1);
  76. o   allows you to define the character it uses to
  77.     create a backup of files it modifies or to define your own
  78.     replacement extension;
  79. o   allows you to define your own set of file type
  80.     filters;
  81. o   automatically adds filter extensions containing
  82.     no wild card characters to Search This Session Only list when you
  83.     define files via the Start Directory and File Filter method new in
  84.     Version 3.4;
  85. o   allows you to define an editor to launch and will
  86.     launch that editor when you double left click on a file or file line
  87.     at the conclusion of the search and replace operation;
  88. o   allows you to print the results of the search and
  89.     replace operation or save the results in a file; 
  90. o   allows you to define the printer font size (new
  91.     in Version 4.1);
  92. o   allows you to dictate the number of lines per
  93.     page to print and whether of not to print the "not found in" files
  94.     and related details new in Version 3.4; and
  95. o   allows you to define how many spaces it will use
  96.     to expand tabs.
  97.  
  98. Display Limitation
  99. The application was designed to handle a huge number of files from
  100. multiple directories.  There is a 128,000 line display limitation
  101. that will limit the number of files you can search and replace at one
  102. time.  If 32 lines are modified per file (96 display lines), the file
  103. limitation is about 1,300 files.  If no changes are made, the
  104. application can handle 128,000 files.  The application will stop the
  105. search/replace operation when the display line limitation is reached.
  106.  Search and replace strings are each limited to 2000 characters.
  107.  
  108. Windows 95 Customers
  109. With Windows 95, I had hoped that the display limitations for list
  110. boxes et. al. would no longer be a concern.  In fact, I assumed that,
  111. only to find out that I can only display 32767 lines in a list box. 
  112. As a result, only 32000 lines are displayed per display frame.  To
  113. overcome this limitation, I allow you to switch display frames using
  114. the Up (cyan) and Down (yellow) arrow buttons on the tool bar or
  115. selecting the Next/Previous Display Frame option from the View Menu. 
  116. New in Version 4.0, you can now jump to a specific display page using
  117. the Right (green) arrow button on the toolbar.  For those of you who
  118. running NT, forget this paragraph.
  119.  
  120. Newline in Files Required
  121. The application expects to find newline characters, as a minimum, at
  122. the end of each line (text file) and will not process files that are
  123. not constructed in this manner.  Files generated by word processors
  124. may or may not fall into this category unless they are saved in
  125. ASCII/text.  When the application encounters such a file, it excludes
  126. the file from the session.
  127.  
  128. Lists Maintained by Search/Replace
  129. Files are generally grouped by extension, and in today's environment,
  130. more than one type of file can have the same extension.  As one
  131. example, Microsoft Word stores their files, by default, in non-text
  132. format using the doc extension while you or others may use the same
  133. extension to store files in text format.  Search/Replace makes no
  134. assumptions about file types except for a few universal ones such as
  135. exe, com, etc.  You may define the file extensions you do and do not
  136. want included in your search.  You need not predefine the extensions,
  137. since the application will prompt you each time it encounters an
  138. extension it does not know about.  The application keeps five (5)
  139. file extension lists which are Always Search, Always Exclude, Search
  140. This Session Only, Exclude This Session Only, and Override.  Override
  141. allows you to include an always excluded extension for this session
  142. only.  You may predefine the Always ... file extension types by
  143. selecting the Options menu and then the File Types tab.
  144.  
  145. Back Ups are Automatic
  146. Any time a file is modified by the application, a backup file is
  147. generated that contains the original information.  If you choose to
  148. Abort a search/replace operation, all files modified during the
  149. session up to the Abort point are restored (via the back ups) to
  150. their pre-session state.  You may also decide, after the fact, that
  151. the changes made were not "as expected" and manually restore them
  152. yourself.  By default, a tilde (~) is prepended to the original
  153. file's extension.  If a tilde is not to your liking, you may change
  154. it to a valid DOS file name character of your choosing by selecting
  155. the Options menu and then the Back Ups tab.  Alternately, you may
  156. define your own backup extension.  The extension must be composed of
  157. valid DOS file name characters.  Using this option, the characters
  158. beyond the last period are replaced with your backup extension. 
  159. These back up files may optionally be automatically deleted at the
  160. conclusion of the search/replace operation by selecting No for the
  161. Retain Back Up option in the Back Ups tab.
  162.  
  163. UNIX versus DOS File Types
  164. In today's networking environment, many files can be manipulated on
  165. foreign machines.  The UNIX file type option is available for those
  166. who need to remotely alter text files that conform to the UNIX file
  167. standard.  For those not familiar with UNIX vs DOS file types, UNIX
  168. saves files with just a newline (\n) while DOS saves files with a
  169. carriage return (\r)-newline(\n) combination to signify the end of
  170. the each line.  The application can process both file types but by
  171. default expects the DOS carriage return-newline combination.  If you
  172. are processing UNIX files, check the UNIX file types box.  If not
  173. checked and the application detects a UNIX file type file, it will
  174. inform you and ask if you want to process it as a UNIX file type (new
  175. in version 3.2).  This prompt can be annoying if you are processing a
  176. lot of UNIX files.  If you specified the $ special character and a
  177. UNIX file is detected, you will not be given the opportunity switch
  178. to UNIX file processing since a \r\n is substituted for the $
  179. character before any files are processed and it needs to be just the
  180. \n for UNIX (new in version 3.4).  Be aware of the following:
  181. o   files moved from a UNIX machine to your DOS
  182.     machine may not contain the carriage return; and
  183. o   some editors allow you to store files in UNIX
  184.     format on your DOS machine.
  185. You can use this application to change the end-of-line marker in
  186. every line from one format to the other.
  187.  
  188. Switching from Search/Replace to Insert At
  189. There have been times when I needed to insert a character or a
  190. character string at a specific column of every line in a data file
  191. and had to do it manually.  As an added bonus, the application will
  192. do that for you if you check the Insert @ Column box in the
  193. Search/Replace Dialog.  Instead of a search/replace application, the
  194. application magically changes to insert at a column.  The
  195. search/replace string captions change as well as the functionality of
  196. its controls allowing you to define the character or string and the
  197. column (1 through 254 minus the insert string length) where you want
  198. it inserted.  Be aware, that formerly blank lines will contain the
  199. inserted string at the specified column at the conclusion of the
  200. operation.
  201.  
  202. The application handles long file names (256 characters max. for the
  203. total of the path, file name, and extension) as long as the files are
  204. located on your machine.  If your network does not handle long file
  205. names without mangling, they will appear in the dialogs in 8.3
  206. format.
  207.  
  208.  
  209.  
  210.