View source for Orion/Documentation/User Guide/Reference/Search Results page

= Search page =
The <b>Search</b> page can be launched from any other Orion pages with a search scope. Refer to [[Orion/Documentation/User_Guide/Getting_started#Searching_for_file_content|Searching for file content section]] on how to launch the search page from different places.
The left hand side of the page displays the search and replace field and all other options. The right hand side displays the result when you invoke the search. The header of the result pane displays the total number of matches and the number range of the first page. Each file is expandable to display all the lines that match the keyword. You can use right arrow key to pop up a 5-line context around the line. To view the file with the line located you can click on any match to open the editor. The page is designed to display multiple pages if the number of result files exceeds 40. To view more results you can use the previous and next page actions in the tool bar.

[[Image:search-page-overall.png|Search page]]

== Search completion ==
When you type on the search field, there is a suggested list popping up under the field. The suggested list contains the most recent searched keywords, filtered by the current typed. The max number of the recent keyword is 20.

You can also delete the recent keyword when it is highlighted. Note that if you use backspace key till the search field is empty, it will show you <b>all</b> the recent search terms.

[[Image:search-page-completion.png|Search completion]]

== Filter the search result ==
In the result pane, there is a way to narrow down the number of the files and the lines of matches. Type a keyword in the filter box and it will display only the files and matching lines that contain that filter keyword. Note that the search term is highlighted by bold and the filter term is highlighted by the yellow background. If you backspace the filter to empty, it will show you all the results as normal.

[[Image:search-page-filter.png|Search completion]]

== Search scopes ==
When you launch the search page, the bread crumb shows the current scope. But once the result pane shows some results, you can scope up and down for the same keyword from there.

=== Switching file systems ===
If there are other file systems installed, you can switch to them in the search page. The search will then start from the selected file system.

[[Image:searchPage-switch-filesys.png|File system switch]]

=== Scoping down ===
Let's assume that you've just searched for "function" on a folder and you got 265 files but you want to see the results on a folder you are interested in. You can now click on the location column where the interesting folder is presented. The result will be scoped down to that folder by the same keyword.

[[Image:searchPage-scopedown.png|Search location column]]

=== Scoping up ===
If your search result presents a sub folder but you want a broader scope, you can click on any segment in the breadcrumb. The result will be scoped up to that folder by the same keyword.

[[Image:searchPage-scopeUp.png|Search breadcrumb]]

== Navigating matches ==
There are four actions in the tool bar for navigating matches. <b>Expand all</b> and <b>Collapse all</b> are convenient actions to view all matches or just view the file list. <b>Up</b> and <b>Down</b> allow you to just iterate all the files and matches top-down or bottom-up. While you are iterating, the current <b>row</b> is moving to indicate where you are. You can also jump over to a specific file or match by clicking on that row, which gives a quick switch-over to where you want to start the iteration. The current <b>row</b> is always cached as the browser's cookie based on the search URL. If you leave the page and come back or refresh the page, the current row is restored.

== Keyboard navigation ==
When the pane is loaded, it is focused and the current row is highlighted where you can use the keyboard navigation.
Note that keyboard navigation is available only when the <b>result pane</b> gets focus. If focus is not on the result pane, just click on any place in the result pane to get it back.

* To move the current row, use up and down arrow keys. You can also change the current row by clicking on the anywhere of any row.
* To expand or collapse the current row, use right and left arrow keys.
* To open a file or go to the matching line with that file, use Enter key.
* To open a file or go to the matching line with that file in a new tab, use Ctrl+Enter key.

Keyboard navigation when doing replace is similar. But as the file and match names are not links to open the editor, enter key is not available. Also note that there is no context tip because you can view them in the compare view.

== Viewing details ==
There are two ways to view details on a match. When the current row is on a match, pressing <b>right arrow</b> key will pop up a context tip with five lines of code around the hit line. Note that if you use <b>up</b> and <b>down</b> arrow keys from now, the context tip changes contents when a match is iterated. Use <b>left arrow</b> key to cancel the context tip. If you want to view more details, press enter key or click on the link of the match. This will open the Orion editor with the line located at the matching place.

[[Image:searchPage_view_details.png|View search result details]]

== Linking to the editor ==
When you choose to open the editor for more details, the editor will be opened with the find&replace feature for you.
If you click on a file, the editor will open with the first match highlighted. If you click on a match, that match will be highlighted in the editor. You can then continue to work on this single file without bothering to bring the find&replace up again.

[[Image:search_view_details_in_editor_new1.png|View search result in editor]]

== Navigating pages ==
If the number of matching files exceeds the page size, which is 40 by default, the <b>Next page</b> and <b>Previous page</b> actions will appear in the tool bar.

== Stale files ==
Orion search is based on the file indexer on the server side. There may be some rare cases that your updated files are not synced up into indexer yet when you invoke the search. For example, if you search on <b>foo</b> and replace all the matches with <b>bar</b> in a file and then search on <b>foo</b> again right away. Depending on how many files on the server, the indexer may still hit the file but the file does not contain <b>foo</b> any more. In this case the file is greyed out in the result list but if you search again later it will disappear from the list completely.

[[Image:search_stale_files_new.png|Stale files in the results]] 
 
== Search and replace ==

=== Preview changes ===
Type both a search term and replace term, click replace button. Now you will see a replace preview on the result pane.
When the replace preview is loaded on the result pane, the compare view is displayed by default at the bottom of the result pane. While you are iterating matches, the compare view highlights the difference for the current row. Note that you can click on <b>Hide Compare</b> on the toolbar to hide it for a smoother iteration and bring it back later by <b>Show Compare</b>.

[[Image:searchPage_replace.png|View compare]]

=== Apply selected changes ===
Refer to [[Orion/Documentation/User_Guide/Tasks/Navigating_and_searching#Search_and_replace_across_files|Search and replace across files]] for details.

== Current limitations ==
There are several limitations that will be addressed in the future releases.
* Tailing wild card search is done automatically but if you want to do a <b>leading</b> wild search you have to type "*" explicitly. For example, "Search" will hit "SearchExplorer" but "explorer" will hit it. You have to type "*explorer".
* If you enter multiple words in the search box, it will search for that exact phrase. Phrase search does not support wildcards, and will ignore punctuation between words. For example, if you search for <b>foo bar</b>, it will find matches such as <b>foo. (bar)</b>
* Filter box in the replace preview is not available.
* Case sensitive and regular expression search is not indexed.

== Related Tasks ==

* [[Orion/Documentation/User_Guide/Tasks/Navigating_and_searching|Searching]]