Difference between revisions of "Search page"

From TED Notepad
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>{{manversion|6.0.0.17|dialog|Settings:Search}}__NOTOC__</noinclude>
+
<noinclude>{{manversion|6.4.1.0|dialog|Settings:Search}}__NOTOC__</noinclude>
  
 
===={{field|Settings:Search|Search bar}}====
 
===={{field|Settings:Search|Search bar}}====
  
The {{field|Settings:Search|Suggest selection to the search bar}} tells, whether to use current selection (if any) upon invoking the {{dialog|Search bar}}. If turned on, whenever the {{dialog|Search bar}} is being opened, current selection is copied into its {{field|Search|Find}} field. Note: Hotkey {{hotkey|Ctrl+Z}} can be used to go back to the previously specified text for convenience.
+
The '''{{field|Settings:Search|Suggest selection to the search bar}}''' setting tells, whether to use current selection (if any) upon invoking the {{dialog|Search bar}}. If turned on, whenever the {{dialog|Search bar}} is being opened, current selection is copied into its {{field|Search|Find}} field. Note: Hotkey {{hotkey|Ctrl+Z}} can be used to go back to the previously specified text for convenience.
  
 
Note: If {{field|Settings:Search|Suggest selection to the search bar}} is turned off, previously specified text is kept within the {{field|Search|Find}} field.
 
Note: If {{field|Settings:Search|Suggest selection to the search bar}} is turned off, previously specified text is kept within the {{field|Search|Find}} field.
  
The {{field|Settings:Search|Reset search bar options when opened}} specifies, which {{feature|Search}} options are to be reset upon each new opening of {{dialog|Search bar}}:
+
The '''{{field|Settings:Search|Keep Escapes on if possible}}''' setting tells, whether the {{field|Search|Escapes}} option should be kept on upon suggesting selection to the search bar, if they were on before. The {{field|Search|Escapes}} option is turned on automatically when the selection contains characters which need escaping. And they are automatically turned off when the selection does not need escaping; unless this settings says to keep them on.
* {{field|Settings:Search|Reset search bar options when opened: Match case}} resets the {{field|Search|Match case}} option.
 
* {{field|Settings:Search|Reset search bar options when opened: Whole words}} resets the {{field|Search|Whole words}} option.
 
* {{field|Settings:Search|Reset search bar options when opened: Escapes, RegExps}} resets the {{field|Search|Escapes}} and {{field|Search|RegExps}} options.
 
  
The {{field|Settings:Search|Auto-hide search bar after searching}} automatically hides the {{dialog|Search bar}} after searching, as soon as the focus is moved from the {{dialog|Search bar}} to the document text (e.g. by mouse).
+
Note: Keeping the {{field|Search|Escapes}} option on is safe even with selections that do not need escaping. However, one should remember turning {{field|Search|Escapes}} on, since characters then need to be escaped, or the {{field|Search|Escapes}} option must be turned off manually.
 +
 
 +
Also see below: Resetting the {{field|Search|Escapes}} option upon opening the {{dialog|Search bar}}.
 +
 
 +
The '''{{field|Settings:Search|Reset search bar options when opened}}''' settings specify, which {{feature|Search}} options are to be reset upon each new opening of the {{dialog|Search bar}}:
 +
* The '''{{field|Settings:Search|Reset search bar options when opened: Match case}}''' setting resets the {{field|Search|Match case}} option.
 +
* The '''{{field|Settings:Search|Reset search bar options when opened: Whole words}}''' setting resets the {{field|Search|Whole words}} option.
 +
* The '''{{field|Settings:Search|Reset search bar options when opened: Escapes, RegExps}}''' setting resets the {{field|Search|Escapes}} and {{field|Search|RegExps}} options.
 +
 
 +
Note: Resetting the {{field|Search|Escapes}} option is not carried out upon suggesting selection to the {{dialog|Search bar}}. The {{field|Search|Escapes}} option is turned on or off automatically depending on whether the selection needs escaping (while taking {{field|Settings:Search|Keep Escapes on if possible}} setting above into consideration).
 +
 
 +
Note: Most {{feature|Search}} options are reset upon {{feature|Find Selected}} and {{feature|Find Later}} (and {{feature|Look for Selected}} and {{feature|Look for Later}}). {{field|Search|Match case}}, {{field|Search|Whole words}} and {{field|Search|RegExps}} in particular, while {{field|Search|Escapes}} depend on whether they are needed for the selected text (while taking {{field|Settings:Search|Keep Escapes on if possible}} setting above into consideration).
 +
 
 +
The '''{{field|Settings:Search|Auto-hide search bar after searching}}''' setting automatically hides the {{dialog|Search bar}} after searching, as soon as the focus is moved from the {{dialog|Search bar}} to the document text (e.g. by mouse).
  
 
Note: This automated hiding occurs only if the {{dialog|Search bar}} has actually been used for searching. Therefore, opening the {{dialog|Search bar}} but not performing a search, does not auto-hide anything.
 
Note: This automated hiding occurs only if the {{dialog|Search bar}} has actually been used for searching. Therefore, opening the {{dialog|Search bar}} but not performing a search, does not auto-hide anything.
  
The {{field|Settings:Search|Only after successful match}} disables automated {{dialog|Search bar}} hiding after unsuccessful uses. Successful match must be made in order to hide the {{dialog|Search bar}} and clean the workspace. This is the usual user's expected of behaviour &mdash; search until found, only then close the {{dialog|Search bar}} and work with the occurrence.
+
The '''{{field|Settings:Search|Only after successful match}}''' setting disables automated {{dialog|Search bar}} hiding after unsuccessful uses. Successful match must be made in order to hide the {{dialog|Search bar}} and clean the workspace. This is the usual user's expected of behaviour &mdash; search until found, only then close the {{dialog|Search bar}} and work with the occurrence.
 +
 
 +
The '''{{field|Settings:Search|Keep search history}}''' setting
 +
 
 +
The '''{{field|Settings:Search|Include searches via Find Selected}}''' setting
 +
 
 +
{{todo|describe search history settings}}
  
 
===={{field|Settings:Search|Advanced}}====
 
===={{field|Settings:Search|Advanced}}====
  
The {{field|Settings:Search|Disable multi-threading}} allows to disable multi-threading in search routines in case of troubleshooting. Note: This option should not be tampered with without full understading of mutli-threading and its impacts. Use only if instructed to do so by authors of the software.
+
The '''{{field|Settings:Search|Disable multi-threading}}''' setting allows to disable multi-threading in search routines in case of troubleshooting. Note: This option should not be tampered with without full understading of mutli-threading and its impacts. Use only if instructed to do so by the authors of the software.
 +
 
 +
Note: Although (theoretically) disabling multi-threading may speed up search initialization, it does not affect the speed of actual searching, unless the underlying system is incapable of true multi-threading support. On the other hand, by disabling multi-threading, one completely looses the option to cancel any ongoing search. Even if an abort dialog is shown (which is rather unlikely, but this can change from version to version and system to system), it won't stop the ongoing search if multi-threading is disabled.
  
Note: Although (theoretically) disabling multi-threading may speed up search initialization, it does not affect the speed of actual searching, unless the underlying system is incapable of true multi-threading support. On the other hand, by disabling multi-threading, one completely looses the option to cancel any ongoing search. Even if an abort dialog is shown (which is rather unlikely, but this can change from version to version and system to system), it won't stop the ongoing search anyway.
+
The '''{{field|Settings:Search|No newlines decoding in "Could not find" message}}''' setting specifies, whether to naturally show multiple lines in a message upon no occurrences found, or prefer showing {{string|\n}} instead, as they appear in the {{dialog|Search}} dialog.

Latest revision as of 00:24, 29 May 2026

You see work in progress here; this section already reflects future TED Notepad version 6.4.1.0.
This section may contain incomplete, premature, or mistaken information, prone to change without notice.

Control page Control:dialog:Settings:Search

Search bar

The Suggest selection to the search bar setting tells, whether to use current selection (if any) upon invoking the Search bar. If turned on, whenever the Search bar is being opened, current selection is copied into its Find field. Note: Hotkey Ctrl+Z can be used to go back to the previously specified text for convenience.

Note: If Suggest selection to the search bar is turned off, previously specified text is kept within the Find field.

The Keep Escapes on if possible setting tells, whether the Escapes option should be kept on upon suggesting selection to the search bar, if they were on before. The Escapes option is turned on automatically when the selection contains characters which need escaping. And they are automatically turned off when the selection does not need escaping; unless this settings says to keep them on.

Note: Keeping the Escapes option on is safe even with selections that do not need escaping. However, one should remember turning Escapes on, since characters then need to be escaped, or the Escapes option must be turned off manually.

Also see below: Resetting the Escapes option upon opening the Search bar.

The Reset search bar options when opened settings specify, which Search options are to be reset upon each new opening of the Search bar:

Note: Resetting the Escapes option is not carried out upon suggesting selection to the Search bar. The Escapes option is turned on or off automatically depending on whether the selection needs escaping (while taking Keep Escapes on if possible setting above into consideration).

Note: Most Search options are reset upon Find Selected and Find Later (and Look for Selected and Look for Later). Match case, Whole words and RegExps in particular, while Escapes depend on whether they are needed for the selected text (while taking Keep Escapes on if possible setting above into consideration).

The Auto-hide search bar after searching setting automatically hides the Search bar after searching, as soon as the focus is moved from the Search bar to the document text (e.g. by mouse).

Note: This automated hiding occurs only if the Search bar has actually been used for searching. Therefore, opening the Search bar but not performing a search, does not auto-hide anything.

The Only after successful match setting disables automated Search bar hiding after unsuccessful uses. Successful match must be made in order to hide the Search bar and clean the workspace. This is the usual user's expected of behaviour — search until found, only then close the Search bar and work with the occurrence.

The Keep search history setting

The Include searches via Find Selected setting

This section is incomplete and wants to be finished later.
TODO: describe search history settings

Advanced

The Disable multi-threading setting allows to disable multi-threading in search routines in case of troubleshooting. Note: This option should not be tampered with without full understading of mutli-threading and its impacts. Use only if instructed to do so by the authors of the software.

Note: Although (theoretically) disabling multi-threading may speed up search initialization, it does not affect the speed of actual searching, unless the underlying system is incapable of true multi-threading support. On the other hand, by disabling multi-threading, one completely looses the option to cancel any ongoing search. Even if an abort dialog is shown (which is rather unlikely, but this can change from version to version and system to system), it won't stop the ongoing search if multi-threading is disabled.

The No newlines decoding in "Could not find" message setting specifies, whether to naturally show multiple lines in a message upon no occurrences found, or prefer showing \n instead, as they appear in the Search dialog.