Find and Replace"

This website contains links to software which is either no longer maintained or will be supported only until the end of 2019 (CKFinder 2). For the latest documentation about current CKSource projects, including software like CKEditor 4/CKEditor 5, CKFinder 3, Cloud Services, Letters, Accessibility Checker, please visit the new documentation website.

If you look for an information about very old versions of CKEditor, FCKeditor and CKFinder check also the CKEditor forum, which was closed in 2015. If not, please head to StackOverflow for support.

(Article rewrite; new image, updated icons and alt attributes added. Examples added.)
Line 1: Line 1:
 
__TOC__
 
__TOC__
 +
 +
The '''Find''' and '''Replace''' features make it easier to navigate in the text as well as retain its consistency. Since both functions are closely related, they are implemented as one dialog window with separate tabs that let you jump between the '''Find''' and '''Replace''' option.
 +
 +
<ins>'''Important notice:'''</ins> since the default position of the dialog window covers the document in the editor, you might need to drag the '''Find and Replace''' window in order to reveal the highlighted terms.
 +
 
== Find ==
 
== Find ==
 +
If you want to find a word or phrase in your document in a quick and efficient manner, use CKEditor '''Find''' command.
 +
 +
To open the appropriate dialog window, press the [[Image:CKEditor_find.png|alt=Find]] button on the main editor toolbar.
 +
 +
This is what the '''Find and Replace''' dialog window looks like with the '''Find''' tab active:
 +
 +
[[Image:CKEditor_find_window.png|frame|center|alt=Find window|The Find tab in the Find and Replace window]]
  
−
To find a phrase/word in the text user may press [[Image:CKEditor_find.png]] button on the toolbar. A popup window called "Find and Replace" will appear:<br>
 
  
−
[[Image:CKEditor_find_window.png]]<br>
+
The '''Find''' tab consists of a search field and a few options that let you refine the search. Here is the overview of all '''Find''' tab elements:
 +
* '''Find what''' &mdash; is the text field where you enter the word or phrase that you want to find.
  
−
* '''Find what''': in this field you put the phrase/word you would like to find.<br>
+
* '''Match case''' &mdash; checking this option limits the search operation to words whose case matches the spelling (uppercase and lowercase letters) given in the search field. This means that the search becomes case-sensitive.
−
* '''Match case''': if you check this option the program will find only the text with the exact cases like e.g. aLberT<br>
+
*: Example:
−
* '''Match whole word''': if you check this option CKEditor will only look for a whole word. It will not look for a phrase.<br>
+
*: When "Match case" is checked and the search term is: "option", you will find all instances of "option" with this exact spelling, but not when the word is spelled "Option" or "OPTION".
−
* '''Match cyclic''': if you check this option, when the program reaches the end of the text it begins searching from the top of the text.
+
* '''Match whole word''' &mdash; checking this option limits the search operation to whole words.
 +
*: Example:
 +
*: When "Match whole word" is checked and the search term is: "option", you will find all instances of "option", but not the words "optional" or "options".
 +
* '''Match cyclic''' &mdash; checking this option means that after CKEditor reaches the end of the document, the search continues from the beginning of the text. This option is checked by default.
  
−
After you select options to use press “Find”. The program will highlight search results. If you press "'''Find'''" again CKEditor will find the next phrase/word matching to your request.<br>
+
After you enter the search term and select the options, press the '''Find''' button and CKEditor will highlight the first occurrence of the term in the text, staring from the position of the cursor in text and going down. If you want to jump to the next occurrence of  the term in the text, press the '''Find''' button again.
  
 
== Replace==
 
== Replace==
 +
If you want to quickly find a word or phrase in your document and replace it, use CKEditor '''Replace''' command.
 +
 +
To open the appropriate dialog window, press the [[Image:CKEditor_find_replace.png|alt=Replace]] button on the main editor toolbar.
 +
 +
This is what the '''Find and Replace''' dialog window looks like with the '''Replace''' tab active:
 +
 +
[[Image:CKEditor_replace_window.png|frame|center|alt=Replace window|The Replace tab in the Find and Replace window]]
 +
 +
The '''Replace''' tab consists of a search field, a replace field and a few options that let you refine the operation. Here is the overview of all '''Replace''' tab elements:
 +
* '''Find what''' &mdash; is the text field where you enter the word or phrase that you want replace in the text.
 +
 +
* '''Replace with''' &mdash; is the text field where you enter the word or phrase that will replace the search term in the text.
 +
 +
* '''Match case''' &mdash; checking this option limits the search and replace operation to words whose case matches the spelling (uppercase and lowercase letters) given in the search field. This means that the search and replace becomes case-sensitive.
 +
*: Example:
 +
*: When "Match case" is checked and the search term is: "option", you will find and replace all instances of "option" with this exact spelling, but not when the word is spelled "Option" or "OPTION".
 +
* '''Match whole word''' &mdash; checking this option limits the search and replace operation to whole words.
 +
*: Example:
 +
*: When "Match whole word" is checked and the search term is: "option", you will find and replace all instances of "option", but not the words "optional" or "options".
 +
* '''Match cyclic''' &mdash; checking this option means that after CKEditor reaches the end of the document, the search and replace continues from the beginning of the text. This option is checked by default.
  
−
To replace a phrase/word in your text press [[Image:CKEditor_find_replace..png]] button on the toolbar. A popup window will appear:<br>
+
After you enter the search term, the replace term and select the options, press the '''Replace''' button and CKEditor will highlight the first occurrence of the term in the text, staring from the position of the cursor in text and going down. If you want to replace the highlighted term, click the '''Replace''' button once more. Then, if you want to jump to the next occurrence of  the term in the text, press the '''Replace''' button again.
  
−
[[Image:CKEditor_replace_window.png]]<br>
+
You can also replace all occurrences of the search term in the document in one go. In order to do that, press the '''Replace All''' button. CKEditor will then replace all occurrences in the whole document at once and display a pop-up window with the result of the operation.
  
−
* '''Find what''': in this field you place the phrase/word you would like to find<br>
+
This is what a result window looks like:
−
* '''Replace with''': in this field you place the phrase/word you would like replace your text with.<br>
 
−
* '''Match case''': if you check this option CKEditor will find only the text with the exact cases like e.g. aLberT
 
−
* '''Match whole word''': if you check this option the program will only look for a whole word. It will not look for a phrase.
 
−
* '''Match cyclic''': if you check this option, when CKEditor reaches the end of the text it begins searching from the top of the text.
 
−
<br>
 
  
−
To replace only one phrase/word press "'''Replace'''". CKEditor will find and highlight the text. In order to continue a replacement process, press the "'''Replace'''" button again <br>
+
[[Image:CKEditor_replace_result.png|frame|center|alt=Replace result window|The result of the Replace operation]]
−
To replace all the phrases/words press "'''Replace All'''".
 

Revision as of 09:04, 25 October 2010

Contents

The Find and Replace features make it easier to navigate in the text as well as retain its consistency. Since both functions are closely related, they are implemented as one dialog window with separate tabs that let you jump between the Find and Replace option.

Important notice: since the default position of the dialog window covers the document in the editor, you might need to drag the Find and Replace window in order to reveal the highlighted terms.

Find

If you want to find a word or phrase in your document in a quick and efficient manner, use CKEditor Find command.

To open the appropriate dialog window, press the Find button on the main editor toolbar.

This is what the Find and Replace dialog window looks like with the Find tab active:

Find window
The Find tab in the Find and Replace window


The Find tab consists of a search field and a few options that let you refine the search. Here is the overview of all Find tab elements:

  • Find what — is the text field where you enter the word or phrase that you want to find.
  • Match case — checking this option limits the search operation to words whose case matches the spelling (uppercase and lowercase letters) given in the search field. This means that the search becomes case-sensitive.
    Example:
    When "Match case" is checked and the search term is: "option", you will find all instances of "option" with this exact spelling, but not when the word is spelled "Option" or "OPTION".
  • Match whole word — checking this option limits the search operation to whole words.
    Example:
    When "Match whole word" is checked and the search term is: "option", you will find all instances of "option", but not the words "optional" or "options".
  • Match cyclic — checking this option means that after CKEditor reaches the end of the document, the search continues from the beginning of the text. This option is checked by default.

After you enter the search term and select the options, press the Find button and CKEditor will highlight the first occurrence of the term in the text, staring from the position of the cursor in text and going down. If you want to jump to the next occurrence of the term in the text, press the Find button again.

Replace

If you want to quickly find a word or phrase in your document and replace it, use CKEditor Replace command.

To open the appropriate dialog window, press the Replace button on the main editor toolbar.

This is what the Find and Replace dialog window looks like with the Replace tab active:

Replace window
The Replace tab in the Find and Replace window

The Replace tab consists of a search field, a replace field and a few options that let you refine the operation. Here is the overview of all Replace tab elements:

  • Find what — is the text field where you enter the word or phrase that you want replace in the text.
  • Replace with — is the text field where you enter the word or phrase that will replace the search term in the text.
  • Match case — checking this option limits the search and replace operation to words whose case matches the spelling (uppercase and lowercase letters) given in the search field. This means that the search and replace becomes case-sensitive.
    Example:
    When "Match case" is checked and the search term is: "option", you will find and replace all instances of "option" with this exact spelling, but not when the word is spelled "Option" or "OPTION".
  • Match whole word — checking this option limits the search and replace operation to whole words.
    Example:
    When "Match whole word" is checked and the search term is: "option", you will find and replace all instances of "option", but not the words "optional" or "options".
  • Match cyclic — checking this option means that after CKEditor reaches the end of the document, the search and replace continues from the beginning of the text. This option is checked by default.

After you enter the search term, the replace term and select the options, press the Replace button and CKEditor will highlight the first occurrence of the term in the text, staring from the position of the cursor in text and going down. If you want to replace the highlighted term, click the Replace button once more. Then, if you want to jump to the next occurrence of the term in the text, press the Replace button again.

You can also replace all occurrences of the search term in the document in one go. In order to do that, press the Replace All button. CKEditor will then replace all occurrences in the whole document at once and display a pop-up window with the result of the operation.

This is what a result window looks like:

Replace result window
The result of the Replace operation
Retrieved from "https://docs-old.ckeditor.com/index.php?title=CKEditor_3.x/Users_Guide/Document/Find_and_Replace&oldid=4476"