Release Name: v0-0-5
Notes:
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:
# gem install Soks
# soks-create-wiki.rb
# 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:
# Install rubygems from http://rubyforge.org/projects/rubygems/
# gem install Soks (you may need to be root first)
Alternatively
# Download the tar or zip file from http://rubyforge.org/projects/soks/
# Unzip or untar it
# 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
# Runs on its own webrick server (no independent web server required)
# Uses textile as its text coding (a proto-standard)
# Uses a combination of flat and yaml files for storage (no database, and page content human readable outside of soks)
# Allows uploads
# Allows authentication
# Automatically links pages within the wiki
# Pages can be deleted and moved easily (and these can be undone)
# 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:
* No authentication on pictures and attachments
* Punctuation in page titles problematic. ? <> and [] cause problems. : and / are ok.
* Insert page commands are not inhibited by notextile, pre or code tags
h2. RELEASES
# 2005 Feb 12 - soks-0.0.5 - Third public release (alpha)
# 2005 Jan 24 - soks-0.0.4 - Second public release (alpha)
# 2005 Jan 11 - soks-0.0.2 - First public release (alpha)
Changes:
h1. List of changes
h2. Between v-0-0-5 and v-0-0-4
h3. Features
* Now uses Redcloth v3, and therefore can have some markdown styles as well as textile on the same page
* Roughed up two more automatic helpers: rss2wiki that writes the content of a rss feed to a wiki page, and mail2wiki that watches an imap mailbox and adds any messages in it to the wiki. Both work, but are probably not ready for prime time.
* Note I have removed the feature in v-0-0-4 that would merge any changes by the same author within 5 minutes, as it seemed to cause some confusion with end users.
h3. Refactoring
* Helpers have been moved to a separate sub directory
* A module in soks-view that can be used by the erb template. Has functions for creating urls for pages. The default template has been updated to use this, but not the other templates.
h3. Bug fixes
* Fatal bug when renaming picture or attachment pages fixed.
* References to urls no longer include trailing punctuation
* Authenticators no longer call depreciated base64 method
* Now has (partial) support for robots.txt and favicon.ico
* Search box no longer treats leading and trailling spaces as significant
* Returns a page not found rather than an exception if an unknown view type is requested
h3. Bugs remaining
* No authentication on pictures and attachments
* Punctuation in page titles problematic. ? <> and [] cause problems. : and / are ok.
* Insert page commands are not inhibited by notextile, pre or code tags
h2. Between v-0-0-4 and v-0-0-3
This was a bugfix release on v-0-0-3. Principally by adding locking code so two pages can't update the same page at the same time.
h2. Between v-0-0-3 and v-0-0-2
h3. Features
* File format for revisions changed from marshalled array of revisions to a yaml'd array of strings and times. This should allow easier import/export.
* Changes to the files on disk appear in the wiki (by default checks for changes on disk every 60 seconds) to allow external editing of the wiki.
* New way of making new pages: highlight the text you wish to link and press crtl-n. This only works on some browsers.
* RSS feed for changes made to any page (use the RSS feed on Recent Changes to be notified of all changes to the site, use the RSS feed on Site Index to be notified of new pages).
* Added a WikiWord link for those that don't like to give out links with %20's in them. e.g. http://yoursite.com/wiki/HomePage redirects to http://yoursite.com/view/Home%20Page.
* The automatic summary class has been extended to allow summary based on the page title, page author, or page content.
* Different parts of the wiki, and different commands, can be authenticated differently based on regexps.
* Kill list of words that will not be automatically linked (default set is the 30 most common English language words).
* The soks-create-wiki command can now be interactive (or can use command line options including --help and --no-interaction). It also manages upgrades from the previous version of Soks.
* There are some demo templates: default is the standard, rails looks a bit like www.rubyonrails.com and instiki which looks a bit like www.instiki.org.
* A meta data view of a page. Clicking on the page's title on the top left of the screen brings up a list of the links from and too that page, and a list of the people who have contributed to the page.
h3. Refactorings
* The recent changes and site index helpers now use the automatic summary class.
* The Wiki class now notifies other classes of changes to the site, including the View class.
* The storage methods are now a module which is mixed into the wiki class.
h3. Bug Fixes
* Bug in uploads on windows fixed (thanks to Sebastien Clediere).
* Bugs in accepting titles with punctuation fixed.
* Bug in automatic summary fixed.
* Logo changed from png to tif so that it is transparent on a wider selection of browsers.
h3. Bugs remaining
* No authentication on pictures and attachments
* Lots of little faults with the textile to html conversion. Some due to the use of Redcloth v 2.0.11 (looking forward to a stable v3!) and some due to my inept subclassing.
|
