Soks 0.0.2 → 0.0.3

data/templates/instiki/attachment/newpage.js

@@ -0,0 +1,41 @@
+function trim(str) 
+{ 
+	return str.replace(/^\s+/,'').replace(/\s+$/,'');
+}
+
+function editSelected()
+{
+	if (window.getSelection)
+	{
+		txt = window.getSelection();
+	}
+	else if (document.getSelection)
+	{
+		txt = document.getSelection();
+	}
+	else if (document.selection)
+	{
+		txt = document.selection.createRange().text;
+	}
+	if(!txt){
+	void(txt=prompt('Please enter the title of the page you wish to create',''))
+	}
+	if(txt){
+		window.location = '/edit/'+escape(trim(txt))
+	}
+}
+
+function hotkey( event )
+{
+ 	event = (event) ? event : ((window.event) ? event : null);
+	if (event)
+	{
+	if (event.ctrlKey ) 
+	{
+		var charCode = (event.charCode) ? event.charCode : ((event.which) ? event.which : event.keyCode);
+		if (charCode == 14 ) { 
+			editSelected();
+		}
+	}
+	}
+}

data/templates/instiki/banned_titles.txt

@@ -0,0 +1,31 @@
+# Each line contains a title that will NOT be automatically linked in the wiki (can still be manually linked)
+the
+of
+and
+a
+to
+in
+is
+that
+it
+was
+he
+for
+as
+on
+with
+his
+be
+at
+you
+I
+are
+this
+by
+from
+had
+have
+they
+not
+or
+one

data/templates/instiki/content/AutomaticSummary.textile

@@ -0,0 +1,24 @@
+h1. The Automatic Summary class
+
+This class is in the lib/soks-helpers.rb file.  Examples of its use can be seen in the AutomaticRecentChanges and AutomaticIndex classes in that file.
+
+It is a flexible class that watches the wiki, and creates summaries of pages based on your specifications.  To create a new automatic summary, edit the section in your start.rb file.  
+
+Possible settings are:
+<code>
+DEFAULT_SETTINGS = {
+	 	:regexp_for_title => /.*/, # These three regexps act as an AND
+		:regexp_for_author => nil, 
+		:regexp_for_content => nil,
+		:max_pages_to_show => nil,
+		:pagename => 'Summary',
+		:author => 'AutomaticSummary',
+		:lines_to_include => nil, # Or pass a block
+		:only_new_pages => false,
+		:sort_pages_by => :created_on, # Could be :revised_on or :score or :name or :name_for_index, or :author
+		:reverse_sort => false,
+		:include_metadata => false, # Includes author and time in summary
+		:summarise_revisions => false, # If true, then can contain several revisions for same page
+		:remove_deleted_pages => true, # If false will keep references to deleted pages
+	}
+</code>

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

@@ -0,0 +1,60 @@
+h1. How to export a site from this wiki
+
+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>

data/templates/instiki/content/How%20to%20hack%20soks.textile

@@ -0,0 +1,61 @@
+h1. How to hack soks
+
+Here are some pointers to help you figure out where to make whatever changes and improvements you desire.  The soks licence is liberal, so please do whatever you want, but I would appreciate if you sent me any improvements you make ( tamc@rubyforge.com ).
+
+* bin - contains the soks-create-wiki.rb file
+* contrib - contains code from other people.  Currently Redcloth and Diff:LCS
+* lib - contains the soks code
+* template - contains the defaults used by soks-create-wiki.rb when creating a new wiki.  This folder is copied over, and the show.rb template filled out.
+
+h2. template
+
+* show.rb - contains the default ruby file used by soks-create-wiki.rb, this is written using erb
+* attachments - contains the stuff that will be statically loaded when running a wiki, such as images and stylesheets. In particular you may want to replace logo.png
+* views - contains the default templates see Improving the style of this wiki for a few notes on this
+* content - contains the initial content for the wiki.  The .textile files are flatfile text files containing the textile for a page.  The title of the page is the filename (and has usually been url_encoded).  Any .yaml files in here contain arrays containing the change history of the page
+
+h2. lib
+
+* soks.rb - Just requires all the other files
+* soks-utils.rb - Contains various utility classes, EventQueue, Notify and some extensions to String to url_encode and decode
+* soks-storage.rb - Contains a module which is mixed into the Wiki class to allow it to be saved
+* soks-model.rb - Contains the model of the wiki: Wiki, Page and Revision
+* soks-view.rb - Contains the classes that turn the wiki into html: View, WikiRedCloth, Links, RollingMatch
+* soks-servlet.rb - Contains the webrick server that passes commands to and from the View object
+* soks-helpers.rb - Contains optional classes that a Wiki can load to provide added functionality.  These are called when changes are made to the site.  They include: AutomaticUpdateCrossLinks, AutomaticRecentChanges, AutomaticOnePageIndex, AutomaticMultiPageIndex, AutomaticSummary, AutomaticCalendar and AutomaticUpcomingEvents.
+* authenticators.rb - Contains some extra authenticators to extend those already provided by Webrick. Namely  NotAuthentication and OnePasswordAuthentication
+
+h3. soks-utils.rb
+
+* Notify - This is an improvement on the Observable mix-in. 
+* EventQueue - This is used by Notify to inform observers in sequence of an event taking place, while allowing the original triggering class to continue.
+
+h3. soks-model.rb
+
+A Wiki class has many Page classes which have many Revision classes.  ImagePage and AttachmentPage are subclasses of Page that return different textile.
+
+The Wiki class decides what type of page to create based on its name.  All AttachmentPage pages have names that start with 'Attached ', all ImagePage pages have names that start with 'Picture of'. This is defined in the @page_classes instance variable of the Wiki class.
+
+The Wiki loads all the pages from file into a hash.  When pages are changed it writes a copy to disk immediately.  It has a thread that watches the disk for any changes to the files.
+
+h3. soks-view.rb
+
+The View object does the business.  It is called by the soks-servlet, and then proceeds to call an appropriate method on the Wiki model. It may then Notify any observing AutomaticHelpers of any changes, before proceeding to render the html.  This rendering happens in two places: First the Page.textile is turned into html by WikiRedCloth. then an appropriate ERB file is loaded and called.
+
+The WikiRedCloth overrides the to_html method of redcloth to add a number of methods that do the automatic page insertion and automatic linking. The automatic linking is actually carried out in the RollingMatch class. A record of the links between pages is kept in the Links class and then written to each page object.  Currently Redcloth 3.0.1 seems to have lots of stack overflows, so Redcloth 2.0.11 is used.
+
+The ERB files are loaded from disk.  The appropriate erb file is selected by looking for the pattern ClassName_viewname.rhtml (e.g. Page_edit.rhtml). If that page doesn't exist then the process is repeated with the Page's superclass.  The ERB files are cached.
+
+h3. soks-servlet.rb
+
+This runs a Webrick server to interact with the user.  There is a $SETTINGS global that contains most of the important settings, and a start_wiki method for setting them and triggering the server to start.  The server can be stopped by sending an interupt (ctrl-c).
+
+The server has two handlers, a WEBrick::HTTPServlet::FileHandler for doing the dynamic content (which is attached to any url starting in /attachment/) and a WikiServlet for the dynamic content.
+
+The WikiServlet service method takes a look at the request url. If it is '/' it redirects to '/view/Home Page'.  If it only has one slash in it (e.g. '/Home Page') then it assumes that it is equivalent to '/view/Home Page'. If it has two or more slashes in it (e.g. '/edit/Home Page' ) then it splits the url into a command ('edit') and the rest ('Home Page'). If the WikiServlet responds to doCommand (e.g. doEdit) then control is passed to that method.  Otherwise it is assumed the command is the name of a view (e.g. 'print') and is therefore passed as is to the View object. 
+
+The WikiServlet deals with file uploads by separately writing the uploaded file to the 'attachments' directory and also asking the 'View' object to create or revise an ImagePage object whose content is the filename of the uploaded file. 
+
+h4. soks-helpers.rb
+
+These are a series of classes that may be optionally loaded by a wiki's start.rb script. They receive notifications of page changes from the View object and can use this information to update other pages in the wiki.

data/templates/instiki/content/How%20to%20import%20a%20site%20from%20instiki.textile

@@ -0,0 +1,13 @@
+h1. How to import a site from instiki
+
+[[ Instiki => www.instiki.org ]] is great, and was definitely an inspiration for this site.  If, however, you wish to import a wiki from instiki to here then you need to:
+
+# Launch your instiki wiki
+# Go to 'export' and click on 'Markup (textile)'
+# Unzip the downloaded folder.
+# Create a soks wiki: <code>soks-create-wiki.rb</code>
+# Stop the wiki <code>ctrl-c</code>
+# Copy the contents of the downloaded folder (step 3) into soks-wiki/content
+# Start the wiki <code>ruby soks-wiki/start.rb</code>
+
+Your instiki content should then appear.  Note that all the links still work, but that all the pages have their WikiWord names.

data/{template → templates/instiki}/content/Improving%20the%20style%20of%20this%20wiki.textile

@@ -4,7 +4,7 @@ If you develop any improvements to the layout and style of this wiki, and are wi
 
 h2. Changing the logo on the right
 
-The logo can be changed by replacing logo.png in the in the attachment folder of the wiki you have created ( soks-wiki/attachment/logo.png by default)
+The logo can be changed by replacing logo.tif in the in the attachment folder of the wiki you have created ( soks-wiki/attachment/logo.tif by default)
 
 h2. Changing the color scheme
 
@@ -19,7 +19,7 @@ The folder contains:
 * 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 (buggy?)
+* 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. 
 

data/templates/instiki/content/Known%20bugs.textile

@@ -0,0 +1,8 @@
+h1. Known Bugs
+
+_If you can fix any of the bugs here, please let me know.  If you spot any more, please let me know._
+
+* Uploads are  not password protected
+* Sometimes the last item in a list of links is not linked correctly
+* Sometimes entities such as > are not encoded correctly
+ 

data/templates/instiki/content/List%20of%20changes.textile

@@ -0,0 +1,34 @@
+h1. List of changes
+
+h2. Between v-0-1-0 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. 
+
+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.

data/templates/instiki/content/Picture%20of%20a%20pair%20of%20soks.textile

@@ -0,0 +1 @@
+/attachment/logo.tiff

data/templates/instiki/content/Pointers%20on%20adjusting%20the%20settings.textile

@@ -0,0 +1,62 @@
+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 restart 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 make your site accessible beyond localhost
+
+Open start.rb in your directory. Un-comment the lines
+<code>
+# :url => 'http://localhost:8000',
+# :port => 8000,
+</code>
+and replace them with the url and port you wish the wiki to run on.
+
+h2. To password protect your site.
+
+Open start.rb in your wiki directory. Un-comment and edit the authenticators section and edit the array.  The format is [  [ first regexp to match against title, authenticator to use ],  [ second regexp to match against title, authenticator to use ] .... ]. For example:
+
+# This matches against all the standard 'non editing commands' and doesn't ask for any authentication
+<code>[ %r{/(view|rss|print|find|meta)/.*}, WEBrick::HTTPAuth::NoAuthenticationRequired.new ]</code>
+
+# This doesn't permit any file or picture uploads
+<code>[ %r{/upload/.*}, WEBrick::HTTPAuth::NotPermitted.new ]</code>
+
+# This asks for a site wide password to edit or save changes to the home page
+<code>[ %r{/(edit|save)/home page}, WEBrick::HTTPAuth::SiteWidePassword.new('password','You need to enter the site wide password to edit the home page') ]</code>
+
+# This uses the standard WEBrick authentication system on any page whose name starts with private. The standard WEBrick authentication uses a database of usernames and passwords.  See [[ Gnome's Guide => http://shogo.homelinux.org/~ysantoso/webrickguide/html/html_webrick.html ]] for details.
+<code>[ %r{/(view|edit|save)/private.*},WEBrick::HTTPAuth::BasicAuth.new( :UserDB => htpasswd, :Realm => realm ) ]</code>
+
+# This is the default. For any page it just asks for a username, but the password can be left blank.
+<code>[ %r{.*}, WEBrick::HTTPAuth::AskForUserName.new( 'No password, just enter a name') ]</code>						
+
+Note a big bug is that viewing attached images and files is NOT password protected.  If someone knows how to make WEBrick::HTTPServlet::FileHandler use an authenticator, please let me know. 
+
+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 add this to your CUSTOM_SETTINGS hash:
+<code>:check_files_every => 60, # Seconds</code>
+
+h2. To add a calendar and upcoming events page:
+
+Open start.rb and uncomment:
+<code>
+# calendar = AutomaticCalendar.new( wiki ) # Adds a series of calendar pages to the wiki
+# AutomaticUpcomingEvents.new( wiki, calendar ) # Creates a page with the next weeks events drawn from the calendar pages
+</code>
+
+h2. To add a page that summarises other pages:
+
+See AutomaticSummary

data/templates/instiki/content/Pointers%20on%20how%20to%20use%20this%20wiki.textile

@@ -0,0 +1,27 @@
+h1. Pointers on how to use this wiki
+
+h2. Adding Pages
+
+There are several ways to add pages to soks:
+# Click on the 'add a new page'
+# Highlight the text on the page you wish to link from and press crtl-n[1]
+# Type the title of the page you wish to create and click search, there will be a link to create the page at the bottom of the search results.
+# As you are editing a page, put the title of a new page in square brackets like this: <notextile>[[ title of the new page ]]</notextile>.  When you save the page, a link will be created that permits you to create a new page.
+
+Yes, this means it is very easy to create orphaned pages. No I don't think this is a problem, because there is a site index.
+
+fn1. This only works on some browsers.  It doesn't seem to work on Mac Firefox or Mac OmniWeb. It does on Mac Safari.  Please report your successes and failiures.
+
+h2. Editing Pages
+
+* To edit a page, click edit. 
+* The pages are written in textile.  A reference is at http://hobix.com/textile/quick.html
+* Links to other pages within this wiki, and to web addresses, and to e-mail addresses, happen automatically
+* To force a link put it inside double square brackets e.g. <notextile>[[a forced link]]</notextile>
+* To alias a link: <notextile> [[ a different name for </notextile>=><notextile> site index ]] </notextile>
+* To insert another page: <notextile>[ [ insert site index ]]</notextile>
+* This is particularly usefull if you want to insert a picture: <notextile>[ [ insert picture of the soks logo ]]</notextile>
+
+h2. Searching
+
+The search box on the right takes a single regexp.  

data/templates/instiki/content/Recent%20Blog%20Entries.textile

@@ -0,0 +1,3 @@
+h1. Recent Blog Entries
+
+No pages found to summarise

data/templates/instiki/content/Recent%20Changes%20to%20This%20Site.textile

@@ -0,0 +1,48 @@
+h1. Recent Changes to This Site
+
+* home page revised on 2005 Jan 23 23:27 by tamc2
+* home page revised on 2005 Jan 23 23:27 by tamc2
+* home page revised on 2005 Jan 23 23:26 by tamc2
+* home page revised on 2005 Jan 23 23:26 by tamc2
+* Picture of a pair of soks revised on 2005 Jan 23 23:25 by AutomaticImport
+* Picture of a pair of soks revised on 2005 Jan 23 23:24 by AutomaticImport
+* How to hack soks revised on 2005 Jan 23 23:23 by tamc2
+* How to export a site from this wiki revised on 2005 Jan 23 23:21 by tamc2
+* How to import a site from instiki revised on 2005 Jan 23 23:10 by tamc2
+* Site Index revised on 2005 Jan 23 23:10 by AutomaticIndex
+* AutomaticSummary revised on 2005 Jan 23 23:10 by tamc2
+* Pointers on adjusting the settings revised on 2005 Jan 23 23:04 by tamc2
+* Pointers on adjusting the settings revised on 2005 Jan 23 23:04 by tamc2
+* Pointers on adjusting the settings revised on 2005 Jan 23 23:03 by tamc2
+* Pointers on adjusting the settings revised on 2005 Jan 23 23:01 by tamc2
+* Pointers on adjusting the settings revised on 2005 Jan 23 22:59 by tamc2
+* Pointers on adjusting the settings revised on 2005 Jan 23 22:58 by tamc2
+* List of changes revised on 2005 Jan 23 22:48 by tamc2
+* Site Index revised on 2005 Jan 23 22:45 by AutomaticIndex
+* List of changes revised on 2005 Jan 23 22:45 by tamc2
+* home page revised on 2005 Jan 23 22:31 by tamc2
+* Site Index revised on 2005 Jan 23 22:30 by AutomaticIndex
+* Known bugs revised on 2005 Jan 23 22:30 by tamc2
+* home page revised on 2005 Jan 23 22:29 by tamc2
+* Improving the style of this wiki revised on 2005 Jan 23 22:21 by tamc2
+* Pointers on how to use this wiki revised on 2005 Jan 23 22:20 by tamc2
+* Pointers on how to use this wiki revised on 2005 Jan 23 22:20 by tamc2
+* Pointers on how to use this wiki revised on 2005 Jan 23 22:19 by tamc2
+* Pointers on how to use this wiki revised on 2005 Jan 23 22:19 by tamc2
+* Pointers on how to use this wiki revised on 2005 Jan 23 22:18 by tamc2
+* Pointers on how to use this wiki revised on 2005 Jan 23 22:18 by tamc2
+* Pointers on how to use this wiki revised on 2005 Jan 23 22:17 by tamc2
+* Pointers on how to use this wiki revised on 2005 Jan 23 22:16 by tamc2
+* home page revised on 2005 Jan 23 22:09 by tamc2
+* Site Index revised on 2005 Jan 23 22:06 by AutomaticIndex
+* Recent Blog Entries revised on 2005 Jan 23 22:06 by AutomaticSummary
+* Site Index revised on 2005 Jan 23 22:06 by AutomaticIndex
+* Soks Licence revised on 2005 Jan 23 22:06 by AutomaticImport
+* Pointers on how to use this wiki revised on 2005 Jan 23 22:06 by AutomaticImport
+* Pointers on adjusting the settings revised on 2005 Jan 23 22:06 by AutomaticImport
+* Picture of a pair of soks revised on 2005 Jan 23 22:06 by AutomaticImport
+* Improving the style of this wiki revised on 2005 Jan 23 22:06 by AutomaticImport
+* How to import a site from instiki revised on 2005 Jan 23 22:06 by AutomaticImport
+* How to hack soks revised on 2005 Jan 23 22:06 by AutomaticImport
+* How to export a site from this wiki revised on 2005 Jan 23 22:06 by AutomaticImport
+* home page revised on 2005 Jan 23 22:06 by AutomaticImport