From 00a49e84f28ca2d06f2ce77e90909da2ef52f94d Mon Sep 17 00:00:00 2001 From: William Schaefer Date: Tue, 1 May 2018 12:33:47 -0400 Subject: [PATCH] 3804 rename search feature for ui from quick search to ui quick search in docs --- docs/doxygen-user/case_management.dox | 2 +- docs/doxygen-user/communications.dox | 2 +- docs/doxygen-user/main.dox | 2 +- docs/doxygen-user/quick_start_guide.dox | 2 +- docs/doxygen-user/timeline.dox | 2 +- docs/doxygen-user/{quick_search.dox => ui_quick_search.dox} | 6 +++--- 6 files changed, 8 insertions(+), 8 deletions(-) rename docs/doxygen-user/{quick_search.dox => ui_quick_search.dox} (54%) diff --git a/docs/doxygen-user/case_management.dox b/docs/doxygen-user/case_management.dox index 48e2fbc2fa..b4d9d0daba 100644 --- a/docs/doxygen-user/case_management.dox +++ b/docs/doxygen-user/case_management.dox @@ -34,7 +34,7 @@ To open a case, either: "Open Recent Case" will always bring up a screen allowing you to select one of the recently opened cases. "Open Case" will do one of two things; - If multi-user cases are not enabled, it will bring up a file chooser that can be used to browse to the ".aut" file in the case directory of the desired case -- If multi-user cases are enabled, it will bring up the multi-user case selection screen. This uses the coordination services to find a list of multi-user cases. If needed, the "Open Single-User Case" button can be used to bring up the normal file chooser. The multi-user case selection screen has a \ref quick_search feature which can be used to quickly find a case in the table. The following shows the multi-user case selection screen: +- If multi-user cases are enabled, it will bring up the multi-user case selection screen. This uses the coordination services to find a list of multi-user cases. If needed, the "Open Single-User Case" button can be used to bring up the normal file chooser. The multi-user case selection screen has a \ref ui_quick_search feature which can be used to quickly find a case in the table. The following shows the multi-user case selection screen: \image html multi_user_case_select.png diff --git a/docs/doxygen-user/communications.dox b/docs/doxygen-user/communications.dox index 2080f910e5..ced0a044d3 100644 --- a/docs/doxygen-user/communications.dox +++ b/docs/doxygen-user/communications.dox @@ -20,7 +20,7 @@ The middle column displays each account, its device and type, and the number of Selecting an account in the middle column will bring up the messages for that account in the right hand column. Here data about each message is displayed in the top section, and the messages itself can be seen in the bottom section (if applicable). -The middle column and the right hand column both have a \ref quick_search feature which can be used to quickly find a visible item in their section's table. +The middle column and the right hand column both have a \ref ui_quick_search feature which can be used to quickly find a visible item in their section's table. \image html cvt_messages.png diff --git a/docs/doxygen-user/main.dox b/docs/doxygen-user/main.dox index f03ad68041..8aabf7a03b 100644 --- a/docs/doxygen-user/main.dox +++ b/docs/doxygen-user/main.dox @@ -39,7 +39,7 @@ The following topics are available here: - \subpage tree_viewer_page - \subpage result_viewer_page - \subpage content_viewer_page - - \subpage quick_search + - \subpage ui_quick_search - \subpage image_gallery_page - \subpage file_search_page - \subpage ad_hoc_keyword_search_page diff --git a/docs/doxygen-user/quick_start_guide.dox b/docs/doxygen-user/quick_start_guide.dox index e1bece678b..b12c65c2a3 100644 --- a/docs/doxygen-user/quick_start_guide.dox +++ b/docs/doxygen-user/quick_start_guide.dox @@ -59,7 +59,7 @@ If you are viewing files from the Views and Results nodes, you can right-click o If you want to search for single keywords, then you can use the search box in the upper right of the program. The results will be shown in a table in the upper right. -The tree on the left as well as the table on the right have a \ref quick_search feature which can be used to quickly find a visible node. +The tree on the left as well as the table on the right have a \ref ui_quick_search feature which can be used to quickly find a visible node. You can tag (bookmark) arbitrary files so that you can more quickly find them later or so that you can include them specifically in a report. diff --git a/docs/doxygen-user/timeline.dox b/docs/doxygen-user/timeline.dox index f992c57d26..d55f9a43bf 100644 --- a/docs/doxygen-user/timeline.dox +++ b/docs/doxygen-user/timeline.dox @@ -69,7 +69,7 @@ The __Counts View__ shows a stacked bar chart. Use this type of graph to show ho The __Details View__ shows individual or groups of related events. Date/time is represented horizontally along the x-axis, but the vertical axis does not represent any specific units. You would use this interface to answer questions about what specific events happened in a given time frame or what events occurred before or after a given event. You would generally use this type of interface after using the Counts View to identify a period of time that you wanted details on. There can be a lot of details in this view and we have introduced zooming concepts, as described in the next section, to help with this. -The table on the bottom left hand side of the panel has a \ref quick_search feature which can be used to quickly find a node in the table. +The table on the bottom left hand side of the panel has a \ref ui_quick_search feature which can be used to quickly find a node in the table. Visualization settings ---------------------- diff --git a/docs/doxygen-user/quick_search.dox b/docs/doxygen-user/ui_quick_search.dox similarity index 54% rename from docs/doxygen-user/quick_search.dox rename to docs/doxygen-user/ui_quick_search.dox index e1bb65248a..901427243e 100644 --- a/docs/doxygen-user/quick_search.dox +++ b/docs/doxygen-user/ui_quick_search.dox @@ -1,10 +1,10 @@ -/*! \page quick_search Quick Search +/*! \page ui_quick_search UI Quick Search -The quick search feature allows you to search within the data on a panel for a given string, it will not search data in hidden columns or collapsed nodes. +The user interface quick search feature allows you to search within the data on a panel for a given string, it will not search data in hidden columns or collapsed nodes. How to use it ----- -In order to use the search you need to select any item in the area you wish to search, and start typing. If quick search is available in the area you have selected a search field will appear in the bottom left hand corner of the area. As you type the string you are searching for it will auto-update to select one of the results which matches your string. You can switch between the results which match the string you have typed with the up and down keys. The search does not support the use of regular expressions but will match against any sub-sting in the fields it searches, not just at the beginning of the field. +In order to use the search you need to select any item in the area you wish to search, and start typing. If user interface quick search is available in the area you have selected a search field will appear in the bottom left hand corner of the area. As you type the string you are searching for it will auto-update to select one of the results which matches your string. You can switch between the results which match the string you have typed with the up and down keys. The search does not support the use of regular expressions but will match against any sub-sting in the fields it searches, not just at the beginning of the field. \image html quick_search_result.PNG Configuration