Soks 0.0.3 → 0.0.4

data/templates/default/views/Page_rss.rhtml

@@ -18,7 +18,7 @@ RSS::Maker.make("2.0") do |maker|
 	maker.items.do_sort = true
 
 	count = 0
-	for revision in page.revisions
+	page.revisions.reverse_each do |revision|
 		break if (count +=1) == 15
 		item = maker.items.new_item
 		item.link = "#{$SETTINGS[:url]}/#{pagename}"

data/templates/default/views/frame.rhtml

@@ -16,12 +16,13 @@
 	<div id='menu'>
 		<a href='/Home Page' accesskey='H' ><img width='149' src='/attachment/logo.png' alt='<%= @wikiname %>' /></a> 
 		<form method='get' action='/find/<%= pagename %>' >
-			<input name='regex' value='' size='18' />
+			<input class='search' name='regex' value='' size='18' />
 			<input name='action' value='search' type='submit' />
 		</form>
 		<a href='/site index' accesskey='I' >Site Index</a> 
 		<a href='/recent changes to this site' accesskey='R' >Recent Changes</a>
-		<% if page %>
+		<% if page %>
+			<br />
 			<% page.links_to.each do |linkedpage| %>
 				<a href='/<%= linkedpage.name %>'><%= linkedpage.name %></a>
 			<% end %>

data/templates/instiki/content/All%20News.textile

@@ -0,0 +1,9 @@
+h2. All News
+
+p{font-size: x-small;}. All News was created automatically from pages whose title matches /^News:/i.
+
+<automaticsummary>
+
+No pages found to summarise
+
+</automaticsummary>

data/templates/instiki/content/Author.textile

@@ -0,0 +1,12 @@
+h1. The Author
+
+Soks was written by Tom Counsell.  He can be reached at tamc@rubyforge.org.  
+
+Further details can be found at http://tom.counsell.org.
+
+h2. Thanks to
+
+* Sebastien Clediere for a patch to fix uploads on windows
+* _why for the RedCloth library
+* Austin Ziegler for the Diff:LCS library
+* Matz and ruby-core for the ruby language

data/templates/instiki/content/Automatic%20Summaries.textile

@@ -0,0 +1,77 @@
+h1. Automatic Summaries
+
+Any class can register to be notified of changes to the wiki by:
+<code>
+@wiki.watch_for( :page_created ) { |event, page, revision| do whatever you want }
+@wiki.watch_for( :page_revised ) { |event, page, revision| do whatever you want }
+@wiki.watch_for( :page_deleted ) { |event, page, revision| do whatever you want }
+</code>
+
+These notifications are sent by a separate low priority thread from the one that is interacting with the user.   Using these notifications a class can make changes to the wiki by calling:
+<code>
+@wiki.revise( pagename, newcontent, author )
+</code>
+
+In soks-helpers.rb you will find some classes that make use of this api.  One particular one is the AutomaticSummary class.  This watches for changes to the wiki, and if the page that is changed matches a given regexp, adds it to a summary page.
+
+It has quite a powerful set of settings, defaults 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, # If nil then justs puts a link, otherwise includes X number of lines from the page in the summary
+		:only_new_pages => false, # Otherwise includes changes
+		: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, # If true 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>
+
+Two examples of its use, included in the soks-helpers.rb file, are the Site Index and the Recent Changes page:
+
+<code>
+AutomaticSummary.new( wiki, {
+ 	:regexp_for_title => /.*/ # Match all pages
+        :pagename => 'Site Index',
+	:author => 'Automatic Site Indexer',
+	:only_new_pages => true,
+	:sort_pages_by => :name_for_index,
+} )
+</code>
+
+<code>
+AutomaticSummary.new( wiki, { 
+ 	:regexp_for_title => /.*/ # Match all pages
+        :pagename => 'Recent Changes',
+	:author => 'Automatic Recent Changes',
+	:only_new_pages => false,
+	:sort_pages_by => :revised_on,
+	:include_metadata => true,
+	:summarise_revisions => true,
+	:reverse_sort => true,
+	:remove_deleted_pages => false,
+})
+</code>
+
+You might also use it to construct a basic blog class:
+<code>
+AutomaticSummary.new( wiki, { 
+ 	:regexp_for_title => /^Blog:.*/ # Match all pages starting with blog
+        :pagename => 'Recent Blog Entries',
+	:author => 'Automatic Blog Watcher',
+        :max_pages_to_show => 10 # Only show the ten most recent blogs
+        :lines_to_include => 20 # Show the first 20 lines of each blog entry
+	:only_new_pages =>true,
+	:sort_pages_by => :created_on,
+	:include_metadata => true,
+	:reverse_sort => true,
+})
+</code>
+
+If you have any other ideas or examples, please add them here

data/templates/instiki/content/Automatic%20linking%20between%20pages.textile

@@ -0,0 +1,5 @@
+h1. Automatic linking between pages
+
+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 links are made left to right, top to bottom, with the longest possible link made at any given time.

data/templates/instiki/content/Bug%3A%20Automatic%20link%20links%20to%20stuff%20inside%20%3Chtml.textile

@@ -0,0 +1 @@
+content moved to [[Fixed bug: automatic link links to stuff inside <html> tags]]

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

@@ -0,0 +1 @@
+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.

data/templates/instiki/content/Bug%3A%20Duplicate%20links%2Dto%20a%20page%20sometimes%20appear.textile

@@ -0,0 +1 @@
+On the right hand side of a page are normally links to other pages that link to this page.  In some cases these might have several copies of the same link.

data/templates/instiki/content/Bug%3A%20External%20links%20incorrectly%20include%20trailing%20pu.textile

@@ -0,0 +1 @@
+External links, such as www.slashdot.org incorrectly include trailing punctuation like the full stop on the end of this sentence: www.slashdot.org.

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

@@ -0,0 +1 @@
+It seems that Ruby GEM limits filename lengths, which means there is a limit on title lengths.  I am unclear what the limit for filename length is? and how this varies by platform?

data/templates/instiki/content/Bug%3A%20In%20a%20list%20of%20links%2C%20the%20last%20link%20is%2.textile

@@ -0,0 +1 @@
+content moved to [[Fixed Bug: In a list of links, the last link is sometimes not linked]]

data/templates/instiki/content/Bug%3A%20Inserted%20pages%20are%20not%20refreshed%20when%20new%20.textile

@@ -0,0 +1 @@
+content moved to [[Fixed Bug: Inserted pages are not refreshed when new autolinks are made]]

data/templates/instiki/content/Bug%3A%20No%20robots%2Etxt%20or%20favicon%2Eico.textile

@@ -0,0 +1 @@
+By default no robots.txt or favicon.ico (and no way of including favicon.ico at all?)

data/templates/instiki/content/Bug%3A%20Page%20titles%20cannot%20have%20html%20tags%20in%20them.textile

@@ -0,0 +1 @@
+Any page that has anything like an html tag <pre><html></pre> or whatever cannot be autolinked, and if a forced link is made then server errors occur.

data/templates/instiki/content/Bug%3A%20RSS%20feed%20shows%20oldest%2015%20revisions%20%28not%20.textile

@@ -0,0 +1 @@
+content moved to [[Fixed Bug: RSS feed shows oldest 15 revisions (not newest!)]]

data/templates/instiki/content/Bug%3A%20Search%20box%20width%20does%20not%20match%20column%20wid.textile

@@ -0,0 +1 @@
+content moved to [[Fixed Bug: Search box width does not match column width]]

data/templates/instiki/content/Bug%3A%20Site%20Index%20updates%20on%20every%20revision.textile

@@ -0,0 +1 @@
+content moved to [[Fixed Bug: Site Index updates on every revision]]

data/templates/instiki/content/Bug%3A%20Symbols%20are%20not%20always%20correctly%20rendered%20in.textile

@@ -0,0 +1 @@
+content moved to [[Fixed Bug: Symbols are not always correctly rendered in html]]

data/templates/instiki/content/Bug%3A%20Uploads%20are%20not%20password%20protected.textile

@@ -0,0 +1,3 @@
+Anything uploaded to the website (e.g. pictures, or attached files) is not protected by any form of authentication.  
+
+If anyone knows how to add authentication to the Webrick FileHandler then please let me know.

data/templates/instiki/content/Fixed%20Bug%3A%20In%20a%20list%20of%20links%2C%20the%20last%20lin.textile

@@ -0,0 +1,13 @@
+In a list of links, the last link is sometimes not linked.
+
+e.g: 'How to administrate this wiki' might not be linked in this list:
+
+* How to export a site from this wiki 
+* How to hack soks 
+* How to import a site from instiki 
+* How to use this wiki 
+* How to change the way this wiki looks 
+* How to administrate this wiki 
+
+
+Fixed in v0-0-4

data/templates/instiki/content/Fixed%20Bug%3A%20Inserted%20pages%20are%20not%20refreshed%20when%.textile

@@ -0,0 +1,9 @@
+If page one inserts the content of page two using [ [ insert page two ]] then if the content of page two is changed, page one correctly updates.  However, if a page three is created, and this is automatically linked from page two, it does not automatically trigger a refresh on page one.
+
+Solution is probably to modify /lib/soks-view.rb to put:
+<code>
+page.inserted_into.each { |page| refresh_redcloth( page ) }
+</code>
+On line 453, or somerwhere nearby in the refresh_redcloth method.
+
+Fixed in v0-0-4

data/templates/instiki/content/Fixed%20Bug%3A%20RSS%20feed%20shows%20oldest%2015%20revisions%20%.textile

@@ -0,0 +1,15 @@
+The RSS feed only includes 15 items (in order to meet with the standard as I understand it). Unfortunately when the number of revisions > 15 it only shows the oldest revisions.  Dopey.
+
+Fixed in v0-0-4
+
+Fix is in templates/default/views/Page_rss.rhtml
+
+Replace
+<code>
+for revision in page.revisions
+</code>
+
+with 
+<code>
+page.revisions.reverse_each do |revision|
+</code>

data/templates/instiki/content/Fixed%20Bug%3A%20Search%20box%20width%20does%20not%20match%20colu.textile

@@ -0,0 +1,3 @@
+The search box on the right does not match the width of the bar, making it look odd.
+
+Fixed in v0-0-4

data/templates/instiki/content/Fixed%20Bug%3A%20Site%20Index%20updates%20on%20every%20revision.textile

@@ -0,0 +1,3 @@
+Recent Changes suggests that the Site Index updates on every revision, not just on page created or deleted.
+
+Not sure it does anymore?  Maybe fixed? Hope so.

data/templates/instiki/content/Fixed%20Bug%3A%20Symbols%20are%20not%20always%20correctly%20rende.textile

@@ -0,0 +1,5 @@
+Symbols are often incorrectly encoded in the textile to html conversion.  
+
+Eg. > should be the same as <notextile>></notextile>
+
+Fixed in v0-0-4

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

@@ -0,0 +1,19 @@
+h1. Congratulations, you have installed SOKS 
+
+Welcome to Soks.  It is yet another wiki, written in ruby.  Please bear in mind that it is alpha, and therefore do not trust your mission critical sites to it.  Please feel free to use and adapt, the soks licence is free and liberal (although if you feel like contributing towards a new mac for the author that would be apreciated).  
+
+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://soks.counsell.org
+
+[[insert SOKS features]]
+
+[[insert Instructions and Howtos]]
+
+[[insert known bugs]]
+
+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.
+
+[[insert picture of a pair of soks]]

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

@@ -58,4 +58,4 @@ The WikiServlet deals with file uploads by separately writing 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.
+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. See automatic summaries for a little more detail.

data/templates/instiki/content/How%20to%20install%20Soks.textile

@@ -0,0 +1,27 @@
+h1. How to install Soks
+
+h2. Requirements
+
+Essential: Ruby 1.8.2 from http://www.ruby-lang.org/en/
+Preferred: Ruby Gems from http://rubyforge.org/projects/rubygems/
+
+h2. The easy install
+
+If you have ruby gems, type:
+<code>
+gem install Soks
+soks-create-wiki.rb
+</code>
+
+...and then surf to http://localhost:8000
+
+h2. The harder install
+
+Download the latest version of Soks from http://rubyforge.org/frs/?group_id=481
+
+<code>
+tar -xvzf Soks-0.0.3.tgz
+ruby Soks-0.0.3/bin/soks-create-wiki.rb
+</code>
+
+...and then surf to http://localhost:8000

data/templates/instiki/content/How%20to%20use%20the%20keyboard%20shortcuts.textile

@@ -0,0 +1,13 @@
+h1. Keyboard Shortcuts
+
+Soks has a number of keyboard short cuts.  Depending on your browser, only some of them will work:
+
+* ctrl-n : New page.  Will use whatever text you had selected as the title of the new page (definitely only works on a few browsers)
+* ctrl-e: Edit page, and if you are editing:
+** ctrl-s saves the page 
+** ctrl-c cancels the editing
+** ctrl-u undos the previous edit
+** ctrl-a shows all the previous changes
+* ctrl-h: Home page
+* ctrl-i: Site Index
+* ctrl-r: Recent changes to this site

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

@@ -10,11 +10,11 @@ There are several ways to add pages to soks:
 
 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.
+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 failures.
 
 h2. Editing Pages
 
-* To edit a page, click edit. 
+* To edit a page, click edit this page at the bottom of the page. 
 * 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>

data/templates/instiki/content/Instructions%20and%20Howtos.textile

@@ -0,0 +1,17 @@
+h2. Instructions and Howtos
+
+p{font-size: x-small;}. Instructions and Howtos was created automatically from pages whose title matches /^How to /i.
+
+<automaticsummary>
+
+* [[ How to administrate this wiki ]] 
+* [[ How to change the way this wiki looks ]] 
+* [[ How to export a site from this wiki ]] 
+* [[ How to hack soks ]] 
+* [[ How to import a site from instiki ]] 
+* [[ How to install Soks ]] 
+* [[ How to use the keyboard shortcuts ]] 
+* [[ How to use this wiki ]] 
+
+
+</automaticsummary>

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

@@ -1,8 +1,16 @@
-h1. Known Bugs
+h2. Known bugs
 
-_If you can fix any of the bugs here, please let me know.  If you spot any more, please let me know._
+p{font-size: x-small;}. Known bugs was created automatically from pages whose title matches /^Bug:/i.
 
-* 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
- 
+<automaticsummary>
+
+* [[ Bug: Does not make use of if-modified-since request headers ]] revised on 2005 Jan 25 18:23 by AutomaticImport
+* [[ Bug: Duplicate links-to a page sometimes appear ]] revised on 2005 Jan 25 18:23 by AutomaticImport
+* [[ Bug: External links incorrectly include trailing punctuation ]] revised on 2005 Jan 25 18:23 by AutomaticImport
+* [[ Bug: Uploads are not password protected ]] revised on 2005 Jan 25 18:23 by AutomaticImport
+* [[ Bug: Page titles cannot have html tags in them ]] revised on 2005 Jan 26 08:11 by tamc2
+* [[ Bug: No robots.txt or favicon.ico ]] revised on 2005 Jan 26 08:12 by tamc2
+* [[ Bug: GEM limits title lengths ]] revised on 2005 Jan 26 08:55 by tamc2
+
+
+</automaticsummary>

data/templates/instiki/content/Latest%20News.textile

@@ -0,0 +1,9 @@
+h2. Latest News
+
+p{font-size: x-small;}. Latest News was created automatically from pages whose title matches /^News:/i.
+
+<automaticsummary>
+
+No pages found to summarise
+
+</automaticsummary>

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

@@ -1,6 +1,6 @@
 h1. List of changes
 
-h2. Between v-0-1-0 and v-0-0-2
+h2. Between v-0-0-3 and v-0-0-2
 
 h3. Features
 
@@ -14,6 +14,7 @@ h3. Features
 * 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
 

data/templates/instiki/content/Picture%20of%20Type%20a%20title%20here.textile

@@ -0,0 +1 @@
+page deleted

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

@@ -1 +1 @@
-/attachment/logo.tiff
+/attachment/logo.png

data/templates/instiki/content/README.textile

@@ -0,0 +1,61 @@
+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/
+
+Quickstart:
+1. gem install Soks
+2. soks-create-wiki.rb
+3. 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.
+
+h2. INSTALL
+
+Preferably:
+1. Install rubygems from http://rubyforge.org/projects/rubygems/
+2. gem install Soks (you may need to be root first)
+
+Alternatively
+1. Download the tar or zip file from http://rubyforge.org/projects/soks/
+2. Unzip or untar it
+3. 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. FEATURES
+
+  1. Runs on its own webrick server (no independent web server required)
+  2. Uses textile as its text coding (a proto-standard) 
+  3, Uses a combination of flat and yaml files for storage (no database, and page content human readable outside of soks)
+  3. Allows uploads
+  4. Allows authentication
+  5. Automatically links pages within the wiki
+  6. Pages can be deleted and moved easily (and these can be undone)
+  7. 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:
+* Not got any way of securing pictures or attachments added to the wiki
+* Uses RedCloth 2.0.11 which has some formatting bugs (and no doubt some extra ones introduced by my clumsy extentions).  RedCloth 3.0.1 is included but not enabled because it tends to hit stack overflows frequently for me.
+
+h2. RELEASES
+
+2005 Jan 24 - soks-0.0.3 - Second public release  (alpha)
+2005 Jan 11 - soks-0.0.2 - First public release (alpha)

data/templates/instiki/content/RSS%20feed.textile

@@ -0,0 +1,7 @@
+h1. RSS Feed
+
+Each page has an rss feed accesses at the url /rss/pagename.  This contains the last 15 revisions to a page.
+
+The rss currently only shows:
+* Changes to the textile (not html)
+* Added lines

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

@@ -1,3 +1,5 @@
-h1. Recent Blog Entries
+h2. Recent Blog Entries
+
+p{font-size: x-small;}. Recent Blog Entries was created automatically from pages whose title matches /^Blog:/i. Do not edit this page directly.
 
 No pages found to summarise