README
—
!!1!
!
>SOKS:
Another
Ruby Wiki
—
!!2!
!
—
!!3!
!
>
—
!!4!
!
This application is a Wiki
(a system to allow the easy and collaborative editing of web pages)
.
—
!!5!
!
!
!6!
!
The project has been kindly hosted at
http://rubyforge.org/projects/soks/ !
!7!
!
!
!8!
!
The project wiki/
home page is at
http://www.soks.org !
!9!
!
—
!!10!
!
Quickstart:
—
!!11!
!
>
—
!!12!
!
gem install Soks
—
!!13!
!
!
!14!
!
soks-create-wiki.rb
—
!!15!
!
!
!16!
!
!
!17!
!
—
!!18!
!
—
!!19!
!
>REQUIRES
—
!!20!
!
—
!!21!
!
>
—
!!22!
!
1.8.2
—
!!23!
!
!
!24!
!
A number of additional libraries are contained in contrib.
!
!25!
!
—
!!26!
!
—
!!27!
!
>
AUTHOR !
!28!
!
—
!!29!
!
>
—
!!30!
!
This software is copyright
(c)
Thomas Counsell 2004,
2005.
tamc@rubyforge.org —
!!31!
!
!
!32!
!
It is licensed under the
Ruby Licence,
a liberal open source licence.
See LICENCE for more details.
!
!33!
!
!
!34!
!
The
author appreciates the code,
suggestions and libraries provided by a buch of other people,
see
www.soks.org/author for individual acknowledgements.
!
!35!
!
—
!!36!
!
—
!!37!
!
>INSTALL
—
!!38!
!
Preferably:
—
!!39!
!
>
—
!!40!
!
Install rubygems from
http://rubyforge.org/projects/rubygems/ !
!41!
!
!
!42!
!
!
!43!
!
!
!44!
!
(you may need to be root first)
!
!45!
!
—
!!46!
!
Alternatively
—
!!47!
!
>
—
!!48!
!
Download the tar or zip file from
http://rubyforge.org/projects/soks/ !
!49!
!
!
!50!
!
Unzip or untar it
—
!!51!
!
!
!52!
!
Change into the soks directory
—
!!53!
!
—
!!54!
!
—
!!55!
!
>USE
—
!!56!
!
—
!!57!
!
execute
!
!58!
!
!
!59!
!
(will be in your path if installed by gems,
otherwise
!
!60!
!
!
!61!
!
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)
!
!62!
!
—
!!63!
!
To restart the wiki change into the soks-wiki directory and execute
ruby start.rb
—
!!64!
!
—
!!65!
!
To change the settings
(url,
port,
etc)
edit the start.rb file in the soks-wiki directory.
!
!66!
!
—
!!67!
!
>UPGRADE
—
!!68!
!
—
!!69!
!
If you already have a previous version of soks then to upgrade,
run
!
!70!
!
!
!71!
!
and it will guide you through the upgrade.
!
!72!
!
—
!!73!
!
Note that if you were using the multi page index class before,
you will need to manually delete all the old index pages
(
—
!!74!
!
!
!75!
!
).
The new pages will be created automatically.
!
!76!
!
—
!!77!
!
>FEATURES
—
!!78!
!
—
!!79!
!
>
—
!!80!
!
Runs on its own webrick server
(no independent web server required)
!
!81!
!
!
!82!
!
Uses textile as its text coding
(a proto-standard)
—
!!83!
!
!
!84!
!
Uses a combination of flat and yaml files for storage
(no database,
and page content human readable outside of soks)
!
!85!
!
!
!86!
!
Allows uploads
—
!!87!
!
!
!88!
!
Allows authentication
—
!!89!
!
!
!90!
!
Automatically links pages within the wiki
—
!!91!
!
!
!92!
!
Pages can be deleted and moved easily
(and these can be undone)
!
!93!
!
!
!94!
!
Has a mechanism for external classes to manipulate the wiki to provide,
for instance,
automatic calendar pages,
or
automatic summaries or blog like pages.
!
!95!
!
—
!!96!
!
—
!!97!
!
>BUGS
—
!!98!
!
—
!!99!
!
I suspect there are many,
see
http://www.soks.org/wiki/KnownBugs for details.
!
!100!
!
—
!!101!
!
!
!102!
!
