yawk's User Interface
Wiki Navigation
yawk shows only it's navigator at each wikifile's top and at the bottom. If the user's browser supports it, the bottom navigator is fixed to the window bottom.
The navigator functions are
| Link | Description | Key |
| Index | display the wiki's index file | I |
| List | list the files in the current directory | L |
| Edit | open the current file to edit it | E |
| Info | show some information about the file and display some addional functions | O |
| Search | display the search input form | S |
| PNX | display prev/next navigation | - |
| R | reload the current file | - |
| X | close the search result frame after framed search | - |
Not all links are available all the time, e.g. X is only displayed after a search that displays the results in a framed window.
Split Screen
By following the Split Screen link on a wikifile's infopage yawk split the browser window into two (left and right) frames. Both frames can then be used independantly from each other.
Search Interface
One of yawk's functions is the search engine. The input form can be displayed by either following the Search link from the wiki navigation or on the wikifile's infopage (displayed with Info).
The wiki search is a combined (non-indexed) full text search with an additional (optional) regular expression search. The full text engine searches the directory where the search starts and any subdirectories. Results are usually ordered by relevance (document score divided by file size), regexp search looks for regular expressions in the matching files and display short linked excerpts of the matching text.
| Input Field | Function |
| Expression | is the input field for the relevance full text search. Files matching the expression are listed by relevance. Usually it's enough to enter the search words into this input field without any operators. However, an explanation of search expressions is available. |
| Pattern | input field for a regular expression. |
| Display results in tree | if this option is checked, the results are listed in their directory tree context, not ordered by relevance. |
| Search whole server | searches the whole wikispace, not only the directory from where the search form is called. |
| Open new window | if checked the search result listing are displayed in a new window. |
| Framing | controls how the search results are displayed. Possible options are
The last two options are only available in split screen mode.
|
| Results | select how much text should be returned for each document matching the relevance search expression. |
If only a regular expression is given yawk searches only the files in the current directory.