h1. SOKS: Another Ruby Wiki

* This application is a Wiki (a system to allow the easy and collaborative editing of web pages).
* The project has been kindly hosted at http://rubyforge.org/projects/soks/

Quickstart:
1. gem install Soks
2. soks-create-wiki.rb
3. http://localhost:8000

h2. REQUIRES

* Ruby 1.8.2
* A number of additional libraries are contained in contrib. 

h2. AUTHOR

* This software is copyright (c) Thomas Counsell 2004, 2005. tamc@rubyforge.org 
* It is licensed under the Ruby Licence, a liberal open source licence.  See LICENCE for more details.

h2. INSTALL

Preferably:
1. Install rubygems from http://rubyforge.org/projects/rubygems/
2. gem install Soks (you may need to be root first)

Alternatively
1. Download the tar or zip file from http://rubyforge.org/projects/soks/
2. Unzip or untar it
3. Change into the soks directory

h2. USE

execute soks-create-wiki.rb (will be in your path if installed by gems, otherwise ./bin/soks-create-wiki.rb from the soks directory)
This will create a folder called soks-wiki in the current directory and launch the wiki.  Surfing to http://localhost:8000 to see it (it is initially accessible from localhost only)

To restart the wiki change into the soks-wiki directory and execute ruby start.rb

To change the settings (url, port, etc) edit the start.rb file in the soks-wiki directory.

h2. FEATURES

  1. Runs on its own webrick server (no independent web server required)
  2. Uses textile as its text coding (a proto-standard) 
  3, Uses a combination of flat and yaml files for storage (no database, and page content human readable outside of soks)
  3. Allows uploads
  4. Allows authentication
  5. Automatically links pages within the wiki
  6. Pages can be deleted and moved easily (and these can be undone)
  7. Has a mechanism for external classes to manipulate the wiki to provide, for instance, automatic calendar pages, or automatic summaries or blog like pages.

h2. BUGS

I suspect there are many, as befits its version number.  In particular it has:
* Not got any way of securing pictures or attachments added to the wiki
* Uses RedCloth 2.0.11 which has some formatting bugs (and no doubt some extra ones introduced by my clumsy extentions).  RedCloth 3.0.1 is included but not enabled because it tends to hit stack overflows frequently for me.

h2. RELEASES

2005 Jan 24 - soks-0.0.3 - Second public release  (alpha)
2005 Jan 11 - soks-0.0.2 - First public release (alpha)