Release Name: v0-0-7
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/
* The project wiki/home page is at www.soks.org
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.
* The author appreciates the code, suggestions and libraries provided by a buch of other people, see www.soks.org/author for individual acknowledgements.
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. UPGRADE
If you already have a previous version of soks then to upgrade, run @soks-create-wiki.rb --destination-dir=path/to/your/wiki@ and it will guide you through the upgrade.
Note that if you were using the multi page index class before, you will need to manually delete all the old index pages (@rm content/Site%20Index*@). The new pages will be created automatically.
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:
* Insert page commands are not inhibited by notextile, pre or code tags
* Does not permit browsers to cache pages
* Not user friendly in the way it handles simultaneous edits of a page (last person to save wins)
* Some bugs in layout and formatting of text.
* RSS feed does not completely validate
See http://www.soks.org/wiki/KnownBugs for details.
h2. RELEASES
# 2005 Mar 21 - soks-0.0.7 - Fifth public release (alpha)
# 2005 Mar 15 - soks-0.0.6 - Fourth public release (alpha)
# 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:
h2. Between v0-0-7 and v0-0-6
h3. Features
* AutomaticSummary now has new options to allow specified page title, author and page content regexps to be excluded from summary.
* RecentChanges by default doesn't show changes by any of the Automatic wiki helpers (e.g. the site index maker, or the page mover, or the summariser). As part of this, users can no longer have a username starting with Automatic or containing troublesome punctuation (&{}[]?).
* RecentChanges by default merges any runs of page revisions that have been done by the same author.
* There is a new setting @:reload_erb_each_request@ If set to true, Soks will reload the relevant bits of the wiki view directory on each request. This is useful for developing/debugging the look of a wiki. Default if false, which makes the wiki faster.
h3. Refactoring
* Little bit of refactoring in the AutomaticSummary class
* Uses Logger (placed in $LOG global) instead of writting messages to $STDERR
* Moved to_unique_filename from Servlet to File class (added unit test)
* Moved to_valid_pagename from Servlet to String class (added unit test)
h3. Bugfixes
* Fixed a bug where the import of new pages into a wiki could overwrite old.
* Fixed a bug where existing pages could become inaccesible if they had un-permitted punctuation in their title.
* Fixed Bug: Matching page titles in middle of words
* Fixed bug: Multipage site index S
* Fixed bug: trailing spaces in page names
* Fixed Bug: Forward slashes in titles problematic
* Fixed Bug: Internet Exploror 6.0 incompatibilities during page edits
* Fixed Bug: LinuxFirefox1.0 scroll reset after cursor move
h2. Between v-0-0-6 and v-0-0-5
h3. Features
* The default template now includes a 'sidebar page' that can be edited inside the wiki. (Thanks to Bil Kleb).
* Changed the way the soks libraries are required to hopefully allow a wiki to be more easily moved between machines (Thanks to Giovanni Ferro).
* Some new settings:
** Setting @:server_type => WEBrick::Daemon@ in start.rb causes Soks to try and fork into a separate process. By default this is off. (Thanks to Remy Drouilhet)
** The name of the home page is now a setting in start.rb (@:home_page => "home page"@).
** Setting @:redcloth_hard_breaks => true@ in start.rb causes Redcloth to revert to the 2.x approach of turning every newline to a @<br />@. This is off by default (i.e. the default works like Redcloth 3.x). (Thanks to Seb Clediere.)
* Roughed up a wiki2html helper that maintains a static html copy of the site in sync with the dynamic copy.
* Toned down the colors and tweaked the layout of the default wiki look.
* Removed the 'instiki' and the 'rails' templates from the distribution, because I haven't kept them up to date.
h3. Refactoring
* Filehandler servlet now incorporated into the WikiServlet.
* General cleanup in WikiServlet
* Rewrote the RollingMatch class (in soks-view, deals with automatic linking) to be less complex and a little bit faster.
h3. Bugfixes
* Fixed Bug: Time per change on meta page view incorrect
* Fixed Bug: Punctuation in page titles still problematic by adding two validations. The first is a piece of javascript that warns the user from using problematic punctuation, the second is in the servlet and removes all problematic punctuation. As a side effect, this has fixed Bug: ampersand in page name creates missing links that work .
* Fixed Bug: Search textarea and button rendered without vertical separation by removing the search button. It wasn't needed, and IMO looked clunky.
* Fixed Bug: Certain text crashes yaml revision loading
* Fixed Bug: Do not save and delete links confusing on edit page by replacing the links with form buttons.
* Shutting down Soks with ctrl-c (which is trapped by the TERM signal - does this work on Windows? non OSX unix?) now waits until all the running helpers have finished making their changes to the wiki. This should have fixed bug: Halting can corrupt revisions and may help with Bug: Unanticipated Rollbacks if graceless shutdown is the cause.
* Fixed Bug: Update frequency rounds inappropriately in meta view using Bil Kleb's extension to the Numeric class.
* Fixed Bug: AutomaticRecentChanges ignores changes parameter
* Fixed Bug: Uploads are not password protected
* Fixed Bug: Pictures and Attachments linked to site root
* Partially fixed Bug: RSS feed does not validate, in that I changed the encoding given in the xml so that umlauts work.
* Partially fixed Bug: Upload filenames needlessly mangled, in that it now only removes spaces from filename (which is unfortunately required for RedCloth to be able to make links to the file).
* Robots.txt in the default template dissalows the 'meta' page view
h3. Bugs remaining
Seems like I've accumulated enough changes above to start thinking about another release. This means that some bugs are not going to be fixed for this release. If you strongly object, please let me know.
* Bug: Does not make use of if-modified-since request headers
* Bug: GEM limits title lengths
* Bug: notextile does not prevent page inserts
* Bug: Textile mishandles paragraphs
* Bug: competing edits
The following bugs have only been partially fixed, so some problems may remain
* Bug: RSS feed does not validate
* Bug: Unanticipated Rollbacks
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.
|
