Soks 0.0.2 → 0.0.3

data/templates/rails/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/rails/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/rails/content/Picture%20of%20a%20pair%20of%20soks.textile

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

data/templates/rails/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/rails/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/rails/content/Recent%20Blog%20Entries.textile

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

data/templates/rails/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

data/templates/rails/content/Site%20Index.textile

@@ -0,0 +1,16 @@
+h1. Site Index
+
+* Picture of a pair of soks 
+* AutomaticSummary 
+* home page 
+* How to export a site from this wiki 
+* How to hack soks 
+* How to import a site from instiki 
+* Improving the style of this wiki 
+* Known bugs 
+* List of changes 
+* Pointers on adjusting the settings 
+* Pointers on how to use this wiki 
+* Recent Blog Entries 
+* Recent Changes to This Site 
+* Soks Licence 

data/templates/rails/content/Soks%20Licence.textile

@@ -0,0 +1,64 @@
+h1. Soks is licensed under the The Ruby License
+
+Note: This licence applies to all that is contained in this distribution EXCEPT files within the contrib folder which may be under different licences.
+
+Soks is copyrighted (c) 2004, 2005 free software by Thomas Counsell tamc@rubyforge.org. 
+
+<pre>
+
+You can redistribute it and/or modify it under either the terms of the 
+GPL (see the file GPL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+          modifications to Usenet or an equivalent medium, or by allowing
+          the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+          with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+          together with instructions (in the manual page or equivalent)
+          on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+          the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     contrib directory.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+</pre>

data/templates/rails/content/home%20page.textile

@@ -0,0 +1,23 @@
+h1. Welcome! 
+
+You have succesfully installed soks. Remember it is work in progress, and definitely not fully de-bugged. So don't trust your mission critical sites to it. 
+
+If you are upgrading from a previous version, you may wish to glance at the list of changes.
+
+h2. Further information
+
+* Pointers on how to use this wiki
+* Improving the style of this wiki
+* Pointers on adjusting the settings such as the url, or the port, or 'advanced' features such as automatic calendars and summaries.
+* How to import a site from instiki
+* How to export a site from this wiki
+* How to hack soks
+* [[Known bugs]] (If you know how to fix them, please let me know!)
+
+h2. Feedback
+
+* Please send me your feedback.  tamc@rubyforge.com.  
+* Or submit a bug at  http://rubyforge.org/projects/soks/.  
+* To keep track of developments, you may wish to subscribe to the mailing list at http://rubyforge.org/projects/soks to be notified of updates.
+
+[[insert picture of a pair of soks]]

data/templates/rails/start.rb

@@ -0,0 +1,85 @@
+#!/usr/local/bin/ruby
+
+# This file was created automatically on <%= Time.now %>
+# Uncomment different sections to enable features of this wiki.
+
+#Add the required libraries to the search path:
+$:.push( "<%= settings[:soks_libraries].join('","') %>" )
+
+require 'soks'
+
+module StartSoks
+	
+=begin
+	# You can choose what level of authentication to apply based on regular expressions matched
+	# against the page title.  These regexps are tried in order.Defaults are here:
+	AUTHENTICATORS = [ [ %r{/(view|rss|print|find|meta)/.*}, WEBrick::HTTPAuth::NoAuthenticationRequired.new ],
+							 # [ %r{/upload/.*}, WEBrick::HTTPAuth::NotPermitted.new ],
+							 # [ %r{/(edit|save)/home page}, WEBrick::HTTPAuth::SiteWidePassword.new('password','You need to enter the site wide password to edit the home page') ],
+							# [ %r{/(view|edit|save)/private.*},WEBrick::HTTPAuth::BasicAuth.new( :UserDB => htpasswd, :Realm => realm ) ], # See webrick documentation
+							[ %r{.*}, WEBrick::HTTPAuth::AskForUserName.new( 'No password, just enter a name') ]						
+							] 
+
+=end
+
+	CUSTOMSETTINGS = {
+		:root_directory => '<%= settings[:root_directory] %>', 
+		# :name => 'test',
+		# :description => 'A Soks Wiki',
+		:url => '<%= settings[:url] %>',
+		:port => <%= settings[:port] %>,
+	   # :authenticators => AUTHENTICATORS
+	}
+	
+	def self.start
+		start_wiki( CUSTOMSETTINGS ) do |wiki, view|
+			AutomaticRecentChanges.new( wiki ) 
+
+			AutomaticOnePageIndex.new( wiki ) # Index on one page, best for small wikis
+			# AutomaticMultiPageIndex.new( wiki ) # One page per letter index, best for large wikis
+			
+			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
+
+
+
+			# Example of an automatically generated summary of any new pages whose title starts with 'blog'
+			AutomaticSummary.new( wiki, 
+				:regexp_for_title => /^Blog/i,
+				:max_pages_to_show => 10,
+				:pagename => 'Recent Blog Entries',
+				:only_new_pages => true,
+				:lines_to_include => 10,
+				:include_metadata => true
+				)
+			
+			 #  Possible settings for the Automatic Summary	(with defaults)
+		 	 #  :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, # nil puts a link, can pass a block instead to render
+			 #  :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
+			
+			# This is an array of titles that will NOT be automatically linked.
+			# Default is the 30 most common words in the english language
+			# Note that pages can still be created with these titles, and they can still be manually linked to.
+			banned_titles = IO.readlines('<%= settings[:root_directory] %>/banned_titles.txt').map { |title| title.strip }
+			
+			# This takes a while, so do it last. Note that the banned_titles argument is optional.
+			AutomaticUpdateCrossLinks.new( wiki, view, banned_titles ) 
+		end
+	end
+
+end
+
+if $0 == __FILE__ then
+	StartSoks::start
+end

data/templates/rails/version.txt

@@ -0,0 +1 @@
+0.0.3

data/templates/rails/views/Page_content.rhtml

@@ -0,0 +1 @@
+<%= page.content %>

data/templates/rails/views/Page_edit.rhtml

@@ -0,0 +1,61 @@
+<span class='pagename'><a href='/meta/<%= pagename %>'><%= pagename %></a></span>
+<form method=post action='/save/<%= pagename %>' >
+	<table>
+	<tr>
+		<td>Title:</td>
+		<td><input name='newtitle' size = '60' value='<%= pagename %>' onClick="this.value == 'Type a title here' ? this.value = '' : true"/></td>
+	</tr>
+	
+	<tr>
+		<td valign='top'>Content:</td>
+		<td>
+			<textarea name='content' rows=30 cols=60  onClick="this.value == 'Type what you want here and click save' ? this.value = '' : true" ><%= page.content %></textarea>
+		</td>
+		<td valign='top'>
+			<div class='tips'>
+			<ul>
+				<li>h1. big heading</li>
+				<li>h2. little heading</li>
+				<li>*bold text* = <b>bold text</b></li>
+				<li>_italic text_ = <i>italic text</i></li>
+				<li>* bullet one = &#8226; bullet one<br />
+					 * bullet two = &#8226; bullet two</li>
+				<li># list one  = 1. list one<br />
+					 # list two  = 2. list two</li>
+				<li>Most links are automatic</li>
+				<li>[[insert picture of title of picture]]</li>
+				<li><a href='http://hobix.com/textile/quick.html' target='textile_ref'>More</a></li>
+			</ul>
+			</div>
+		<td>
+	</tr>
+	<tr>
+		<td>Author:</td>
+		<td><a href='/<%= person %>'><%= person %></a> Quit browser to log out.</td>
+	</tr>
+	<tr>
+		<td></td>
+		<td><input name=action value='Save' type=submit accesskey="S"> <a href='/<%= pagename %>' accesskey="C" >(Do not Save)</a> or <a href='/delete/<%= pagename %>' accesskey='D'>(Delete)</a> this page.</td>
+	</tr>
+	</table>
+</form>
+<hr />
+<% unless page.empty? %>
+	<p>The most recent change was made by <a href='/<%= page.author %>'><%= page.author %></a> who changed:</p>
+		<% 
+		page.changes.each do |change_group|
+			change_group.each do |change|
+				case change[0]
+				when "-" %>
+					<del><%= change[1] %>. <%= change[2] %></del><br />
+		<% 	when "+" %>
+					<%= change[1] %>. <%= change[2] %><br />
+		<%		
+				end
+			end
+		end
+		%>
+		<p>
+		<a href='/rollback/<%= pagename %>?revision=<%= page.number-1  %>' accesskey="U" >(Undo this change)</a> or <a href='/revisions/<%= pagename %>' accesskey="A" >(Show All changes)</a>
+		</p>
+<% end %>