Jump to: navigation, search

Difference between revisions of "Orion/Documentation/User Guide/Reference/Search Results page"

Line 1: Line 1:
 
= Search Results page =
 
= Search Results page =
 
The <b>Search Results</b> page displays files for any search performed in the search entry field in the title area of any page. Each file is expandable to display all the matches with the lines containing the search keyword and the line number. You can use right arrow key to pop up a 5-line context around the line or you can click on any file or match to open the Orion editor to see the whole file at that line. The page is designed to display multiple pages if the result files exceeds 40. There are previous and next page actions in the tool bar for you to go through all the results.
 
The <b>Search Results</b> page displays files for any search performed in the search entry field in the title area of any page. Each file is expandable to display all the matches with the lines containing the search keyword and the line number. You can use right arrow key to pop up a 5-line context around the line or you can click on any file or match to open the Orion editor to see the whole file at that line. The page is designed to display multiple pages if the result files exceeds 40. There are previous and next page actions in the tool bar for you to go through all the results.
 
Click <b>Save Search</b> in the tool bar to bookmark a link to this search for future use. Note that this is a bookmark to the search, rather than a specific search result. Clicking a link in the <b>Searches</b> list of the Favorites panel will perform a new search with the same search terms.
 
  
 
[[Image:Orion-search-ResultOverview.png]]
 
[[Image:Orion-search-ResultOverview.png]]
Line 17: Line 15:
  
 
=== Scoping down ===
 
=== Scoping down ===
Lets assume that you 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. You can now click on the location column where the interesting folder is presented. The result will be scoped down to that folder.
+
Lets assume that you 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. 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:search_scope_down.png]]
 
[[Image:search_scope_down.png]]
  
 
=== Scoping up ===
 
=== Scoping up ===
 +
If your search result presents a sub folder but you want a broader scope, you can click on any segment in the bread crumb. The result will be scoped up to that folder by the same keyword.
 +
 +
[[Image:search_scope_up.png]]
 +
 
== Saving search ==
 
== Saving search ==
 +
 +
Click <b>Save Search</b> in the tool bar to bookmark a link to this search for future use. Lets say you are searching "foo" on folder "bar". The default name of the saved search is "foo in bar" but you can rename it later to a more meaningful one. Note that this is a bookmark to the search, rather than a specific search result. Clicking on a link in the <b>Searches</b> list of the Favorites panel will perform a new search with the same search terms.
 +
 +
[[Image:search_save_search.png]]
 +
 
== Navigating matches ==
 
== Navigating matches ==
 +
There are 4 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>cursor</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.
 +
 +
 
== Key board navigation ==
 
== Key board navigation ==
 
== Viewing details ==
 
== Viewing details ==

Revision as of 10:47, 24 February 2012

Search Results page

The Search Results page displays files for any search performed in the search entry field in the title area of any page. Each file is expandable to display all the matches with the lines containing the search keyword and the line number. You can use right arrow key to pop up a 5-line context around the line or you can click on any file or match to open the Orion editor to see the whole file at that line. The page is designed to display multiple pages if the result files exceeds 40. There are previous and next page actions in the tool bar for you to go through all the results.

Orion-search-ResultOverview.png

Starting search

Starting search is very simple: just type or paste a keyword in the search entry field and hit enter. The result will be displayed in the same tab of your browser where you entered the keyword. The header of the result displays the total file number and the number range of the first page. Both literal and wild card search are supported. For example, "fo*ar" will hit all the files containing "foobar" while "fo??ar" will hit the same files. Please also note that the search ignores case.

Search starting search.png

Search scopes

If you start a search from a page where a folder is presented, or in another word, if bread crumb is presented, the search entry field hints where your search will start. Currently the pages supporting this are navigator, git log, editor and search pages. For all other pages, the search will start from the project root. But once you are in the search result page, you can scope your search up and down on the same keyword.

Search scope overall.png

Scoping down

Lets assume that you 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. 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.

Search scope down.png

Scoping up

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

Search scope up.png

Saving search

Click Save Search in the tool bar to bookmark a link to this search for future use. Lets say you are searching "foo" on folder "bar". The default name of the saved search is "foo in bar" but you can rename it later to a more meaningful one. Note that this is a bookmark to the search, rather than a specific search result. Clicking on a link in the Searches list of the Favorites panel will perform a new search with the same search terms.

Search save search.png

Navigating matches

There are 4 actions in the tool bar for navigating matches. Expand all and Collapse all are convenient actions to view all matches or just view the file list. Up and Down allow you to just iterate all the files and matches top-down or bottom-up. While you are iterating, the current cursor 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.


Key board navigation

Viewing details

Navigating pages

Sort by name or location

Stale files

Current limitation

Replace page

You can replace all or part of the matches by a new string. The replace page displays all the files in a similar way as the result page does but in a addition to that you can use check box to quickly toggle the all, file and match levels. Please also note that if there are multiple matches in a single line, it will be "split" to multiple lines where you can filter on each match you want.

Invoking replace

Filtering matches

Viewing differences

Replacing page by page

Committing changes

Report page