Dictionary

Access Keys

yawk supports access key for navigation. The most common are

Access Keys

I	Opens index file
L	Show list of files
E	Edit file
S	Open search form
F	Open infopage
P	Previous file (if defined)
N	Next file (if defined)
T	Table of Contents (if defined)

Notice that these are only default values.

Display Modes

In addition to the normal browser display mode yawk supports some other:

sidebar

For usage as browser sidebar smaller font, different framing options, see Sidebar Mode.

plain

Made for ASCII browser, no special font settings, no framing.

pda

Currently like the plain mode.

crawler

This is a special mode for webcrawler to keep them from entering infinite index loops. The crawler mode limits the links to only static links (list and browse modi are possible) and allows no URL options (see Search Engines).

Note that not all of the modes are fully tested.

Javascript Support

yawk has support Javascript in several ways:

Wiki Markup

The wiki parser support Javascript code before form elements or hyperlinks:

{{ javascript-code }} form-element | hyperlink

where form-element is one of the :" sequences. hyperlink must be a hyperlink markup sequence using angle brackets [[ link ] text ]. Notice that double curly braces are als used for style definitions, see Stylesheets.

Adding Scripts

Complete Javascript files can be configured with script configuration option

BODY Handler

A Javascript eventhandler for the HTML BODY can be set with the handler configuration option:

handler onDblClick = 'windows.location.href="?op=info#search"'

The argument string to handler is added as-is to the wikifile's BODY tag.

Regular Expression Search

In addition to it's relevance search yawk offers a regular expression search which is applied to the documents that already matched the full-text expression. In return yawk lists short linked text excerpts from the matching documents.

Relevance Search

yawk's primary search engine is a non-indexed full-text search engine. This engine support advanced expressions but usually it's enough to just type the search word into the input field and to press return. yawk returns then the matching documents by relevance (document score divided by relevance). The relevance search searches the whole wikispace.

Script History

This is the unofficial script history. I think there are more changes but these are all I remember.

wiki-parser

• Fixed bug in ---[1-6].
• ---* text is now a <P CLASS="sectionheader">.
• Added ."E and ."U FORM sequences.
• Added -L option to list the links in the wikifile.
• The first -%class= in an unordered list assigns class also to the list.
• Added the regular expression "[a-z][a-z0-9]*://" as protocol identifier to the automatic hyperlinker,
• ---: can be followed immediatly by a # to get line numbers.
• ---: can be followed by the double quoted string "title-string" to set and output a title below the preformatted block.

wiki-relsearch

• Lines beginning with a parser option (regexp: /^:[a-z]/) are not longer removed from the text before searching.
• Added the ,, operator and made this the default.
• The search expression can now be given as first command line argument behind any options.
• Filename and relevance data are now separated by a tab (separator was a blank). This allows filenames with blanks.

Sidebar Mode

One of yawk special display modes: a smaller font only up/down and down/up framing modes when searching. Using "new window" as frame option opens all found documents in separate normal browser windows. The easiest way to get to the sidebar mode is by following the "Bookmark as sidebar" mode from a wikifile's infopage.

Search Engines

Although search engines are really useful things they are also pretty difficult to handle.

1. Search engines get easily lost with yawk's URL options. E.g. they don't undestand that a wikifile has the same content in both halfs of the split screen layout althoug the URLs are different. yawk addresses this by not accepting requests from search engines that have the op CGI variable to a value other the list or browse set. yawk refuses also crawler requests with one of the various wiki options turned on. In both cases the request is redirected to the regular wikifile without any option or any operation set.

2. Sometimes wikifiles are removed. If the a search engines webcrawler comes back to index a deleted file it will get usually a positive response with an empty page from the wiki. This can be changed by setting the send-404 option to yes. If set, any request to a non-exsting file result in a 404 response.

Wikispace

This is the configured wiki directory (see dir configuration option) and all subdirectories. yawk will serve any file in the wikispace if requested, excluding only files that start with a dot.