gf-Soks 1.0.4

data/templates/default/content/Automatic%20exporters.textile

@@ -0,0 +1,23 @@
+h1. Automatic Exporters
+
+There is currently a single class that can keep a static html mirror of a wiki.  See how to export a site from this wiki for more occasional exports.
+
+h2. Wiki 2 Html
+
+This class watches for changes to the wiki, and when they occur, writes an html version of the page into a specificed directory.
+
+To use put the following in your start.rb file:
+<pre>
+<code>
+require 'wiki2html'
+Wiki2Html.new(wiki,view,
+		:views_to_copy => ['view','meta','rss'], # This is what views of the page to copy accross
+		:extension => '.html', # this is the extension to put on the files
+		:destination_dir => '/Users/tamc2/Sites', # This is the folder where the html is put
+		:destination_url => 'http://localhost/~tamc2') # Where relevant, urls will be rewritten to start with this
+</code>
+</pre>
+
+Note, this doesn't copy accross uploads or other static files.  You will need to point whatever server you are using to view these files to the attachment directory in the wiki as well.
+
+Tag: Include this page in the distribution

data/templates/default/content/Automatic%20importers.textile

@@ -0,0 +1,59 @@
+h1. Automatic Importers
+
+There are currently two automatic importers.  (You can also manually import data, see how to import data).
+
+h2. Mail2WikiHelper
+
+The mail to wiki helper periodically scans an email folder on an imap server, and copies messages across to the wiki.   Each message is appended to a page with the same name as the email subject and uses the email from address as the author name.  
+
+p(. What about a pop server? --Bil.  Should be a pretty easy rewrite to use NET::POP rather than NET::IMAP, but I unfortunately don't have any POP servers to test with. --tamc
+
+*NOTE* This helper ignores the contents of the authenticators array in your start.rb file. 
+
+To use, put the following in your start.rb file:
+
+# @require 'mail2wiki-helper'@
+# @Mail2WikiHelper.new( wiki, :server => 'imap.server', :username => 'user', :password => 'password', :mailbox => 'test')@
+
+This will by default scan the mailbox every hour.  Once a message has been imported into the wiki it is tagged with a 'PutInWiki' keyword that prevents subsequent re-insertions.  To get the message to be re-inserted you must either change the keyword that soks looks for (see below) or unset the keyword using your email program.
+
+There are a few other settings you can change:
+<pre>
+<code>
+DEFAULT_SETTINGS = {
+	:server => 'imap.hermes.cam.ac.uk',
+	:username => 'tamc2',
+	:password => 'missing_a_password',
+	:mailbox => 'test',
+	:check_event => :hour,
+	:subject_regexp => /.*/,
+	:keyword => 'PutInWiki'
+}
+</code>
+</pre>
+	
+
+h2. RSS2WikiHelper
+
+The rss to wiki helper periodically downloads an rss feed and copies it onto a specified page as a series of links.
+
+To use, put the following in your start.rb file:
+
+# @require 'rss2wiki-helper'@
+# @RSS2WikiHelper.new( wiki, :url => 'url of rss feed' )@
+
+By default it will check once an hour, and write the feed to a page with the same name as the feed title.
+
+There are a few other settings you can change:
+<pre>
+<code>
+	DEFAULT_SETTINGS = {
+		:url => 'http://localhost:8000/rss/recent%20changes%20to%20this%20site',
+		:pagename => nil, # If nil, uses channel title,
+		:update_on_event => :hour,
+		:author => 'AutomaticRSS2Wiki',
+	}
+</code>
+</pre>
+
+Tag: Include this page in the distribution

data/templates/default/content/Automatic%20linking.textile

@@ -0,0 +1,7 @@
+h1. Automatic linking
+
+Any reference to the title of another page in the wiki will be automatically linked.  e.g. home page is linked to the home page.  The longest possible links are made first.
+
+The easiest way to create a new page (if your browser supports it - I can only positively say that Safari does) is to highlight the text you want to link from and press ctrl-n. 
+
+Tag: Include this page in the distribution

data/templates/default/content/Automatic%20maintenance%20helpers.textile

@@ -0,0 +1,39 @@
+h1. Automatic Maintenance Helpers
+
+These help with some basic wiki maintenance tasks:
+
+h2. Delete Old Pages Helper
+
+This permanently deletes deleted pages.
+
+To use, put the following in your start.rb file:
+# @require 'maintenance-helpers'@
+# @DeleteOldPagesHelper.new(wiki)@
+
+This will by default scan the wiki once per day and permanently delete pages that have been marked for deletiob for more than 100 days.
+
+It has two optional parameters: @DeleteOldPagesHelper( event_to_check_on, age_to_wipe_at)@, the first can be :min, :hour, :day, ;month, :year and the age is in seconds.
+
+h2. Delete Old Revisions Helper
+
+This permanently deletes old revisions.
+
+To use, put the following in your start.rb file:
+# @require 'maintenance-helpers'@
+# @DeleteOldRevisionsHelper.new(wiki)@
+
+This will by default scan the wiki once per day and permanenty delete revisions that are more than a hundred days old, being sure to leave at least 20 revisions on a page.
+
+It has three optional parameters @DeleteOldRevisionsHelper(( wiki, event_to_check_on = :day, age_to_wipe_at = 60*60*24*365, minimum_revisions = 20 )@ the first can be :min, :hour, :day, ;month, :year and the age is in seconds.
+
+h2. Merge Old Revisions Helper
+
+By default this wakes up each hour and merges all revisions more than 24 hours old, by the same author, and that are created within an hour of each other.
+
+To use, put the following in your start.rb file:
+# @require 'maintenance-helpers'@
+# @MergeOldRevisionsHelper.new(wiki)@
+
+It has three optional parameters @DeleteOldRevisionsHelper(( wiki, eevent_to_check_on = :day, minimum_age_to_merge = 60*60*24*365, maximum_time_between_revisions_for_merge = 60*60 )@ the first can be :min, :hour, :day, ;month, :year and the age and time are in seconds.
+
+Tag: Include this page in the distribution

data/templates/default/content/Bug%3A%20Competing%20edits.textile

@@ -0,0 +1,22 @@
+h1. Bug competing edits
+
+I had a case today where I was evidently editing a page at the same time someone else was.  He won and my edits were trashed upon save.  (Or at least this is what I surmise happened.)
+
+Is this possible?  --Bil
+
+Umm, trashed on save?  I hope not.  I hope that if you look at the 'show all changes' for the page it will show both edits in the history?  I *seriously* want to know if they are not.
+
+p(. I was paying more attention this time.  Two of us were editing the same page.
+I saved my changes, and they showed up on the page.
+Next, he saved his changes, and my changes were removed (but still available
+via the "show all changes"). --Bil
+
+As for a solution.  There seem to be two routes:
+# Put a 'lock' on the page, so that only one person can see the edit view at once.
+# Try and merge competing edits.
+
+I would prefer to merge, but don't know how to implement...
+
+--tamc2
+
+Tag: Include this page in the distribution

data/templates/default/content/Bug%3A%20Does%20not%20make%20use%20of%20if%2Dmodified%2Dsince%20r.textile

@@ -0,0 +1,3 @@
+Currently tells the browser to not cache any page.  This is wasteful of bandwidth and increases server load.  Should handle the if-modified-since request headers to return 'not modified' messages instead.
+
+Tag: Include this page in the distribution

data/templates/default/content/Bug%3A%20Email%20adresses%20in%20page%20titles%20cause%20incorrec.textile

@@ -0,0 +1,3 @@
+Seems like having an email adress in a page title causes problems with linking to that page.
+
+Tag: Include this page in the distribution

data/templates/default/content/Bug%3A%20GEM%20limits%20title%20lengths.textile

@@ -0,0 +1,3 @@
+It seems that Ruby GEM limits filename lengths, which means there is a limit on title lengths.  It appears to be done so that the files work correctly on the windows platform. 
+
+Tag: Include this page in the distribution

data/templates/default/content/Bug%3A%20Memory%20leak.textile

@@ -0,0 +1,13 @@
+There appears to be a memory leak. 
+
+Not sure what triggers it, and whether it occurs in any versions appart from the one in the CVS.
+
+Spotted on this site (www.soks.org) where over a period of a couple of weeks, memory use grew from 47M to 102M.  This is a problem for this site as only 64M of virtual memory is available, and so the larger size causes a slow down through swapping.
+
+Will investiagate, and would appreciate other reports if anyone has a similar experience.
+
+--tamc2
+
+This hasn't repeated after that first time.  It may have just ben a temporary blip.  I'd appreciate any other reports --tamc2
+
+Tag: Include this page in the distribution

data/templates/default/content/Bug%3A%20Page%2Einserted%5Finto%20is%20never%20purged.textile

@@ -0,0 +1,17 @@
+h1. Page.inserted_into is never purged
+
+* Your name:  tamc
+* Soks version: v1.0.0
+* Your operating system:
+* Your version of ruby:
+* Your browser:
+
+h2. And please describe the problem below:
+
+If one page is inserted into another, then it is recorded in an array in the Page class.  If a page is updated, this allows all the other pages that insert it to be refreshed to be up to date.  Unfortunately there is no mechanism to remove this record should the page no longer be inserted.  This isn't a big deal, but will result in unncessary refreshes.
+
+h2. And if you have any suggestions for the cause or a fix, please put it below:
+
+Working on it... (but low priority)
+
+Tag: Include this page in the distribution

data/templates/default/content/Bug%3A%20Pages%20that%20link%20here%20may%20not%20appear%20on%20r.textile

@@ -0,0 +1,13 @@
+The pages that link here sidebar may not appear if you:
+# Run a soks wiki
+# Shutdown the wiki gracefully so that it saves its caches
+# Modify a wiki page off-line (everything is ok if you add a page)
+# Restart the wiki and it succesfully reloads its caches
+
+There are two workarounds:
+# Either delete the caches before restarting in step 4 above
+# Or edit any page in the wiki after restart.  The pages that link here sidebar will then reappear.
+
+Not sure yet as to the cause of this bug, but it doesn't seem to be a showstopper so I'm going to release v1-0-0 anyway. --tamc
+
+Tag: Include this page in the distribution

data/templates/default/content/Bug%3A%20Textile%20mishandles%20paragraphs.textile

@@ -0,0 +1,37 @@
+The "paragraph not kept separate" below should appear on a separate line from "A paragraph" but does not.
+
+<pre>
+Something
+</pre>
+A paragraph
+
+A paragraph not kept separate
+# Blah
+
+The cause seems to be some interaction between the pre block and the following list block.  Putting a blank line after the pre or before the list makes it function as expected:
+
+e.g.
+
+<pre>
+Something
+</pre>
+
+A paragraph
+
+A paragraph not kept separate
+# Blah
+
+or
+
+<pre>
+Something
+</pre>
+A paragraph
+
+A paragraph not kept separate
+
+# Blah
+
+This is possibly a bug with Redcloth rather than soks.
+
+Tag: Include this page in the distribution

data/templates/default/content/Bug%3A%20Unanticipated%20Rollbacks.textile

@@ -0,0 +1,23 @@
+Bil Kleb reports:
+
+bq. Unfortunately, I don't have any diagnostic data at
+this point, but I have noticed on 3 occasions
+that my home page has been rolled back to the previous
+version when I restart WEBbrick (or when I moved the
+Wiki to a new location/machine?).
+
+I haven't seen this happen, but data loss is a very bad thing, so I would really appreciate any reports anyone has.
+
+If it happens, could you let me know:
+
+# Is it only ever the home page?
+# If you look at the the revisions (edit, show all changes) does it show that the page has been rolled back, or just that the most recent edit never happened at all?
+# If you look at the content/Home%20Page.yaml file, does it show that the most recent edit ever happened?
+# Which version of the page does the content/Home%20Page.textile file contain?
+# Are the timestamps of the Home%20Page.textile and Home%20Page.yaml files wildly different?
+
+Thanks
+
+tamc2
+
+Tag: Include this page in the distribution

data/templates/default/content/Bug%3A%20notextile%20does%20not%20prevent%20page%20inserts.textile

@@ -0,0 +1,3 @@
+Page inserts like @[ [insert other page]]@ should not insert another page if they are surrounded by notextile tags (or code, or pre?).  
+
+Tag: Include this page in the distribution

data/templates/default/content/Home%20Page.textile

@@ -0,0 +1,22 @@
+h1. Congratulations, you have installed SOKS 
+
+Soks is a wiki engine, written in the Ruby programming language. Soks's licence is the free and liberal Ruby licence, so please feel free to use and modify it (though the author would appreciate donations, to be used for a new mac).
+
+p{background:yellow;padding:10px;}. A limited selection of help and bug reports are included here.  For more information, and to share experiences, please visit http://www.soks.org.
+
+[[insert SOKS features]]
+
+[[insert Instructions and Howtos]]
+
+[[insert known bugs]]
+
+Be sure to check http://www.soks.org/wiki/KnownBugs for the latest bug reports.
+
+h2. Feedback
+
+* Please send me your feedback.  tamc@rubyforge.com.  
+* To keep track of developments, you may wish to subscribe to the mailing list at http://rubyforge.org/projects/soks.
+
+[[insert picture of a pair of soks]]
+
+Tag: Include this page in the distribution

data/templates/default/content/How%20to%20administrate%20this%20wiki.textile

@@ -0,0 +1,57 @@
+h1. Adjusting the settings
+
+Take a look at the start.rb file in your wiki folder.  This can be used to change the settings such as port and url of this site, and to enable more advanced features such as calendars and automatic summaries.
+
+h2. To start your wiki
+
+The soks-create-wiki.rb script will have created a folder in the directory in which you ran it (by default the folder is 'soks-wiki'). In that folder is a script 'start.rb' run it.
+<code>
+cd soks-wiki
+ruby start.rb
+</code>
+
+h2. To stop your wiki
+
+If you've started the wiki as above, then hold down the ctrl key and press c.
+
+If you have run the wiki as a daemon, or using nohup, then you will need to find the process id of the wiki.  This can be found by @top@ or @ps -e | grep ruby@.  In the first instance, try @kill -INT 123@ where 123 is the number found from top or ps.  That will try and make the wiki gracefully shut down.  If that doesn't work @kill -KILL 123@ will force the wiki to halt immediately.
+
+h2. To make your site accessible beyond localhost
+
+Open start.rb in your directory. Find the line:
+
+<code>
+view = View.new( wiki, "http://localhost:8000", "#{root_directory}/views" )
+</code>
+
+and replace the url with the url and port you wish the wiki to run on.
+
+Then replace
+<code>
+server = WEBrick::HTTPServer.new(:Port => 8000 )
+</code>
+
+with the port you wish the wiki to run on.
+
+h2. To password protect your wiki.
+
+See how to password protect your wiki.
+
+h2. To edit the default site settings used by soks-create-wiki.rb
+
+Edit template/start.rb in the directory where soks was installed.
+
+h2. To change how often the wiki checks the content directory for any changes.
+
+Open start.rb and change this line:
+<code>
+wiki.check_files_every = :min
+</code>
+
+Acceptable values are nil (never), :sec, :min, :hour, :day
+
+h2. To add a page that summarises other pages:
+
+See Automatic summaries
+
+Tag: Include this page in the distribution

data/templates/default/content/How%20to%20change%20the%20way%20this%20wiki%20looks.textile

@@ -0,0 +1,32 @@
+h1. Improving the style of this wiki
+
+If you develop any improvements to the layout and style of this wiki, and are willing to share, please send copies to me tamc@rubyforge.com (a zip of the view and attachment directory is probably the best method).
+
+h2. Changing the logo on the right
+
+The logo can be changed by replacing logo.jpg in the in the attachment folder of the wiki you have created ( soks-wiki/attachment/logo.tif by default)
+
+h2. Changing the color scheme
+
+The stylesheet is stored in the attachment folder of the wiki you have created (soks-wiki/attachment/stylesheet.css by default).
+
+h2. Changing the html and layout
+
+The formatting of the wiki is stored in the views subdirectory of the folder in which the wiki was created (soks-wiki/views by default).  These pages are all erb ( www.ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html ).
+
+The folder contains:
+* frame.rhtml - This is the bulk of the html and is used to wrap all pages except those ending in 'print' or 'rss'
+* Page_view.rhtml - This is the 'standard' viewing page
+* Page_edit.rhtml - This is the 'standard' editing page
+* Page_revisions.rhtml - This is the 'standard' revisions page
+* Page_rss.rhtml - This attempts to create a rss feed for changes to the page 
+
+You can add a new type of view by creating a new file here ending in rthml, starting with Page and with _viewname in the middle.  E.g. for a new sort of 'doublesize' view you could create Page_doublesize.rhtml.  This would then be accessed by typing /doublesize/pagename as the url. 
+
+Note that you must restart soks for changes to the template to take effect.
+
+h2. Changing the default styles for NEW wikis 
+
+To change the style and layout of new wikis created using the soks-create-wiki.rb command, then edit the 'template' directory of wherever you installed soks.
+
+Tag: Include this page in the distribution

data/templates/default/content/How%20to%20export%20a%20site%20from%20this%20wiki.textile

@@ -0,0 +1,82 @@
+h1. How to export a site from this wiki
+
+h2. How to export as html
+
+Modify your start.rb file to include:
+<pre>
+<code>
+require 'helpers/wiki2html'
+Wiki2Html.new( wiki, view, 
+:views_to_copy => ['view','meta','rss'],
+:extension => '.html',
+:destination_dir => '/Users/tamc2/Sites',
+:destination_url => 'http://localhost/~tamc2')
+</code>
+</pre>
+
+Where desitination_dir should be the directory you wish to export the html to, and destination_url should be the base_url you wish to use in the exported pages (could be just '/').
+
+When you restart the wiki it will then maintain an html copy of the wiki in that directory.
+
+h2. How to export the raw data
+
+The contents of this site are stored in flat files in the 'contents' folder of this wiki (soks-wiki/contents by default).  They are the ones with the .textile ending.  Should be pretty easy to transfer them to wherever you need.
+
+The authors, and change history of each page are stored in the same folder with a yaml extension. These are yaml'd files that contain many documents.  Each document contains a single revision. Each revision is an array of [ revision number, changes, author, creation time ].  The changes is an array of change groups.  Each change group is an array of changed lines.  There may be several documents with the same revision number.  The last document with a particular revision number is the 'definative' one.
+
+E.g. The saved copy of a page titled Hello World would be two files:
+# Hello%20World.textile
+# Hello%20World.yaml
+
+Hello%20World.textile might contain:
+<pre>
+h1. Hello world
+
+What a beautiful world
+</pre>
+
+Hello%20World.yaml might contain
+<pre>
+--- # Start of document
+- 0 # Revision number
+- tamc # Revision author
+- 2005-01-23 22:53:11.081896 +00:00 # Revision time
+- # Array of change groups
+  - # Array of changes
+    -  # Each change is an array
+      - "+" # Add or delete
+      - 0 # Line number
+      - h1. Hello george # What the line is
+---
+- 0 # If a new revision is made by the same author within 30 minutes the revision number is not increased.  This is the definitive revision 0, the previous one should be ignored.
+- tamc
+- 2005-01-23 22:55:11.081896 +00:00
+- 
+  - 
+    - 
+      - "-"
+      - 0
+      - h1. Hello george
+    - 
+      - "+"
+      - 0
+      - h1. Hello world
+    - 
+---
+- 0
+- tamc
+- 2005-01-23 22:55:11.081896 +00:00
+- 
+  - 
+    - 
+      - "+"
+      - 1
+      - ""
+    - 
+      - "+"
+      - 2
+      - What a beautiful world
+    - 
+</pre>
+
+Tag: Include this page in the distribution