Migrating wiki contents from Google Code

GettingStarted.md

@@ -0,0 +1,25 @@
+# Introduction #
+
+TapirWiki is a wiki engine for couchDB. It's all HTML and Javascript - a couchapp! All the pages are stored in couchDB.
+
+
+# Installing #
+To use TapirWiki you need couchapp.
+
+  1. Install couchapp - Instructions are [here](http://github.com/couchapp/couchapp) (section 3).
+  1. Download the wiki.zip file from the project site
+  1. Extract the zip and fire up a terminal, cd into the wiki folder
+  1. Enter the following command: couchapp init
+  1. Enter the following command: couchapp push http://127.0.0.1:5984/wiki
+  1. Open your new wiki at http://127.0.0.1:5984/wiki/_design/tapir/wiki.html
+
+TapirWiki will set up a few default pages for you, refresh the page and you should be in to your new wiki! More help is provided within TapirWiki itself.
+
+
+## Development (trunk) version ##
+
+You can also grab the latest trunk version from the code repository at http://code.google.com/p/tapirwiki/source/checkout instead of the zip file referred to above and have access to all the latest features. Please note however that there are two branches in the repository, after cloning the repository you still need to issue an `hg update dev` command as the trunk is on the dev branch and if you clone the repository your working file set is by default a checkout of the latest change set of the default branch.
+
+## Virtual Appliance ##
+
+Another alternative is to download the [tapirwiki virtual appliance](http://oeo.la/_UWcx_) created and tested with [VirtualBox](http://www.virtualbox.org). This gives you a fully configured system (including indexing and searching) with a pre-installed wiki (called tapirwiki). If you want to create new wiki's, you can replicate this wiki within the same database using the 'replicator' available in futon (`http://ip-of-virtual-appliance:5984/_utils`) or you can 'couchapp push' from your host. The latter option would require couchapp installed and downloaded tapirwiki code on the host system.

ProjectHome.md

@@ -0,0 +1,12 @@
+# About TapirWiki #
+TapirWiki is a pure HTML / Javascript wiki which uses CouchDB as the server and data store. It's a single HTML file which you can upload for an ad-hoc, quick and dirty wiki.
+
+TapirWiki is a couchapp. You will need couchapp to install TapirWiki into CouchDB. See the blog for more info.
+
+## Screenshot ##
+This is a fresh install of TapirWiki!
+![http://tapirwiki.googlecode.com/files/Screen%20shot.png](http://tapirwiki.googlecode.com/files/Screen%20shot.png)
+
+This is a very early version, released for testing. It's fair to say this is a bit experimental - please report any issues or problems!
+
+Have a look at the TapirWikiFeatures to see what you can do with your wiki!

TapirWikiFeatures.md

@@ -0,0 +1,14 @@
+# Features #
+Here is a list of the things TapirWiki can do!
+
+  * Easy to install, just upload one html file to your couchDB
+  * Add / edit / delete pages
+  * Wiki formatting based on textile
+  * Automatic links to other wiki pages from BandgedTogetherWords
+  * Page history shows previous versions of your pages
+  * Support for multiple template pages which provide content for new pages
+  * Support for macros to list all pages or recent changes, or all pages which start with a given string (e.g. list all pages which start HelpOn...)
+  * Include a page content on another page
+  * Support for couchDB replication so that changes from one wiki can be replicated to another. TapirWiki provides 2-way replication / synchronisation to allow local and central wiki's to be kept up to date.
+  * Customisable menu so you can provide easy links to your own pages
+  * Comments when creating / editing pages

Todo.md

@@ -0,0 +1,21 @@
+# TapirWiki Todo List and Feature Requests #
+
+This page lists the feature requests for TapirWiki. If you want to help implement any of these,  let me know.
+
+
+# ToDo #
+
+## Search ##
+  * Would be useful to be able to search wiki pages for text
+## Install / upgrade page ##
+  * Remove the need to go to Futon each time a new version is released...
+## MarkDown support ##
+  * Apart from Textile also support the MarkDown markup language -> add a parser, and a renderer or perhaps generalize the renderer to a lightweight markup language to html renderer so that it can work with both.
+  * Put parsing/rendering at the server side?
+## Bread crumbs ##
+  * Could be path traversed or perhaps shortest path from its root (according to some algorithm), or both.
+  * Perhaps some contents page of the entire wiki with structure, not just an index
+## Fields ##
+  * Would be nice to be able to define fields that correspond with !CouchDB fields. Or when creating a page you can indicate according to what field template (normal wiki page or wiki page with certain added fields). In edit mode you should be able to set the fields, in display mode you can render the fields inside the wiki page with a macro. Macro's can then also be designed to summarize fields using views or other server side routines.
+## Cancel Button ##
+  * Cancel button while in edit mode.