Kvikki - A Simplicistic Wiki

A Simplicistic Wiki

Kvikki is a very simple Wiki that is written in Scheme.

Things you can do with Kvikki include:

• Create and edit pages using a simple markup language
• Upload files
• Change the style of the Wiki using CSS
• Search Wiki pages

The Kvikki homepage is here: http://www.t3x.org/bits/kvikki/[^]

The source code is here: kvikki.tgz[^] (~15KB)

Configuration

1. Scheme Part

If you are using one of the supported Scheme systems, simply comment out the section for your system in kvikki.scm. Otherwise you will have to supply procedures performing the following tasks:

• retrieve the value of an environment variable (getenv)
• retrieve a list of command line arguments (command-line, semi-optional)
• create a lock file (lock-file, optional)
• remove a lock file (unlock-file, optional)

Getenv is the only one of these procedures that definitely is required.

Page locking only works in S9fES at the moment. In other implementations lock-file and unlock-file do nothing. If you want page locking, you have to invent something on your own. S9fES uses a Scheme wrapper around the mkdir() system call, which is atomic on most systems.

Command-line may be a stub returning (). It is only used to activate the page dump utility.

2. Configuration File

The configuration file kvikki.conf is an ASCII file consisting of key/value pairs. Keys are separated from values using TAB characters.

There are only two entries:

 root    <root directory>
 title   <title>

Replace <root directory> with a directory where your Kvikki documents will reside and <title> with the title that shall be display at the top of each Kvikki page.

3. CGI File

The file kvikki.cgi is used to run the Kvikki program inside of your Scheme environment. Just uncomment the line for your system or create one.

4. Style Sheet

Using a style sheet is recommended. Either use one of those that come with Kvikki or create your own one.

5. Required Files

These files must go to the Kvikki directory:

 first_steps
 footprints.png
 kvikki.cgi
 kvikki.conf
 kvikki.css
 kvikki.scm

Using Kvikki

To the user a Kvikki page looks exactly like an HTML page with some additional knobs at the bottom. These knobs activate the Kvikki functions.

• Edit edits the current page
• Upload allows to upload files
• Style edits the style sheet
• Search opens the search form
• Main goes to the main page
• First Steps loads a brief guide to editing Kvikki pages
• About Kvikki loads the inevitable credits

The First Steps pages is special. It cannot be modified, thereby allowing users to view it without having to worry about breaking it.

Dumping Pages

You can create an HTML dump of all pages in your wiki using the command

 your-scheme kvikki.scm -d main

(where your-scheme obviously is your scheme system). This command will create a file named name.html for each wiki page file name.

Terms of Use

Kvikki - A Simplicistic Wiki - Copyright (C) 2007 Nils M Holm[^]

Don't worry, be happy.

Disclaimer:

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.