#%env/templates/metas.template%#
#%env/templates/header.template%#

## Help

This is a distributed web crawler and also a caching HTTP proxy. You are using the online-interface of the application. You can use this interface to configure your personal settings, proxy settings, access control and crawling properties. You can also use this interface to start crawls, send messages to other peers and monitor your index, cache status and crawling processes. Most important, you can use the search page to search either your own or the global index.

For more detailed information, visit the YaCy homepage.

### Local and Global Search: Options and Functions

The proxy provides a search interface that accesses your local index, created from web pages that passed the proxy. The search can also be applied globally, by searching other peers. You can use the following options to enhance your search results:

Search Word List
  You can search for several words simultanous. Words must be separated by a single space. The words are treated conjunctive, that means every must occur in the result, not any. If you do a global search (see below) you may get different results each time you do a search.
Maximum Number of Results
  You can select the number of wanted maximum links. We do not yet support multiple result pages for virtually any possible link. Instead we encourage you to enhance the search result by submitting more search words.
Result Order Options
  The search engine provides an experimental 'Quality' ranking. In contrast to other known search engines we provide also a result order by date. If you change the order to 'Date-Quality' the most recently updated page from the search results is listed first. For pages that have the same date the second order, 'Quality' is applied.
Resource Domain
  This search engine is constructed to search the web pages that pass the proxy. But the search index is distributed to other peers as well, so you can search also globally: this function is currently only rudimentary, but can be choosen for test cases. Future releases will automatically distribute index information before a search happends to form a performant distributed hash table -- a very fast global search.
Maximum Search Time
  Searching the local index is extremely fast, it happends within milliseconds, even for a large number (millions) of pages. But searching the global index needs more time to find the correct remote peer that contains best search results. This is especially the case while the distributed index is in test mode. Search results get more stable (repeated global search produce more similar results) the longer the search time is.

#### Accesskeys

You may want to use accesskeys to navigate through the YaCy webinterface:

- Windows and Internet Explorer: Alt + Accesskey + Enter
- Windows and Mozilla/Firefox/Netscape: Alt + Accesskey
- Windows and Opera: Shift + Esc + Accesskey
- Macintosh and Internet Explorer: Strg + Accesskey + Enter
- Macintosh and Safari: Strg + Accesskey
- Macintosh and Mozilla/Firefox/Netscape: Strg + Accesskey
- Macintosh and Opera: Shift + Esc + Accesskey
- Linux Mandrake and Galeon/Mozilla: Alt + Accesskey
- All OS and Amaya: Strg + Accesskey

s
  Search Page
n
  News
w
  Network
t
  Status

#### Regular Expressions

YaCy uses Regular Expressions for some functions, for example in the blacklist.

There are some standards for these regexps, YaCy uses the syntax used by Perl 5.

Here ist a short overview about the functions, which should fir for most cases:

.
  arbitrary character
x
  character x
[^x]
  not x
x*
  0 or more times x
x?
  0 or 1 time x
x+
  1 or more times x
xy
  concatenation of x and y
x|y
  x or y
(foo|bar)
  String "foo" or string "bar"
[abc]
  a or b or c (same as a|b|c)
[a-c]
  a or b or c (same as above)
x{n}
  exactly n appearances of x
x{n,}
  at least n appearances of x
x{n,m}
  at least n, maximum m appearanches of x
( )
  Modify priority of instructions
\
  Escape-Character, used to escape special characters (for example "[" or "*"), so that they loose their special meaning

Regex follow a special priority (descending): concatenation, unary operators (*,+,^,{}), binary operators (|). This can be overridden with brackets.

Example:

`.*heise.de/.*/[0-9]+`

This matches heise.de/ with a string in front of it, for example "http://www.", followed by any string, then a slash and a number. The dot in "heise.de" is not escaped with "\", because it represents any character, thus the "." itself, too.

A possible URL which would match this regexp is: http://www.heise.de/newsticker/meldung/59421

An URL which would not match is: http://www.heise.de/tp/r4/artikel/20/20701/1.html

There is ".html" at the end, which is not included with the Regular Expression.

#%env/templates/footer.template%#