ruwiki 0.9.0

data/data/Ruwiki/Extending_Ruwiki.ruwiki

@@ -0,0 +1,317 @@
+page!content:	= Extending Ruwiki 0.9.0
+	Ruwiki is relatively easily extended to support new features. There are
+	four primary ways in which Ruwiki can be extended or modified by the
+	end user: templates, translating Ruwiki messages and labels, markup
+	tokens, and creating new backends.
+	
+	== Templates
+	Templating is done with a heavily modified version of the \RDoc
+	template.rb library included in the distribution of Ruwiki. The
+	templating library allows for nested templates, and this is used
+	extensively in Ruwiki. This library is documented in
+	RuwikiTemplatingLibrary.
+	
+	There are four major templates: content, edit, save, and error. Each of
+	these has a slightly different combination of template files used, and
+	this means that there are different sets of variables available.
+	
+	The major templates are “composite templates” that are
+	defined as follows:
+	; content or search : body.tmpl, content.tmpl, controls.tmpl, footer.tmpl
+	; edit or preview : body.tmpl, edit.tmpl
+	; save : body.tmpl, save.tmpl, controls.tmpl, footer.tmpl
+	; error : body.tmpl, error.tmpl
+	
+	=== Common Variables
+	The following template variables are presented for all composite
+	templates.
+	; <tt>%css_link%</tt> : The contents of the CSS file for the template set.
+	; <tt>%home_link%</tt> : A link to the root page of the Wiki.
+	; <tt>%editable%</tt> : A boolean value to mark the page as editable or not. Used in a conditional block in the templates.
+	; <tt>%cgi_url%</tt> : The URL for the Wiki.
+	; <tt>%content%</tt> : The formatted content of the current page.
+	; <tt>%page_project%</tt> : The project for the current page.
+	; <tt>%page_raw_topic%</tt> : The topic for the current page, escaped for safe transmission over the web.
+	; <tt>%page_topic%</tt> : The printable topic for the current page.
+	; <tt>%url_project%</tt> : The URL to the current page&rsquo;s project.
+	; <tt>%url_topic_search%</tt> : The URL to search for the current topic in the current project.
+	; <tt>%link_topic_search%</tt> : A link to the current topic search.
+	
+	=== Variables for :content, :save, :search, :edit, :preview
+	; <tt>%message%</tt> : A message presented at the top of the Wiki when Ruwiki needs to inform the user of something that is not an error.
+	
+	=== Variables for :content, :save, :search
+	; <tt>%wiki_title%</tt> : The title of the Wiki.
+	; <tt>%label_topic_or_search%</tt> : Either <tt>#topic#</tt> or <tt>#search#</tt>.
+	; <tt>%page_topic_name%</tt> : The same as <tt>%page_topic%</tt>.
+	
+	=== Variables for :edit, :preview
+	; <tt>%wiki_title%</tt> : The title of the Wiki with a tag to indicate that the page is being edited.
+	; <tt>%page_content%</tt> : The content of the page.
+	; <tt>%page_version%</tt> : The current version number of the page.
+	; <tt>%unedited_page_content%</tt> : The formatted, unedited content of the page.
+	; <tt>%pre_page_content%</tt> : A Web-escaped form of the page content.
+	; <tt>%edit_comment%</tt> : The current edit comment.
+	
+	=== Variables for :error
+	; <tt>%wiki_title%</tt> : The title of the Wiki with an error message.
+	; <tt>%name%</tt> : The name of the error.
+	; <tt>%backtrace%</tt> : The backtrace of the error.
+	; <tt>%backtrace_email%</tt> : The backtrace of the error formatted for sending by email.
+	; <tt>%webmaster%</tt> : The email address of the webmaster.
+	
+	== Translating Ruwiki Messages
+	: NOTE: The mechanism for specifying language may be changed in a
+	: future version of Ruwiki, although the internationalisation mechanism
+	: will not be changing.
+	
+	Ruwiki is internationalized. This method sets the Ruwiki error messages
+	(and a few other messages) to the specified language Module. The
+	language Module must have a constant Hash called <tt>Message</tt>
+	containing a set of symbols and localized versions of the messages
+	associated with them.
+	
+	If the file <em>ruwiki/lang/es.rb</em> contains the module
+	<tt>Ruwiki::Lang::ES</tt>, the messages for RSS could be localized to
+	Spanish thus:
+	
+	  require 'ruwiki/lang/es'
+	  ...
+	  wiki.config.language = Ruwiki::Lang::ES
+	
+	Localization is currently per wiki instance. In a servlet environment,
+	this may mean that only a single language is recognised.
+	
+	It is recommended that the hash be created with a default proc that
+	reports unknown message keys.
+	
+	  Message = Hash.new { |h, k| "Language ERROR: Unknown message key #{k.inspect}." }
+	
+	== Extending Ruwiki Markup
+	
+	: <strong>WARNING:</strong> These \APIs will change in Ruwiki 0.9.0,
+	: replacing the instance variables @project, @backend, and @script with
+	: a Handler object. There may be other changes as well.
+	
+	Ruwiki&rsquo;s WikiMarkup can be extended by creating a new
+	Ruwiki::Wiki::Token. Tokens will be automatically loaded if they are
+	placed in <em>ruwiki/wiki/tokens</em>.
+	
+	It is recommended that new tokens be added to the test cases in
+	<tt>tests/tc_tokens.rb</tt>.
+	
+	The following Ruwiki::Wiki::Token class will convert strings in the
+	forms of \[ruby-talk:12345] to links.
+	
+	  class RubyTalkLinks < Ruwiki::Wiki::Token
+	    def self.rank
+	      2
+	    end
+	
+	    def self.regexp
+	      %r{\[ruby-talk:(\d+)\]}
+	    end
+	
+	    def replace
+	      lm = @match.captures[0]
+	      %Q(<a class="rw_extlink" href="http://www.ruby-talk.org/#{lm}">#{@match[0]}</a>)
+	    end
+	  end
+	
+	=== Known Instance Variables
+	==== @match
+	The match data for this token instance is is kept in @match. This is
+	what will be used in #replace and #restore.
+	
+	==== @project
+	The project being processed.
+	
+	==== @backend
+	The Backend for the wiki. If you are using Ruwiki tokenizers outside of
+	Ruwiki, this does not need to be a \BackendDelegator, but can be the
+	direct Backend (which expects less information).
+	
+	==== @script
+	The URI to the script.
+	
+	==== @message
+	The message hash for displaying localised messages.
+	
+	==== @title
+	The title of the wiki instance.
+	
+	=== Required Methods
+	==== ::regexp
+	Ruwiki tokens are matched only through regular expression matches. As
+	shown in the example above, the regular expression for ruby-talk
+	mailing list posts is <tt>%r{\[ruby-\talk:(\d+)\]}</tt>. The purpose of
+	the ::regexp method is to return the regexp for matching.
+	
+	For most inline matches, Ruwiki will ensure that the escape character
+	(\) works automatically. For whole-line matches, it is necessary to
+	match the escape character manually and provide a #restore method.
+	
+	As an example, the \HRule class implements these methods.
+	
+	  def self.regexp
+	    %r|^\\?-{4,}|
+	  end
+	
+	  def restore
+	    @match[0][1 .. -1]
+	  end
+	
+	It may also be necessary to match escapes manually on inline matches
+	that must be along word boundaries where the regular expression
+	includes characters that normally match word boundaries. The project
+	index match (e.g., \::Ruwiki) regular expression does this
+	<tt>%r{(\B|\\)::([A-Z][a-z]+)}</tt>.
+	
+	==== #replace
+	This returns the formatted token. In the \RubyTalkLinks class above,
+	the matched regular expression will be replaced with a hyperlink. The
+	text of the hyperlink will be the matched text; the target of the
+	hyperlink will include the first captured value.
+	
+	  def replace
+	    lm = @match.captures[0]
+	    %Q(<a class="rw_extlink" href="http://www.ruby-talk.org/#{lm}">#{@match[0]}</a>)
+	  end
+	
+	=== Optional Methods
+	==== ::rank
+	By default, a token will be processed in the order created. Tokens may
+	be given a specific rank to ensure that they are processed in a
+	particular order. The default rank is <tt>9999</tt>.
+	
+	==== #restore
+	Restores the token without replacement. Implements the results of the
+	escape character. Each Token class is responsible for its own
+	restoration. As noted in #regexp, whole-line tokens are most likely to
+	need a #restore implementation.
+	
+	==== ::post_replace
+	Performs any necessary massaging of the data. The Lists token uses this
+	to ensure that lists are collapsed together; the Paragraph token uses
+	this to ensure that there are no empty paragraph tag pairs
+	(&lt;p&gt;&lt;/p&gt;).
+	
+	: <strong>Note:</strong> This has been changed from Ruwiki 0.6.x.
+	: Plugins written for the Ruwiki 0.6.x Token API will need to be
+	: modified so that this is defined as:
+	
+	  def self.post_replace
+	    ...
+	  end
+	
+	: as opposed to:
+	
+	  def post_replace
+	    ...
+	  end
+	
+	== Extending Ruwiki Backends
+	Ruwiki can support varying backends, as the backend interface has been
+	abstracted completely from the data store. The backend
+	<strong>must</strong>:
+	
+	# reside in <em>ruwiki/backends/</em> as <em>backend_name</em>.rb.
+	# be registered by adding the <em>backend_name</em> as a symbol (e.g., :<em>backend_name</em>) to Ruwiki::KNOWN_BACKENDS.
+	# inherit from Ruwiki::Backend.
+	# exist as Ruwiki::Backend::<em>\Backend_name</em>.
+	
+	=== Required Methods
+	==== #initialize(storage_options)
+	The backend may only obtain its configuration information from an
+	option hash provided by the \BackendDelegate. This is obtained from
+	<tt>wiki.config.options[backend]</tt>. If a configuration error is
+	detected during initialization, the backend should raise the
+	\Ruwiki::Backend exception class \BackendError. This would be done
+	with:
+	
+	  raise Ruwiki::Backend::BackendError.new([:message_symbol, [message_parameters]])
+	
+	Backend writers should add appropriate messages to the
+	<em>lang/en.rb</em> at a minimum. The \BackendDelegator will detect
+	this and report the results appropriately.
+	
+	==== #load(topic, project)
+	The backend will be provided the name of the topic and project. It must
+	return the selected page as a hash of hashes. The hash must match that
+	of \Ruwiki::Page#export. It will be passed as the parameter to
+	\Ruwiki:::Page.new.
+	
+	==== #store(page)
+	This method must store the provided Ruwiki::Page object. Current Ruwiki
+	backend implementations store the Ruwiki::Page#export hash. This method
+	is responsible for calling the private method Backend#make_diff and
+	adding the result to the list of diffs for the page.
+	
+	===== Backend#make_diff(oldpage, newpage)
+	This method expects two page objects, or their Ruwiki::Page#export
+	representation. It will return a hash representing the difference set
+	between the two pages.
+	
+	==== #obtain_lock(page, time, expire, address = 'UKNOWN')
+	Obtains an exclusive lock on the page. The \BackendDelegator is called
+	with the page, the address, and a timeout which is provided. The time
+	is provided by the call to the BackendDelegate, and the expire is also
+	provided by the call to the BackendDelegate which is given a timeout
+	value (by default 600 seconds). If the lock is still in effect, a
+	second call to #obtain_lock should renew the timeout on the lock.
+	
+	==== #release_lock(page, address = 'UNKNOWN')
+	Releases the exclusive lock on the page. The lock should not be released
+	unless the IP address on the lock is the same or the lock has expired.
+	
+	==== #project_exists?(project)
+	Returns <tt>true</tt> if the project exists.
+	
+	==== #page_exists?(topic, project = 'Default')
+	Returns <tt>true</tt> if the page exists within the specified project.
+	
+	==== #create_project(project)
+	Attempts to create the project.
+	
+	==== #search_project(project, search_string)
+	String search all topic names and content in a project and return a
+	hash of topic hits:
+	
+	  topicname => hits
+	
+	==== #list_projects
+	Return an array of all projects.
+	
+	==== #list_topics(project)
+	Return an array of all topics within the project.
+	
+	=== Future Methods
+	Note that these methods are currently optional (they are not yet called
+	from Ruwiki), but will become required moving forward as the functions
+	are implemented in Ruwiki.
+	
+	==== #destroy(page)
+	Removes the page from the wiki. This should <strong>not</strong> remove
+	the change history of the topic (in the event that the page has been
+	removed maliciously). There will be a separate method to remove the
+	page history.
+	
+	==== #destroy_project(project)
+	Attempts to destroy the project.
+	
+	=== Optional Methods
+	These methods are completely optional. They are guarded in the
+	\BackendDelegate by a call to #respond_to?().
+	
+	==== #global_search(search_string)
+	The global search in the backend delegate is by default implemented as
+	a looping search through all projects. A backend may have a more
+	efficient backend global search mechanism. If the backend responds to
+	#global_search, then the \BackendDelegate will use this method.
+properties!project:	Ruwiki
+properties!title:	Extending_Ruwiki
+properties!topic:	Extending_Ruwiki
+properties!version:	1
+ruwiki!content-version:	2
+ruwiki!version:	0.9.0
+properties!editable:	false

data/data/Ruwiki/LicenseAndAuthorInfo.ruwiki

@@ -0,0 +1,30 @@
+page!content:	= Ruwiki Licence
+	Ruwiki is copyright © 2002 - 2004 [mailto:alan@digikata.com Alan
+	Chen] and [mailto:ruwiki@halostatue.ca Austin Ziegler].
+	
+	Ruwiki is provided free of use and without any warranty express or
+	implied. You may use, distribute, or modify Ruwiki under the conditions
+	of Ruby’s licence or the [http://www.gnu.org/copyleft/gpl.html
+	GNU General Public Licence].
+	
+	* Ruwiki includes a modified version of rdoc/template.rb originally by Dave Thomas for use in \RDoc.
+	
+	== Translations
+	* Translation to German by [mailto:chneukirchen@yahoo.de Christian Neukirchen] on 2003.10.22, with corrections by Mauricio Fernáez. Note that the initial template translations (./templates/de/) were done via \AltaVista Babelfish and should not be blamed on Christian.
+	* Translation to Spanish by [mailto:batsman.geo@yahoo.com Mauricio Fernández] on 2003.10.22. Note that the initial template translations (./templates/es/) were done via \AltaVista Babelfish and should not be blamed on Mauricio.
+	
+	== Austin’s Other Projects
+	Austin has also released several other projects available on the RAA that you may be interested in:
+	* [http://raa.ruby-lang.org/list.rhtml?name=mime-types MIME::Types], \RubyForge [http://rubyforge.org/projects/mime-types project].
+	* [http://raa.ruby-lang.org/list.rhtml?name=pdf-writer PDF::Writer], \RubyForge [http://rubyforge.org/projects/ruby-pdf project].
+	* [http://raa.ruby-lang.org/list.rhtml?name=text-format Text::Format], \RubyForge [http://rubyforge.org/projects/text-format project].
+	* [http://raa.ruby-lang.org/list.rhtml?name=trans-simple Transaction::Simple], \RubyForge [http://rubyforge.org/projects/trans-simple project].
+	* [http://raa.ruby-lang.org/list.rhtml?name=uninheritable Uninheritable], Transaction::Simple’s \RubyForge [http://rubyforge.org/projects/trans-simple project].
+	* [http://raa.ruby-lang.org/list.rhtml?name=diff-lcs Diff::LCS], Ruwiki’s \RubyForge [http://rubyforge.org/projects/ruwiki project].
+properties!project:	Ruwiki
+properties!title:	LicenseAndAuthorInfo
+properties!topic:	LicenseAndAuthorInfo
+properties!version:	1
+ruwiki!content-version:	2
+ruwiki!version:	0.9.0
+properties!editable:	false

data/data/Ruwiki/ProjectIndex.ruwiki

@@ -0,0 +1,84 @@
+page!content:	= Ruwiki 0.9.0
+	This is the \ProjectIndex page for Ruwiki. For any given project, the
+	\ProjectIndex topic will be the default topic for plain project links.
+	
+	== Features and Information
+	* This wiki supports a variety of WikiFeatures that you may be interested in. The rules for WikiMarkup are similar to some other wikis, but there are a few unique markup capabilities in Ruwiki.
+	* Configuring_Ruwiki is simple.
+	* Extending_Ruwiki is almost as simple.
+	* What you need to know for using Ruwiki's [[Antispam]] capabilities.
+	* Who wrote Ruwiki? Read the LicenseAndAuthorInfo.
+	
+	== Requirements
+	Ruwiki currently requires Ruby 1.8, Diff::LCS 1.1.2 and
+	Archive::Tar::Minitar 0.5.1. These packages are included in the
+	<em>packages/</em> directory in the
+	<code>ruwiki-0.9.0-full.tar.gz</code> form of the distribution.
+	
+	The YAML backend requires Ruby 1.8.2 preview 3 or later.
+	
+	== Upgrading
+	Ruwiki 0.9.0 has a flatfile format that is incompatible with versions
+	of Ruwiki older than Ruwiki 0.8.0. If you are upgrading from one of
+	these versions, you must use the bin/ruwiki_convert. The simple case
+	will be (assuming that your data files are in ./data):
+	
+	  % ruwiki_convert ./data
+	
+	The ruwiki_convert utility is automatically installed by \RubyGems and
+	RPA. See RuwikiUtilities for more information. Note that this utility
+	will probably be incorporated into the main Ruwiki utility in a future
+	version.
+	
+	== Getting Started
+	There are some differences between the startup of <tt>.tar.gz</tt>,
+	\RubyGems, and RPA installations of Ruwiki.
+	
+	=== \QuickStart (Read-only: \RubyGem and RPA Installation Only)
+	Run:
+	  % ruwiki_servlet --central
+	
+	Point your web browser to \http://localhost:8808/.
+	
+	=== \QuickStart (CGI)
+	# Install the Ruwiki CGI (<tt>ruwiki.cgi</tt>) program in a place where your webserver can execute it.
+	#* <strong>\RubyGem:</strong> <tt>ruwiki install cgi,data --to <em>directory</em></tt>
+	#* <strong><tt>.tar.gz</tt>:</strong> Extract the Ruwiki directory to that directory. <tt>cp bin/ruwiki.cgi .</tt> <em>or</em> <tt>copy bin\ruwiki.cgi .</tt>
+	# Point your web browser to the appropriate URL.
+	
+	=== \QuickStart (\WEBrick)
+	# Install the Ruwiki servlet or data.
+	#* <strong>\RubyGem:</strong> <tt>ruwiki install data --to <em>directory</em></tt> <em>or</em> <tt>ruwiki install servlet,data --to <em>directory</em></tt>
+	#* <strong><tt>.tar.gz</tt>:</strong> Extract the Ruwiki directory.
+	# Run <tt>ruwiki_servlet</tt>. Under the <tt>.tar.gz</tt>, this would be <tt>bin/ruwiki_servlet</tt> <em>or</em> <tt>ruby bin\ruwiki_servlet</tt>
+	# Point your web browser to \http://localhost:8808/.
+	
+	== Support
+	* Troubles with Ruwiki? See TroubleShooting for some suggestions. Have a new problem? Add it to the main [http://ruwiki.rubyforge.org/ruwiki.cgi/Ruwiki/TroubleShooting TroubleShooting] page.
+	* Subscribe to [http://rubyforge.org/mailman/listinfo/ruwiki-discuss ruwiki-discuss] ([http://rubyforge.org/pipermail/ruwiki-discuss/ archives]).
+	* You can also use the [http://rubyforge.org/forum/?group_id=84 Ruwiki Public Forum] or the on \RubyForge.
+	
+	== Tracking Ruwiki Development
+	The development progress of Ruwiki is kept primarily in the wiki
+	itself, but the services of [http://rubyforge.org RubyForge] are used
+	as well.
+	* The BugTracking page in Ruwiki keeps track of open and closed bugs in Ruwiki. Bugs can also be found in the \RubyForge [http://rubyforge.org/tracker/?atid=407&group_id=84&func=browse bug tracker] and [http://rubyforge.org/tracker/?atid=408&group_id=84&func=browse Support Requests].
+	* The To_Do list keeps track of major development goals for Ruwiki. Items for this list can be found on \RubyForge in [http://rubyforge.org/tracker/?atid=410&group_id=84&func=browse Feature Requests] and [http://rubyforge.org/tracker/?atid=409&group_id=84&func=browse Patches].
+	* There is a mailing list to track CVS changes: [http://rubyforge.org/mailman/listinfo/ruwiki-checkin ruwiki-checkin] ([http://rubyforge.org/pipermail/ruwiki-checkin/ archives]).
+	
+	== Different Features?
+	If this wiki doesn&rsquo;t have the right combination of features, (or if it
+	just doesn&rsquo;t feel right) try these other Ruby-based Wikis:
+	
+	* [http://pimwiki.rubyforge.org/ PIMWiki]
+	* [http://instiki.rubyforge.org/ Instiki]
+	* [http://www.walrus-ruby.org/amrita/cgi-bin/aswiki/aswiki.cgi Amrita Wiki]
+	* [http://rwiki.jin.gr.jp/cgi-bin/rw-cgi.rb?cmd=view;name=top RWiki]
+	* [http://www.xpsd.com/MiniRubyWiki MiniRubyWiki]
+properties!project:	Ruwiki
+properties!title:	ProjectIndex
+properties!topic:	ProjectIndex
+properties!version:	1
+ruwiki!content-version:	2
+ruwiki!version:	0.9.0
+properties!editable:	false

data/data/Ruwiki/Roadmap.ruwiki

@@ -0,0 +1,225 @@
+page!content:	= Ruwiki 0.9.0: The Road Ahead
+	This roadmap is accurate as of the release of 0.9.0.
+	
+	What lies ahead for Ruwiki? The To_Do list will give a detailed list
+	of what is to follow, but this list is not the roadmap. There is no
+	clear indication of the reason for — and in some cases, the
+	meaning of — the items on the list. The intention of this
+	document is to expand on that list. As items are completed, they will
+	be removed from this document.
+	
+	== A Note About Targets
+	Ruwiki development is not proceeding as quickly as I would prefer, but
+	it is continuing steadily. I am at times choosing to delay releases
+	and bypass some versions because there are other pressing concerns; I
+	am definitely aiming for quality here, not for timeliness.
+	
+	== Development Inputs
+	The primary driver of development on Ruwiki is the needs of a few
+	groups of people. First, both Alan and Austin use or will use Ruwiki
+	at work. There are particular needs that both have. Austin will be
+	replacing an installation of \PhpWiki with an installation of Ruwiki
+	sometime in early 2005.
+	
+	Second, [http://www.rubygarden.org/ruby RubyGarden], and
+	[http://www.rubyforge.org RubyForge], and the
+	[http://rpa.rubygarden.org <acronym title="Ruby Production Archive">RPA</acronym>]
+	have expressed an intention to replace the Perl-based \UseMod wiki
+	with a Ruby-based wiki. The popular and easy-to-use Instiki
+	(&ldquo;there is no step 3&rdquo;) is not an ideal choice for either
+	because they either require or prefer a CGI-based wiki. Ruwiki has the
+	desired level of performance and implemenation simplicity that
+	impresses both groups, and it is the current preferred choice. Thus,
+	the needs of both websites factor highly into the goals for Ruwiki.
+	
+	Third, Austin gave a talk on Ruwiki at \RubyConf 2004. Many of the
+	features in the current release come from a development effort leading
+	up to the talk and in the weeks following.
+	
+	Last, and certainly not least, feature requests and bug reports are a
+	factor. One of the things that changed in Ruwiki 0.8.0 was the look
+	and feel; admittedly, the look and feel in earlier versions was a bit
+	garish, designed to fit in with a particular website more than be a
+	general wiki theme. Users complained, and we changed this. The
+	continual spam defacement of the \RubyGarden wiki suggested several
+	possible improvements that could be made in Ruwiki to fight wiki spam;
+	initial work has been implemented in Ruwiki 0.9.0 and more work
+	remains. Additionally, Ruwiki is the first wiki with built-in
+	deployment support for package management systems (such as \RubyGems
+	and rpa-base), although Instiki has been modified for RPA by the RPA
+	team to support limited installation in RPA locations.
+	
+	== Ruwiki 0.10.0: &ldquo;Are You Being Served?&rdquo;
+	Ruwiki 0.8.0 introduced an incompatible change in the way that page
+	diffs were stored, so users were advised to remove any existing .rdiff
+	files. This isn&rsquo;t as problematic as it may sound, as until
+	0.10.0, there is no way to actually view the page diffs from Ruwiki
+	itself.
+	
+	In Ruwiki 0.7.0, a new token was introduced: %calendar(). The concept
+	here is a sound one that can be extended to make token addition
+	easier. Currently, it is necessary for token writers to create their
+	own regular expressions. The &ldquo;function token&rdquo; will be
+	added &mdash; although the form may not be
+	&ldquo;%<em>function-name</em>&rdquo; &mdash; that will work with
+	either a line replacement or a word replacement so that the regular
+	expression does not need to be written. Tests for the replacement will
+	still need to be written, but standardizing new custom tokens will be
+	a good thing.
+	
+	Chad Fowler&rsquo;s port of \RubLog&rsquo;s vector search will
+	probably be added to this version.
+	
+	The presence of static HTML content (headers and footers) per page has
+	been accounted for in Ruwiki 0.8.0, but it will not be displayed.
+	Further, there is currently no way to specify or display static
+	content for the wiki or the project. (A related problem here is that
+	projects do not have any properties. This will become important as
+	projects should be able to be marked private within a wiki in the
+	future.)
+	
+	The purpose of the \WikiWikiWeb is to provide a collaborative,
+	community knowledge editing environment. Unfortunately, the pondscum
+	known as spammers have figured out that the \WikiWikiWeb provides a
+	positive Google \PageRank, and having their links on our Wikis is
+	benefits them. Just as they don&rsquo;t care about filling our
+	mailboxes with junk, they don&rsquo;t care about defacing our
+	community knowledge. Ruwiki 0.10.0 provides additional antispam
+	defences.
+	
+	The \RecentChanges mechanism will be updated to make it possible to
+	see the \GlobalRecentChanges list.
+	
+	The most significant change in Ruwiki 0.10.0 will be the modification
+	of the request pipeline. This will not be visible to the end user, but
+	it will be significant to users who wish to extend Ruwiki. Currently,
+	Ruwiki processes all commands in ruwiki.rb. In Ruwiki 0.10.0, this
+	will be changed to a dispatch mechanism, where Action objects are
+	introduced, and ruwiki.rb dispatches requests to Action objects.
+	
+	<table summary="Pipeline" style="border: 1px solid black"><tr><td>
+	  +---------+          +-------------------+
+	  | Request |--------->| Authorize Request |
+	  +---------+          +-------------------+
+	                            |
+	                            v
+	                       +-------------------+
+	                       | Configure Ruwiki  |
+	                       +-------------------+
+	                            |
+	                            v
+	                       +-------------------+
+	                       | Parse Request     |
+	                       +-------------------+
+	                            |
+	                            v
+	                       +-------------------+
+	                       | Perform Action    |
+	                       +-------------------+
+	                            |
+	                            v
+	                       +-------------------+
+	                       | Prepare Response  |
+	                       +-------------------+
+	                            |
+	                            v
+	  +--------+           +----+--------------+
+	  | Page   |<----------| Send Page         |  
+	  +--------+           +-------------------+
+	</td></tr></table>
+	
+	The diagram above shows the general pipeline. The difference is that
+	the action will be its own object. In general, it will need to know
+	how to process certain URL formats.
+	
+	In the process of defining the action objects, \ActionCards will be
+	created. Below is an example \ActionCard for the default action,
+	<tt>_show</tt>. In \ActionCards, everything is relative to the Ruwiki
+	root URI. Important to note is that \ActionCards are an ideal: they may
+	not represent something that can be accomplished for 0.10.0, 0.11.0,
+	or even 1.0. They do, however, represent the ultimate target.
+	
+	Ruwiki does some implicit URI rewriting in the general form of:
+	
+	<table summary="Ruwiki URI rewriting" style="border: 1px solid black; border-collapse: collapse">
+	<tr><th style="border: 1px solid black">URI</th><th style="border: 1px solid black">Rewritten URI</th></tr>
+	<tr><td style="border: 1px solid black">/</td><td style="border: 1px solid black">/Project<sub style="border: 1px solid black; font-size: 50%">Default</sub style="border: 1px solid black; font-size: 50%">/Topic<sub style="border: 1px solid black; font-size: 50%">Default</sub style="border: 1px solid black; font-size: 50%">/Action<sub style="border: 1px solid black; font-size: 50%">Default</sub style="border: 1px solid black; font-size: 50%"></td></tr>
+	<tr><td style="border: 1px solid black">/Action</td><td style="border: 1px solid black">/Project<sub style="border: 1px solid black; font-size: 50%">Default</sub style="border: 1px solid black; font-size: 50%">/Topic<sub style="border: 1px solid black; font-size: 50%">Default</sub style="border: 1px solid black; font-size: 50%">/Action</td></tr>
+	<tr><td style="border: 1px solid black">/Topic</td><td style="border: 1px solid black">/Project<sub style="border: 1px solid black; font-size: 50%">Default</sub style="border: 1px solid black; font-size: 50%">/Topic/Action<sub style="border: 1px solid black; font-size: 50%">Default</sub style="border: 1px solid black; font-size: 50%"></td></tr>
+	<tr><td style="border: 1px solid black">/Project/</td><td style="border: 1px solid black">/Project/Topic<sub style="border: 1px solid black; font-size: 50%">Default</sub style="border: 1px solid black; font-size: 50%">/Action<sub style="border: 1px solid black; font-size: 50%">Default</sub style="border: 1px solid black; font-size: 50%"></td></tr>
+	<tr><td style="border: 1px solid black">/Project/Action</td><td style="border: 1px solid black">/Project/Topic<sub style="border: 1px solid black; font-size: 50%">Default</sub style="border: 1px solid black; font-size: 50%">/Action</td></tr>
+	<tr><td style="border: 1px solid black">/Project/Topic</td><td style="border: 1px solid black">/Project/Topic/Action<sub style="border: 1px solid black; font-size: 50%">Default</sub style="border: 1px solid black; font-size: 50%"></td></tr>
+	<tr><td style="border: 1px solid black">/Project/Topic/Action</td><td style="border: 1px solid black">/Project/Topic/Action</td></tr>
+	</table>
+	
+	<table summary="_show Action Card" style="border: 1px solid black"><tr><td>
+	=== Action: Show [_show] <strong>DEFAULT</strong>
+	The Show action is the default action that will be performed when
+	there is no action specified. Without any arguments, the latest
+	version of the page will be displayed.
+	
+	==== Action Arguments
+	; ?r=<em>revision</em> : Show the specified revision of the page.
+	; ?r : Show the list of revisions known to the page.
+	; ?r=<em>revision1</em>:<em>revision2</em> : Shows the difference of revision1 and revision2 for the page.
+	; ?r=:<em>revision</em> : Shows the difference between the current page and the specified revision.
+	; ?d=<em>yyyymmdd[:hh[mm[ss]]]</em> : Shows the last revision from at or before the specified date and time. If time is not specified, it is assumed to be 23:59:59.
+	
+	==== Interaction Notes
+	Without arguments, _show generates pages pages that are editable and
+	indexable (<meta name="robots" content="index,follow,archive">). If
+	any argument is specified, the page is still editable, but not
+	indexable (<meta name="robots" content="noindex,nofollow,noarchive">).
+	</td></tr></table>
+	
+	== Ruwiki 0.11.0: &ldquo;What&rsquo;s My Line?&rdquo;
+	The antispam techniques introduced in 0.9.0 are positive steps in the
+	fight against wiki defacement. They are hopefully effective, too. The
+	problem is that because 0.9.0 doesn&rsquo;t offer users or user
+	authentication, there&rsquo;s no way of safely allowing the edit of
+	the antispam lists. Thus, to allow this and other potentially
+	dangerous actions, a user and capability framework will be added to
+	Ruwiki. This framework will allow for user identification,
+	authentication, and authorization to indicate what users are allowed
+	to perform what actions.
+	
+	Authenticated users will be able to bypass blacklist checking; thus,
+	if &ldquo;msn.com&rdquo; is blocked, &ldquo;joe.blog@msn.com&rdquo;
+	could still authenticate with Ruwiki and edit the pages. Some users
+	will be able to manage user permissions (including user management),
+	edit antispam lists, etc.
+	
+	Other actions will be added, including the ability to rename topics
+	and move topics between projects. In both cases, the topic change
+	history must be maintained.
+	
+	The documentation for Ruwiki will be substantially complete with this
+	version, lacking only specific information on the features that will
+	be added in Ruwiki 1.0.0.
+	
+	== Ruwiki 1.0.0: &ldquo;Yes, Minister&rdquo;
+	A combined strength and weakness of Ruwiki is that it currently does
+	little to protect against arbitrary HTML being inserted into the
+	current topic. The allowed subset of HTML should be restricted to a
+	safe subset to prevent cross-site-scripting attacks.
+	
+	Pages and projects have properties: we need to provide the ability to
+	edit those properties. Part of the properties that should be editable
+	include whether a page is frozen &mdash; this means that the page is
+	no longer editable by any user (unless it is unfrozen) and is
+	effectively a plain HTML page. Other properties include the static
+	header and footer information in a page or project.
+	
+	Modern Wikis require an RSS feed. Ruwiki will provide one.
+	
+	== The Future: &ldquo;Yes, Prime Minister&rdquo;
+	Ruwiki 1.0.0 does not represent the end of the line for Ruwiki, but
+	what the future holds is unclear. We&rsquo;ll see what the future
+	brings.
+properties!project:	Ruwiki
+properties!title:	Roadmap
+properties!topic:	Roadmap
+properties!version:	1
+ruwiki!content-version:	2
+ruwiki!version:	0.9.0
+properties!editable:	false