[MRM-966]

submitted by Jevica Arianne Zurbano
- added advanced search in documentation

additional changes:
- updated the screenshots submitted to reflect the changes in the ui

git-svn-id: https://svn.apache.org/repos/asf/archiva/trunk@708759 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/archiva-docs/src/site/apt/userguide/searching.apt b/archiva-docs/src/site/apt/userguide/searching.apt
index 817bd55e82d63f7a42b2c7ac47d744f17135770e..38fd7e589bf36ab4b385de6503e014e7527477f3 100644 (file)
--- a/archiva-docs/src/site/apt/userguide/searching.apt
+++ b/archiva-docs/src/site/apt/userguide/searching.apt
@@ -48,12 +48,22 @@ Searching
 **/*.tld
 +-----+
 
+* Quick Search
+
   The contents of all the files in the repository that matches the above configuration will be indexed during repository
   scan. So when you type a word in the search box, Archiva will search the index for that query string and return all the
-  search hits in the form of a list of artifacts. For example you typed in 'classworlds', the search result would contain
-  the list of artifacts that use or reference 'classworlds'.
+  search hits in the form of a paginated list of artifacts. For example you typed in 'ant', the search result
+  would contain the list of artifacts that use or reference 'ant'.
+
+  Archiva can also search the index for java classes, packages, and methods and return a list of artifacts containing the
+  query string. To do a quick search of java classes, packages, or methods, append the word 'bytecode:' before the query
+  string in the search box. For example, 'bytecode:myMethod'.
+  
+  The 'Search Results Only' option saves the previous search criteria and use it together with the new query string for
+  searching. When the user types a word in the search box, 'launcher' for example, Archiva will search the query string
+  from the previous list of search hits and return a new paginated list of artifacts.
 
-  Below is a sample screenshot of the search results:
+  Below is a sample screenshot of the search results with 'Search Results Only' option selected:
 
 [../images/search-results.jpg] Search Results 
 
@@ -61,6 +71,16 @@ Searching
   page (the same page from the Repository Browse). Otherwise if it is not a pom file (ex. metadata.xml), the file will
   appear as a file to be downloaded from the browser.
 
+* Advanced Search
+
+  The Advanced Search feature allows user to narrow down the search by specifying the criteria such as group id,
+  artifact id, version, class or package, and the repository to be searched. This feature also provides the user the
+  option to configure the pagination of results by specifying the number of hits to be displayed in each page.
+  
+  Below is a sample screenshot of Advanced Search:
+
+[../images/advanced-search.jpg] Advanced Search screen 
+
 * Security
 
   The Search functionality respects the repository permissions. If the user is not logged in to Archiva and does a search,

diff --git a/archiva-docs/src/site/resources/images/advanced-search.jpg b/archiva-docs/src/site/resources/images/advanced-search.jpg
new file mode 100644 (file)
index 0000000..096d616
Binary files /dev/null and b/archiva-docs/src/site/resources/images/advanced-search.jpg differ

diff --git a/archiva-docs/src/site/resources/images/search-results.jpg b/archiva-docs/src/site/resources/images/search-results.jpg
index 709b9a2026ee404fbfe950901de4959d7827fad3..5f0347aa16033ec01a1274857490b7bb4e52f75a 100644 (file)
Binary files a/archiva-docs/src/site/resources/images/search-results.jpg and b/archiva-docs/src/site/resources/images/search-results.jpg differ