http://www.soks.org and http://rubyforge.org/projects/soks/
WHAT IS NEW?
The last time I announced this to the mailing list Soks was at v0-0-2. The changes since then are listed on http://www.soks.org/view/ListOfChanges but can be summarised as:
* Lots of bugfixes and associated tests
* Now permits any letters and punctuation in a page title
* Can now cache data when shutdown to allow faster start-up (useful for personal wikis)
* Some new Automatic helpers that can do wiki maintenance, import mail and rss feeds and do page popularity statistics.
WHAT IS IT?
Soks is yet another wiki. Sorry about that. It was written mainly for my own gratification and in no way reflects on the quality of other wikis available[1], nor on the fact that my time could probably have been better spent on improving one of them. As is always the way, none of them was quite right for me, and I've been enjoying using it to learn ruby.
What was right for me?
* Automatic linking between pages (no need for wiki words or any bracket shenanigans).
* Easy to add, move and delete pages
* (very) flat file storage. You can edit the content in a text editor and Soks will see the changes and update.
* Uploads and Images
* Various sorts of authentication
* Easy to customise the look
* RSS feeds
* An api for classes to interact with the wiki. Some of the classes included that use it are:
** AutomaticSummary.new(wiki,'Known Bugs') { |page| page.name =~ /^Bug:/ } # Keeps a page of known bugs
** Mail2WikiHelper.new( wiki, :server => 'imap.server', :username => 'user', :password => 'password', :mailbox => 'test') # Transfers messages from mailbox to wiki
** AutomaticCalendar.new(wiki) and AutomaticUpcomingEvents.new(wiki,calendar)
Why might it not be right for you?
* It uses webrick and cannot run directly as a cgi or fcgi
* It loads the entire site into memory (may be a problem for small virtual servers)
* It isn't fast
* It has bugs (although I don't know of any serious ones at the moment)
Some of that might be right for you to, if so I'd be grateful if you would give it a go (instructions below) and let me know how you get on / what you think.
For every feature there is, off course, a bug. Current known ones are listed at http://www.soks.org/view/KnownBugs please report any new ones you spot.
HOW TO USE?
Best installed by a ruby gem:
1. gem install Soks
2. soks-create-wiki.rb (will create a folder called soks-wiki in the
current directory)
3. http://localhost:8000
Otherwise install by
1. Download the tar or zip from http://rubyforge.org/projects/soks/ ,
2. untar or zip,
3. cd Soks-0.0.2,
4. ruby bin/soks-create-wiki.rb (will create a folder called soks-wiki
in the current directory)
5. http://localhost:8000
To restart
A. soks-create-wiki.rb (will not recreate the wiki if the folder
soks-wiki already exists in the current directory)
OR B. ruby soks-wiki/start.rb
To allow the site to be accessible from beyond localhost:
1. cd soks-wiki
2. edit start.rb
3. Tinker with the settings...
HOW TO HACK?
A. Have a look at the start.rb file in your soks-wiki directory. Lots of things you can change
there.
B. Read http://www.soks.org/view/HowToHackSoks
HOW TO FEEDBACK?
Let me know what you think:
A. Directly at tamc@rubyforge.org
B. Indirectly on the soks-discuss mailinglist at rubyforge
C. Publicly on the http://www.soks.org wiki.
Thanks
Tom
[1] You may like to consider these other fine ruby wikis that I know about:
* http://www.instiki.org and its brother http://rubyforge.org/projects/pimki/
* http://rubyforge.org/projects/ruwiki/
* http://www.hieraki.org/trac/
* http://wiki2go.nayima.be/
* http://rubyforge.org/projects/minirubywiki
* http://210.253.233.99/cgi-bin/tiki/tiki.cgi
* ... probably others.