-added content for search page

-added screenshot for the search results which is reference in the search page

git-svn-id: https://svn.apache.org/repos/asf/maven/archiva/trunk@597618 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 dd1cf04edff3c4fafafc531f7bca2f852581018a..817bd55e82d63f7a42b2c7ac47d744f17135770e 100644 (file)
--- a/archiva-docs/src/site/apt/userguide/searching.apt
+++ b/archiva-docs/src/site/apt/userguide/searching.apt
@@ -1,8 +1,69 @@
  ------
  Searching
  ------
+ Maria Odea Ching
+ ------
+ 23 Nov 2007
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements.  See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership.  The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License.  You may obtain a copy of the License at
+~~
+~~   http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied.  See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
 
 Searching
 
-  :STUB: This is a documentation stub.
+ The Search functionality of Archiva allows a user to search for specific artifact references in the repository.
+
+* What Can Be Searched?
+
+  The repository files that are indexed during repository scan can be configured in the Repository Scanning page, in the
+  Repository Scanning - File Types section (indexable-content). By default, the indexable-content file types are:
+
++-----+
+**/*.txt
+**/*.TXT
+**/*.block
+**/*.config
+**/*.pom
+**/*.xml
+**/*.xsd
+**/*.dtd
+**/*.tld
++-----+
+
+  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'.
+
+  Below is a sample screenshot of the search results:
+
+[../images/search-results.jpg] Search Results 
+
+  When the user clicks a specific artifact in the search results list, Archiva will direct the user in the Artifact Info
+  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.
+
+* Security
 
+  The Search functionality respects the repository permissions. If the user is not logged in to Archiva and does a search,
+  only those repositories with guest permissions will be searched for the query string. And if the user is logged in to
+  Archiva and does a search, only those repositories in which that user has permission to access will be searched for the
+  query string.

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