Soks 0.0.5 → 0.0.6

data/templates/default/content/New%20page%20templates%20or%20categories%20code.textile

@@ -0,0 +1,68 @@
+h1. New page templates or categories code
+
+In some case it might be useful to add a new page that is part of a particular category, or has some default content.  e.g. Add a new bug report, or Add a new contact).
+
+Bil Kleb has had success in writting this (copied from soks mailing list):
+
+Earlier, we had discussed adding various page categories, i.e., templates
+
+FWIW, here is what I hacked in to get there:
+
+h2. start.rb:
+
+<pre>
+<code>
+# defined a new type of summary:
+class AutomaticCategorySummary
+  def initialize( wiki, pagename )
+    plural = pagename.sub(/y$/,'ie') + 's'
+    AutomaticSummary.new( wiki, {
+                          :regexp_for_title => /#{pagename}:/i,
+                          :lines_to_include => 10,
+                          :reverse_sort => true,
+                          :pagename => "All #{plural}" } )
+    AutomaticSummary.new( wiki, {
+                          :regexp_for_title => /#{pagename}:/i,
+                          :max_pages_to_show => 1,
+                          :lines_to_include => 10,
+                          :reverse_sort => true,
+                          :pagename => "Latest #{plural}" } )
+  end
+end
+
+# added :categories key to the CUSTOMSETTINGS hash:
+ :categories => [ 'Trip report', 'Contact', 'Phone Call', 'Idea', 'Story', 'Thought' ]
+
+# added to self.start:
+  CUSTOMSETTINGS[:categories].each do |name|
+    AutomaticCategorySummary.new( wiki, name )
+  end if CUSTOMSETTINGS.has_key? :categories
+</pre>
+</code>
+
+h2. view/frame.rhtml:
+
+<pre>
+<code>
+# replaced "Add a new .*" section:
+  Add new:
+  <a href='<%= url 'Type a title here', 'edit' %>'>+ Page</a>
+  <% if $SETTINGS.has_key? :categories %>
+    <% $SETTINGS[:categories].each do |name| %>
+      <a href='<%= url "#{name}: Type a title here", 'edit' %>'>+ <%= name %></a>
+    <% end %>
+  <% end %>
+  <a href='<%= url 'Picture of Type a title here', 'edit' %>'>+ Image</a>
+  <a href='<%= url 'Attached Type a title here', 'edit' %>'>+ File</a>
+</pre>
+</code>
+
+
+h2. views/Page_edit.rhtml
+
+<pre>
+<code>
+ <td><input name='newtitle' size = '60' value='<%= pagename %>'
+            onClick="this.value=this.value.replace('Type a title here','')"/></td>
+</pre>
+</code>

data/templates/default/content/Per%20Wiki%20Templates.textile

@@ -0,0 +1,35 @@
+h1. Per Wiki Templates
+
+When you create a new wiki with the soks-create-wiki command, it copies the contents of path-to-soks-installation/templates/default into a new folder called soks-wiki.  
+
+If you change anything in the soks-wiki folder (see 'how to change the way this wiki looks' for ideas and tips) then it will apply to that wiki only.
+
+If you wish to create a default set up for future wikis:
+# Change a running wiki into a form that you find useful,
+# Create a new folder under path-to-soks-installation/templates/ e.g. path-to-soks-installation/templates/yourtemplate
+# Copy the contents of your running wiki to this new folder
+# (Optional) edit the path-to-soks-installation/templates/yourtemplate/start.rb file to allow the port, url, name etc to be set from the soks-create-wiki command (see the  path-to-soks-installation/templates/default/start.rb for ideas on how to do this)
+
+You can then use this template to create future wikis by using the --template option of the soks-create-wiki.rb command. e.g. @soks-create-wiki.rb --template yourtemplate@
+
+----
+
+I'm still confused as to exactly what templates are doing and why/when I would use them.  In other words, what's a typical use case?  --Bil
+
+So, the use I imagine is so that I a user of Soks might wish to be able to quickly deploy (by @soks-create-wiki.rb --template frenchwiki@)...
+# An internal team wiki
+# An external public wiki
+# A wiki that looks just like other wiki X
+# A French localised wiki
+# A wiki that acts like a blog and no more
+
+...Each with a diffent look and feel, different default automatic summaries, default authentication, with or without a calendar by default, etc.. etc... --tamc2
+
+What do the currently supplied instiki, default, and someother templates do for me?  (_Still_ dense on this topic.) --Bil
+
+For you?  Probably nothing!  They just show how can have a different look and feel.  The default, instiki and rails layouts are just the three different layouts I originally considered for Soks[1]:
+* Default has the content on the left, and the links etc on the right
+* Instiki has the links and control stuff at the top and bottom, with the content centered in the middle. Looks a lot like http://www.instiki.org
+* Rails has a big logo bar at the top, the content on the right, and the links etc on the left.  Looks a lot like http://wiki.rubyonrails.com
+
+fn1. I've only been updating the default template recently. 

data/templates/default/content/Planned%20Features.textile

@@ -1,19 +1,40 @@
 h1. Planned Features
 
-As an aside, in the longer term I'm hoping to incorporate some of the features of Soks into instiki, but in the mean time:
+In the long term I'm hoping to spend some time working on the instiki project to incorporate some of the features of Soks into instiki, but not until I've got soks stable and smooth.
 
-No plan survives, so this has changed:
+h2. v0-0-7:
 
-h2. v0-0-6: Focus on quality
+* Write a new Recent Changes class
+* Perhaps incorporate Bil Kleb's new page templates or categories code
+* A housekeeping routine that could periodically prune large revision files, and perhaps permanantly remove deleted pages after a while.
 
-# Improving the standard, beauty and quality of the included templates / skins / wiki looks
-# Refactoring to make the code easier to understand and hack
-
-h2. Desired Features
+h1. Desired Features
 
 Let me know if there is anything that you would like to see, or add it here:
 
+* Flesh out the RSS feed:
+** Have the item content render the most recent change information like that shown at the bottom of an edit page. (Remove the logo and search box?)
+** Have the source link be the "view" view and not the "rss" view.
+** Replace the <notextile>* [[ page title ]]</notextile> asterisk and brackets with quotation marks? --Bil
 * Fast CGI or the like as an alternative to Webrick
 * Give each automaticsummary a unique name so several can update the same page
 * Some form of tag to automatically create automatic summaries.
-* Make the wiki fork, and give commands to gracefully start and top it.
+* Make the wiki fork, and give commands to gracefully start and stop it.
+* I was going to make a suggestion, then I noticed that something like it had been added and deleted. Perhaps some explanitory text explaining what has already been suggested or what is or is not acceptable would be a good idea? - Sorry. A mistake on my part.  Please do make your suggestion again, and I won't delete any in future - tamc2
+** I think a generalized way of extending soks to be very much more dynamic would be allowing dirt-simple extensions. One way would be to put a @scripts@ directory in parallel with @attachment@ and extend @insert@ to then include the output of the script. So something like @[ [insert script helloworld blah ] ]@ would run helloworld.rb with the argument blah and the output would get pasted right into the wiki page. What do people think? --Skorgu
+** Interesting, what types of script did you have in mind?  The only challenge I can see is deciding how frequently to call the script to update the page, every time the page is viewed? or every time it is editted? or somewhere in between? what do you think? -- tamc
+** I'd say call the script each time the page is updated and let the script handle any sort of caching. The situation I had in mind is something like this: I have a page on Soks that has my frequently-loaded websites that I use as a start page. I'd like it if, instead of just saying "Red Handed":http://redhanded.hobix.com it said "Red Handed":http://redhanded.hobix.com (Last Post "Killer Hobix Tutorial...":http://redhanded.hobix.com/inspect/killerHobixTutorialInEnglishAndFrench.html ) and have the script pull the RSS and just update that. A more ambitious project would pull a list of URLs from say del.icio.us with tag "feed" or something and generate the link list itself. Once the capability exists to pipe script output into the wiki, everything else can be handled in those scripts. --Skorgu
+* Making the automatic linking only link one occurance of a title per page.  Currently can end up with far too many links to the same place on the same page.
+* A setting in start.rb to switch between Soks-style freeform pagenames and Instiki-style autolinks --Skorgu
+** By this, do you mean that you would like the option to have a WikiWord create a link? If so sounds possible as an option, although I personally dislike them! -- tamc 
+** I like the freeform linking, but there is one huge problem: if I'm writing a page and I decide that I want to add a link to a non-existant page, I need to either @[ [Double Bracket] ]@ it or click Add New Page, type the name, remember if I used a space or not, and then write my content. In Instiki, if you just write CamelCase it creates a link to the 'create this page' form with the title filled in and everything. Maybe keep the freeform linking but have an option to enable auto-linking for wiki words? --Skorgu
+** Ok, I'll look into it.  By the way, another way of doing this (if your browser supports this) is to highlight the text you wish to link and press ctrl-n. --Tom
+* Perhaps a category helper? To index references to particular key words
+* Perhaps the default layout should have a little table of contents menu like wikipedia pages.  (
+** I'm confused, isn't this already in 0.0.5? --Bil
+** Sorry, I'm not being clear.  What I was talking about is the thing labeled 'contents' at http://en.wikipedia.org/wiki/Wiki. If you create a long page with several headings, it creates a little table of contents at the top so you can leap down the page quickly.
+** Ah, cool item but it would seem to encourage long pages? --Bil
+
+Also considering these bigger changes (interested in your thoughts):
+* Making the automatic linking ignore punctuation.  Only the words in page titles would be significant, so "Bug: A bug" would be treated the same as "Bug- A bug" -- tamc
+* Making the automatic linking link to 'similarly' title pages. e.g: If you have a page called "Page One" and another called "Page Two" all instances of the word "One" in "Page Two" would link to "Page One".  Would add a lot of processing, but might allow distinct namespaces. -- tamc

data/templates/default/content/README.textile

@@ -2,6 +2,7 @@ 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/
+* The project wiki/home page is at www.soks.org
 
 Quickstart:
 # gem install Soks
@@ -17,12 +18,13 @@ 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.
+* The author appreciates the code, suggestions and libraries provided by a buch of other people, see www.soks.org/author for individual acknowledgements.
 
 h2. INSTALL
 
 Preferably:
 # Install rubygems from http://rubyforge.org/projects/rubygems/
-# gem install Soks (you may need to be root first)
+# @gem install Soks@ (you may need to be root first)
 
 Alternatively
 # Download the tar or zip file from http://rubyforge.org/projects/soks/
@@ -31,13 +33,17 @@ Alternatively
 
 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)
+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. UPGRADE
+
+If you already have a previous version of soks then to upgrade, run @soks-create-wiki.rb --destination-dir=path/to/your/wiki@ and it will guide you through the upgrade.
+
 h2. FEATURES
 
 # Runs on its own webrick server (no independent web server required)
@@ -52,12 +58,16 @@ h2. FEATURES
 h2. BUGS
 
 I suspect there are many, as befits its version number.  In particular it has:
-* No authentication on pictures and attachments
-* Punctuation in page titles problematic. ? <> and [] cause problems.  : and / are ok.
 * Insert page commands are not inhibited by notextile, pre or code tags
+* Does not permit browsers to cache pages
+* Not user friendly in the way it handles simultaneous edits of a page (last person to save wins)
+* Some bugs in layout and formatting of text.
+
+See http://www.soks.org/wiki/KnownBugs for details.
 
 h2. RELEASES
 
+# 2005 Mar 15 - soks-0.0.6 - Fourth public release (alpha)
 # 2005 Feb 12 - soks-0.0.5 - Third public release (alpha)
 # 2005 Jan 24 - soks-0.0.4 - Second public release  (alpha)
 # 2005 Jan 11 - soks-0.0.2 - First public release (alpha)

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

@@ -5,3 +5,5 @@ Each page has an rss feed accesses at the url /rss/pagename.  This contains the
 The rss currently only shows:
 * Changes to the textile (not html)
 * Added lines
+
+Note there is a bug: RSS feed does not validate