Soks 0.0.2 → 0.0.3

data/templates/instiki/views/messages.yaml

@@ -0,0 +1,6 @@
+:some_content_has_been_deleted : "Some content has been deleted"
+:Type_what_you_want_here_and_click_save : "Type what you want here and click save"
+:Create : "Create"
+:page_deleted : "page deleted"
+:content_moved_to : "content moved to" 
+:content_moved_from : "content moved from" 

data/templates/rails/attachment/2colheader.css

@@ -0,0 +1,77 @@
+/* Outer Frame */
+
+/* HEADER, LOGO ETC */
+div#header {
+	margin-left:20px;
+	margin-top:10px;
+	height:   160px;
+	overflow: hidden;
+	text-align: left;
+}
+
+div#header h1 {
+	height:                                         70px;
+	background-image:                       			url(/attachment/logotext.png);
+	background-repeat:                      			no-repeat;
+	background-position:            						0px 0px;
+	margin:                                         0;
+	margin-left:                            		140px;
+	padding:                                        0;
+	/* Move the header text away to leave the logo */
+	text-indent:                            -5000px;
+}
+
+div#logo {
+	float:                                          left;
+	width:                                          110px;
+	height:                                         140px;
+	margin-right:                           			31px;
+}
+
+p#navMain {
+   height:                                         42px;
+	margin:                                         10px;
+	padding:                                        16px;
+	color:                                          #FFFFFF;  
+}
+
+p#navMain a {
+padding:					0.2em 0.5em 0.2em 0.8em;
+text-decoration:			none;
+   color:                                  #FFFFFF; 
+	font-weight:                          	  bold;
+	border-left:				1px solid #FFFFFF;
+}
+
+p#navMain a:hover {	
+	text-decoration:			underline;
+	background-color:			transparent;
+}
+
+/* THE BODY */
+div#content {
+	position: absolute; 
+	top: 150px; 
+	left: 170px; 
+	width: auto;
+	margin-right: 35px; 
+}
+
+div#sidebar {
+	position: absolute; 
+	top: 180px; 
+	left: 35px; 
+	width: 120px; 
+	font-size: 0.8em;
+}
+
+div#sidebar h2 {
+	font-size: 1.1em;
+	font-weight: bold;
+	margin: 0em;
+}
+
+div#sidebar a {
+	display: block;
+}
+

data/templates/rails/attachment/basics.css

@@ -0,0 +1,98 @@
+body {  
+	color:						#333333;
+	
+   background-color:           				#FFFFFF;
+   background-image:               url(/attachment/header_backdrop.png);
+   background-repeat:              repeat-x;
+   background-position:            0 -25px;
+	font-size:	80%;
+	font-family: verdana, helvetica, arial, sans-serif;
+}
+
+/* HEADINGS */
+
+/* LINKS */
+a:link {
+        color:                                          #BB2233;
+}
+
+a:visited {
+        color:                                          #991122;
+}
+
+a:hover {
+        color:                                          #CC2233;
+        background-color:                       #EEEEEE;
+}
+
+span.nolink {
+		  color: #BB2233;
+			text-decoration: line-through; 
+}
+
+
+/* IMAGES */
+img { border: none; }
+
+/* FORMS */
+input:focus, textarea:focus, select:focus {
+        border-color:                           #333333;
+}
+
+.pagename {
+	font-size: xx-small;
+	display: block;
+}
+
+.disclaimer {
+	font-size: xx-small;
+	display: block;
+}
+
+.subpage {
+	padding: 10px;
+	margin: 10px;	
+	border: solid 1px #AAAAAA;
+	font-size:x-small;
+}
+
+p.more {
+	font-size: xx-small;
+	text-align: right;
+	padding: 0px;
+	font-color: #grey;
+}
+
+.subpage h1 {
+}
+
+.calendar td {
+	border: solid 1px #AAAAAA;
+	text-align: center;
+}
+
+.upcomingevents {
+	padding: 0px 10px 0px 10px;
+	margin: 0px;	border: solid 1px #AAAAAA;
+}
+
+a.pageview {
+	display: inline;
+}
+
+pre.change {
+	margin: 0px;
+	padding: 0px;
+}
+
+ul.tips {
+	list-style-type: none;
+}
+
+.metacolumn {
+	display: inline;
+	font-size: smaller;
+}
+
+
+

data/templates/rails/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/rails/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/rails/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/rails/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/rails/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/rails/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/templates/rails/content/Improving%20the%20style%20of%20this%20wiki.textile

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