diff --git a/docs/img/find_all_results.png b/docs/img/find_all_results.png new file mode 100644 index 00000000..7266d974 Binary files /dev/null and b/docs/img/find_all_results.png differ diff --git a/docs/img/search.png b/docs/img/search.png new file mode 100644 index 00000000..845a9d79 Binary files /dev/null and b/docs/img/search.png differ diff --git a/docs/widgets_project_groups.md b/docs/widgets_project_groups.md index bab52c0a..deffb4ed 100644 --- a/docs/widgets_project_groups.md +++ b/docs/widgets_project_groups.md @@ -9,7 +9,7 @@ title: Widgets - project groups #### Description Project groups allow to work with several projects. It's easier to activate one, to recompile it and to go back to another one. -A group can include any project whose the format is handled by Coedit (Dub JSON, Sub SDL and CE formats). +A group can include any project whose the format is handled by Coedit (Dub JSON, Dub SDL and CE formats). Another interesting feature is that the groups can be build by a single click, in parallel, sequentially or using wait points which are defined for each item in the group. When working with static libraries, this system allows faster builds. diff --git a/docs/widgets_search.md b/docs/widgets_search.md index a436ae6a..98ac2c4d 100644 --- a/docs/widgets_search.md +++ b/docs/widgets_search.md @@ -1,3 +1,28 @@ --- title: Widgets - search and replace --- + +The _find and replace_ widget allows to find and replace text patterns in the focused source editor. + +![](img/search.png) + +- **first field**: The pattern to find. +- **second field**: The pattern used as replacement, only active when **"replace with"** is checked. +- **whole word**: Only searches for the whole pattern. +- **backward**: Searches from the current position to the top. +- **from cursor**: When not checked the operation always starts from the top of the document. +- **case sensitive**: When unchecked the characters case is ignored. +- **prompt**: A confirmation is required to replace a match. +- **allow regex**: When checked, the search is performed by a regex engine. Note that it doesn't mean that the pattern to find has to be a regex). + +By default CTRL + F is used to pass the current identifier to the first field and F3 to execute a search. +The _Find all_ results are displayed in the [messages widget](widgets_messages), with the context and they can be clicked. + +![](img/find_all_results.png) + +The scope of _Find all_ can be set either to the current editor or to the whole project by clicking the icon at the right. + +Notes: + +- To find the declaration of a symbol, Ctrl + MB Left or the [symbol list](widgets_symbol_list) are faster. +- To rename a variable or a type, local identifier renaming (Ctrl + F2) can be more accurate than _Replace all_ since the action uses the semantic. \ No newline at end of file