ruwiki 0.9.0

data/data/Ruwiki/RuwikiTemplatingLibrary.ruwiki

@@ -0,0 +1,156 @@
+page!content:	= Ruwiki 0.9.0 Templating
+	Ruwiki uses a heavily modified version of the \RDoc
+	“cheap-n-cheerful” HTML page template system. This a
+	line-oriented, text-based templating system.
+	
+	== Templates
+	Templates in the templating system are essentially plain strings with
+	particular references to templating keys or an include directive.
+	
+	The template interacts with value and message hashes provided by
+	Ruwiki. The keys known to the templates expected by Ruwiki are
+	detailed in Extending_Ruwiki. Nested key references are found from the
+	inside-out. That is, the closest resolving key to the current level is
+	found, not the furthest resolving key.
+	
+	=== Including Other Templates
+	Templates may include other templates to any arbitrary level by using
+	the <tt>!INCLUDE!</tt> directive. When the \TemplatePage is created,
+	an array of template strings are provided; these will be used to
+	satisfy <tt>!INCLUDE!</tt> directives. If there are not enough
+	template strings provided, <tt>!INCLUDE!</tt> won&rsquo;t be
+	translated.
+	
+	: This may change before Ruwiki reaches 1.0, so that templates are
+	: named instead of iterated.
+	
+	=== Simple Template Keys
+	Strings of the format <tt>%<em>key</em>%</tt> or
+	<tt>%?<em>key</em>%</tt> are simple template keys. <em>key</em> is
+	looked up in the provided value hash and is presented as the string
+	value of the result. <tt>%key%</tt> template keys are mandatory; if
+	the key is not found in the value hash, an exception will be raised.
+	<tt>%?key%</tt> template keys are optional; if they key is not found
+	in the value hash, an empty string (&ldquo;&rdquo;) will be used.
+	
+	=== Labels
+	Strings of the format <tt>#<em>key</em>#</tt> or
+	<tt>#?<em>key</em>#</tt> are labels. <em>key</em> is looked up in the
+	provided message hash as a Symbol (e.g.,
+	<tt><em>key</em>.intern</tt>). As with simple template keys,
+	<tt>#key#</tt> labels are mandatory and <tt>#?key#</tt> labels are
+	optional.
+	
+	=== Links
+	Strings of the format <tt>HREF:\ref:name</tt> will become HTML links.
+	Both <em>ref</em> and <em>name</em> are keys to be looked up.
+	<em>name</em> is mandatory; an exception will be raised if it is not
+	found.
+	
+	=== Control Structures
+	The templating library supports both looping and conditional control
+	structures in both single-line and multi-line forms. Single-line
+	control structures <strong>may not</strong> be nested; multi-line
+	control structures <strong>may</strong> be nested arbitrarily deeply.
+	
+	==== Looping Control Structures
+	There are two forms of looping control structures.
+	
+	  [:key|stuff:]
+	
+	  START:key
+	    ... stuff ...
+	  END:key
+	
+	===== Single-Line Looping
+	  [:key|stuff:]
+	
+	The value of <em>key</em> may be <tt>nil</tt>, an integer value, a
+	range, or an array. When <em>key</em> represents:
+	# <tt>nil</tt>, the looping structure will be replaced with an empty string.
+	# An integer, <em>stuff</em> will be repeated <em>key</em> times. Values from 1 to <em>key</em> will be provided to the text of <em>stuff</em> to be substituted as a simple template key of the form <tt>%key%</tt>.
+	# A range, <em>stuff</em> will be repeated once for each successive value in the range of <em>key</em>. Each value will be provided to the text of <em>stuff</em> to be substituted as a simple template key of the form <tt>%key%</tt>.
+	# An array, the behaviour will differ depending on the contents of the array.
+	## If the array contains hashes, the behaviour is the same as a multi-line looping construct. See below for details.
+	## Otherwise, the template iterates through the array, providing each value to the text of <em>stuff</em> to be substituted as a simple template key of the form <tt>%key%</tt>.
+	
+	As an example, if we have:
+	
+	  "[:b|%b% ]"
+	
+	# <tt>val["b"] = 3 -> "1&nbsp;2&nbsp;3&nbsp;"</tt>
+	# <tt>val["b"] = (0..2) -> "0&nbsp;2&nbsp;3&nbsp;"</tt>
+	# <tt>val["b"] = ["a", "B"] -> "a&nbsp;B&nbsp;"</tt>
+	
+	==== Multi-Line Looping
+	  START:key
+	    ... stuff ....
+	  END:key
+	
+	The value of <tt>key</tt> must be an array of hashes. <tt>... stuff
+	...</tt> will be repeated once for each entry in the array. The hashes
+	will be passed as nested value hashes.
+	
+	  %a% [:b|%a% ]%a%
+	
+	When the above template string is run with the following hash:
+	
+	  val["a"] = 1
+	  val["b"] = [ { "a" => 2 }, { "a" => 3 } ]
+	
+	The result is:
+	
+	  1 2 3 1
+	
+	The behaviour is the same for multi-line blocks.
+	
+	==== Conditional Block Keys
+	  IF:key
+	    ... stuff ...
+	  ENDIF:key
+	
+	The block between <tt>\IF:key</tt> and <tt>\ENDIF:key</tt> will be included in
+	the output only if the corresponding key is set in the value hash.
+	
+	== Example
+	Given the set of templates T1, T2, and T3 (shown below), here&rsquo;s how we would
+	use the templating system.
+	
+	  values = { "name" => "Dave", "state" => "TX" }
+	  t = TemplatePage.new(T1, T2, T3)
+	  File.open(name, w) { |f| t.process(f, values) }
+	
+	or:
+	
+	  <!-- Source -->
+	  val1 = { "name" => "Dave", "state" => "TX" }
+	  val2 = { "name" => "Dave" }
+	  msgs = { }
+	  res = ""
+	  t.process(res, values, msgs)
+	 
+	  <!-- T1 -->
+	  Templates can subsitute a wide variety of values.
+	  !INCLUDE!
+	 
+	  <!-- T2 -->
+	  Name: %name% !INCLUDE!
+	 
+	  <!-- T3 -->
+	  IF:state
+	  State: %state%
+	  ENDIF:state
+	
+	The result will be:
+	
+	  Name: Dave
+	  State: TX
+	 
+	  Name: Dave
+properties!project:	Ruwiki
+properties!title:	RuwikiTemplatingLibrary
+properties!topic:	RuwikiTemplatingLibrary
+properties!version:	1
+ruwiki!content-version:	2
+ruwiki!version:	0.9.0
+properties!editable:	false

data/data/Ruwiki/RuwikiUtilities.ruwiki

@@ -0,0 +1,157 @@
+page!content:	= Ruwiki 0.9.0 Utilities
+	Ruwiki 0.9.0 provides two utilities and three sample programs for
+	deployment.
+	
+	== Managing Ruwiki Deployments
+	A major change to the way that Ruwiki 0.9.0 works as compared to
+	versions of Ruwiki 0.8.0 or earlier is that Ruwiki 0.9.0 supports being
+	installed in a central location by one of the two major packaging
+	systems available for Ruby (\RubyGems and RPA). Managing these
+	deployments is accomplished with the utility appropriately enough named
+	<tt>ruwiki</tt>, stored in the directory of the distribution.
+	
+	This utility has little value for users of the standalone release
+	(either of the versions packaged in tarfiles or zipfiles), but is
+	developed because packaging systems present a particular challenge to
+	Ruwiki, as simply running &ldquo;ruwiki_servlet&rdquo; with no
+	arguments will look for the data files and the template files relative
+	to the current directory. With \RubyGems, though, this would require
+	that the user specify something like:
+	
+	  ruwiki_servlet \
+	    --template-path /usr/local/lib/ruby/gems/1.8/ruwiki-0.9.0/templates \
+	    --flatfiles-data-path /usr/local/lib/ruby/gems/1.8/ruwiki-0.9.0/data
+	
+	This is not the preferred option because Wiki installations may be
+	private and the /usr/local directory is a system-wide shared
+	directory. Additionally, since Ruwiki works as a CGI, the system
+	shared data and template paths will not be generally accessible (and
+	should not be world-writeable!) to CGI executables.
+	
+	This utility also encapsulates Win32 service management through
+	Win32::Service for the \WEBrick servlet runner.
+	
+	=== <tt>ruwiki <command> [<em>parameters</em>]</tt>
+	The <tt>ruwiki</tt> utility will recognise four different commands on
+	all platforms and a fourth command on Windows. These commands are:
+	
+	; help : Displays general help or command-specific help.
+	; install : Installs the default deployment package.
+	; package : Packages a Ruwiki installation.
+	; unpackage : Unpackages a Ruwiki installation.
+	; service : Manages a Win32::Service for Ruwiki.
+	
+	==== <tt>ruwiki help commands</tt>
+	The list of known commands can be displayed by providing this command.
+	
+	   % ruwiki help commands
+	==== <tt>ruwiki help <command></tt>
+	The help for the named command (one of install, package, unpackage, or
+	service) will be displayed upon providing this command to the ruwiki
+	utility.
+	
+	   % ruwiki help install
+	==== <tt>ruwiki install [<em>OPTIONS</em>] [<em>--to DEST</em>]
+	Creates a new Ruwiki instance in the current directory or the directory
+	specified by the <tt>--to</tt> option. By default, the data, template,
+	and a default configuration file are installed to the destination
+	directory. OPTIONS may be one of the following:
+	
+	; servlet : Installs the Ruwiki WEBrick servlet stub.
+	; service : Installs the Ruwiki Win32::Service stub.
+	; cgi : Installs the Ruwiki CGI script model.
+	; data : Default; installs the Ruwiki default data, templates, and configuraiton file.
+	
+	Installation option names can be disabled with a dash (&lsquo;-&rsquo;)
+	or the word &lsquo;no&rsquo;, making &lsquo;-data&rsquo; and
+	&lsquo;nodata&rsquo; functionally equivalent.
+	
+	  % ruwiki install cgi data
+	==== <tt>ruwiki package [<em>SOURCE</em>] [<em>--output PACKAGE</em>|<em>-o PACKAGE</em>] [<em>--replace</em>]</tt>
+	Packages the Ruwiki files (data, templates, and executables) from the
+	specified source or the current directory into the specified output
+	package (or &ldquo;./ruwiki.pkg&rdquo;). If the SOURCE is a ruwiki
+	configuration file (e.g., &ldquo;ruwiki.conf&rdquo;), then that will be
+	used to determine the location and name of the data and template
+	directories.
+	
+	Specify <tt>--replace</tt> to replace the existing output package. If
+	an output package is specified that already exists, then <tt>ruwiki
+	package</tt> will refuse to output to the file unless
+	<tt>--replace</tt> is specified. If an output package is not specified
+	and <tt>--replace</tt> is not specified, then an incremental package
+	will be generated (e.g., &ldquo;./ruwiki-1.pkg&rdquo;).
+	
+	: NOTE: The packaging process will normalize the data and templates
+	: directory names to be relative to the unpacking directory. They will
+	: NEVER be absolute paths.
+	
+	  % ruwiki package
+	==== <tt>ruwiki unpackage [<em>SOURCE</em>] [<em>--output DIRECTORY</em>|<em>-o DIRECTORY</em>]</tt>
+	Unpackages the provided Ruwiki package (default "./%1$s") into the
+	specified directory (default ".").
+	
+	  % ruwiki unpackage
+	==== <tt>ruwiki service <command> <NAME> [<em>command-options</em>]</tt>
+	Manages a Ruwiki WEBrick servlet as a Win32 service (with the
+	assistance of
+	[http://raa.ruby-lang.org/list.rhtml?name=win32-service win32-service]).
+	This works in ways similar to a daemon on Unix. The sub-commands
+	available to <tt>ruwiki service</tt> are:
+	===== <tt>ruwiki service install NAME [DESCRIPTION] [options]</tt>
+	Installs the Ruwiki WEBrick servlet as the named Win32 service.
+	<tt>install</tt> accepts an optional description (all non-options will
+	be included in the description). The options for <tt>install</tt> are:
+	; --rubybin RUBYPATH : The path to the Ruby binary.
+	; --exec SERVICEPATH : The path to the service executable.
+	; --home PATHTOHOME : The path to the home directory.
+	===== <tt>ruwiki service start NAME</tt>
+	Starts the named Ruwiki service.
+	===== <tt>ruwiki service stop NAME</tt>
+	Stops the named Ruwiki service.
+	===== <tt>ruwiki service delete NAME</tt>
+	Deletes the named Ruwiki service.
+	
+	: NOTE: This command can probably be used to manage other Win32
+	: services that respond to the appropriate commands.
+	
+	== Upgrading and Converting: ruwiki_convert
+	: This section was formerly a separate entry in the Wiki entitled
+	: &ldquo;Upgrading and Converting&rdquo;.
+	
+	The flatfile backend format in Ruwiki 0.9.0 is not compatible with that
+	of versions of Ruwiki earlier than 0.8.0. There are a number of
+	reasons for this, but because of this and that there are now three
+	different backend formats, Ruwiki now has a converter utility between
+	backends.
+	
+	There are two other incompatibilities of note:
+	# Ruwiki now defaults to &ldquo;ruwiki&rdquo; as an extension (e.g., \ProjectIndex.ruwiki) to the storage files. This is, of course, is something that can be modified with a configuration option, but you may find it desirable to rename your files to match this naming convention.
+	# The rdiff format is incompatible. It is recommended that you remove all .rdiff files from your data directory before using Ruwiki.
+	
+	=== ruwiki_convert [options] <directory>+
+	The converter utility will work on all files in a directory and its
+	subdirectories.
+	
+	When a file is encountered, it will be examined to be a known form of a
+	Ruwiki backend (marshal, yaml, flatfiles, or "old" flatfiles). If the
+	file is not one of these forms, then the file is skipped. Otherwise, it
+	is converted to the specified format. By default, the converted files
+	will be backed up.
+	
+	==== ruwiki_convert Options
+	; --format=FORMAT : Converts encountered files (regardless of the current format), to the specified format. Default is yaml. Allowed formats are: yaml marshal flatfiles
+	; --[no-]backup : Create backups of upgraded files. Default is --backup.
+	; --backup-extension=EXTENSION : Specify the backup extension. Default is "~", which is appended to the data filename.
+	; --extension=EXTENSION : Specifies the extension of Ruwiki data files. The default is .ruwiki
+	; --no-extension : Indicates that the Ruwiki data files have no extension.
+	; --quiet : Runs quietly. Default is to run with normal messages.
+	; --verbose : Runs with full messages. Default is to run with normal messages.
+	; --help : Shows this text.
+properties!project:	Ruwiki
+properties!title:	RuwikiUtilities
+properties!topic:	RuwikiUtilities
+properties!version:	1
+ruwiki!content-version:	2
+ruwiki!version:	0.9.0
+properties!editable:	false

data/data/Ruwiki/SandBox.ruwiki

@@ -0,0 +1,9 @@
+page!content:	This page is intended for users to play with freely to practice
+	their \WikiFormatting.
+properties!project:	Ruwiki
+properties!title:	SandBox
+properties!topic:	SandBox
+properties!version:	1
+ruwiki!content-version:	2
+ruwiki!version:	0.9.0
+properties!editable:	false

data/data/Ruwiki/To_Do.ruwiki

@@ -0,0 +1,51 @@
+page!content:	= Ruwiki 0.9.0 To Do Tracking
+	Completed to-do items can be found in the ChangeLog. Bugs in Ruwiki
+	are tracked in BugTracking.
+	
+	== Well-Defined To Do Items
+	=== Ruwiki 0.10.0
+	; Versioning : complete the change history interface. Change history is currently stored in a file <em>topic[.extension]</em>.rdiff. There is no way to display the change history at this point.
+	; Action objects : Actions will be generalised to pull the processing out of the main ruwiki.rb inasmuch as is possible.
+	; Function tokens : generalize the %&lt;function-name&gt;[(&lt;args&gt;)] calling method so that function tokens can be created without having to create a custom regular expression.
+	; Search work : There is further search work required. The current mechanism is effective, but inefficient, as it must load and convert each file in a project to a page and then search selectively within that page. The search mechanism must be improved.
+	; Frozen content : make it so that frozen content can be provided on a per-page or Wiki basis. Will provide both headers and footers. <strong>Note:</strong> Ruwiki 0.9.0 will only provide the ability to present the information, not create or modify it.
+	; Blacklisting : Allow the specification of an allow/deny list for \IPs or hostnames, aimed at blocking known spammers. Entries in this list can be permanent or temporary (e.g., &ldquo;* DENY&rdquo;, &ldquo;spammer.com DENY UNTIL 20040723&rdquo;, &ldquo;139.244.33.25 ALLOW&rdquo;).
+	; External URL redirection : Add whitelisting of known good external URIs.
+	; \GlobalRecentChanges : Recent changes for all projects.
+	; 
+	=== Ruwiki 0.11.0
+	; Authentication : complete authentication to provide for a standard Ruwiki authentication mechanism, not just an external API. This may require changes to the existing external API. Allows for user creation and authentication. Authenticate users bypass blacklist checking; thus, if &ldquo;msn.com&rdquo; is blocked, joe.blog@msn.com could still authenticate with Ruwiki and edit the pages.
+	; Topic renaming : add the ability to rename a topic within a project. Topic change history should be maintained.
+	; Topic moving : add the ability to move and/or rename a topic between projects. Topic change history should be maintained.
+	; Complete documentation : Complete the documentation of Ruwiki.
+	; Antispam : Allow the on-line editing of antispam lists to authenticated and authorised users.
+	=== Ruwiki 1.0.0
+	; RSS Feed : Ruwiki must be able to offer \RecentChanges and \GlobalRecentChanges as RSS feeds. This may not be ideal with the current \RecentChanges format. It may be easier to move to a two-stage \RecentChanges format.
+	; Static content : Allow the creation and editing of static content.
+	; Frozen pages : provide the ability to freeze content in place; the page is no longer &ldquo;wiki&rdquo; editable and is effectively a plain HTML page.
+	; Page properties : provide the ability to generally edit the properties of a given page.
+	
+	== General Future To Do Items
+	; E-mail gateway : accept topic appends via e-mail.
+	; alternative backends : access other wiki data storage, or other formats, e.g. e-mail boxes in mh or mbox formats
+	; bug tracker backend : with alternate markup
+	; add setup and user config methods : for backend plugin classes, then we can use them with an interactive or gui tool frontend to setup data storage backends. The user might have to run as root or other user with database create permissions.
+	; add id="" to various markup elements (make id specific to topic) : Later we can allow users to tweak a page using uploaded css fragments which might get appended onto the standard css contents. 
+	; ruby action : upload a ruby code fragment to add a smart &ldquo;action&rdquo; to that wiki page. Need some sort of security + approval system to handle this safely.
+	; Preview button : add a preview button to the save page.
+	; Alternative templating systems : not as high priority now that there&rsquo;s a real templating system in place.
+	; Alternative markup systems : potentially allow \RedCloth (Textile) and/or \BlueCloth (Markdown) to be processed for a page. This could be implemented as a %function.
+	; Project/topic security : allow certain projects to be restricted/authenticated for read/write based on user.
+	; Track last <em>n</em> links/topics : ?
+	; Write a markup debugger : ?
+	; Validate topic formatting from cgi : ?
+	; Validate project from cgi : ?
+	; Project-based backend : Allow different projects to have different backends.
+	; Arbitrary-depth project namespace support : Foo::Bar::\BazPage.
+properties!project:	Ruwiki
+properties!title:	To_Do
+properties!topic:	To_Do
+properties!version:	1
+ruwiki!content-version:	2
+ruwiki!version:	0.9.0
+properties!editable:	false

data/data/Ruwiki/TroubleShooting.ruwiki

@@ -0,0 +1,33 @@
+page!content:	= Ruwiki 0.9.0
+	= Ruwiki 0.9.0 Troubleshooting Tips
+	Following are some tips contributed by users of Ruwiki. Remember:
+	Ruwiki currently requires Ruby version 1.8; the YAML backend requires
+	Ruby version 1.8.2 or the latest CVS of Ruby 1.9.
+	
+	== No such file or directory
+	(Unix systems only.) If you get something like:
+	
+	  % ./ruwiki_servlet
+	  : no such file or directory
+	
+	run the following in the Ruwiki directory:
+	
+	  % find . | xargs dos2unix
+	
+	The developers of Ruwiki do what they can to ensure that Ruwiki is
+	distributed in a way that works well for both Unix and Windows
+	systems, but this will occasionally cause problems.
+	
+	== undefined method
+	  % ./ruwiki_servlet 
+	  ./ruwiki_servlet:64: undefined method `[]=' for nil (NameError)
+	
+	This may appear if you are running Ruby 1.6. Ruwiki requires Ruby 1.8
+	or higher; certain features require Ruby 1.8.2 preview 3 or better.
+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/WikiFeatures.ruwiki

@@ -0,0 +1,17 @@
+page!content:	Ruwiki is a [http://www.ruby-lang.org Ruby]-based wiki. It is
+	ideal for personal or small team use.
+	
+	Ruwiki:
+	* Uses the [http://www.ruby-lang.org Ruby] language.
+	* Runs quickly and easily as a CGI or \WEBrick servlet.
+	* Uses a simple templating system and CSS for presentation.
+	* Has flatfile storage with simple versioning.
+	* Offers project namespaces. Different projects can have the same topic names and not collide. Thus, \Default::ReadMe and \Project::ReadMe are two different pages.
+	* Offers a calendar for date-based collaborative editing.
+properties!project:	Ruwiki
+properties!title:	WikiFeatures
+properties!topic:	WikiFeatures
+properties!version:	1
+ruwiki!content-version:	2
+ruwiki!version:	0.9.0
+properties!editable:	false

data/data/Ruwiki/WikiMarkup.ruwiki

@@ -0,0 +1,261 @@
+page!content:	= Ruwiki Markup
+	A [http://c2.com/cgi/wiki Wiki] obeys certain formatting rules to make
+	it easy to format text without needing to know HTML. This Wiki obeys
+	the following rules by default. Because Ruwiki is extensible, there may
+	be additional formatting rules. These rules are those rules that apply
+	as of Ruwiki 0.9.0.
+	
+	== \WikiWords, \WikiProjects, Calendars, and External Resources
+	While reading stuff on this Wiki, you will see some words mashed
+	together with capitalisation (like \WikiWords). While this may seem odd
+	at first, this feature allows internal links to be created across the
+	Wiki.
+	
+	There are several allowable forms for \WikiWords.
+	# Two or more words concatenated directly. Each word must begin with a capital letter and be followed by zero or more lowercase letters. Thus, \FooBar, \CPlusPlus, and \AbC are all valid \WikiWords, but ABC is not.
+	# Two or more words concatenated with underscores. The first word must begin with a capital letter. This makes \Foo_Bar, \C_Plus_Plus, and \A_b_C valid \WikiWords. These \WikiWords will be displayed with spaces instead of underscores. \C_Plus_Plus will be displayed as “C Plus Plus”.
+	# One or more words contained in double square brackets. This the form supported by [http://wikipedia.com/ Wikipedia], and looks like \[[A Wiki Phrase]]. These links will be displayed exactly as entered between the brackets.
+	# One or more words contained in double square brackets with display text separated by a vertical bar. These \WikiWords look like \[[A Wiki Phrase|but show this text]]. The link will be to the page “A Wiki Phrase” and “but show this text” will be the hyperlink.
+	
+	If a \WikiWord is found that does not have a page defining the
+	\WikiWord, then the word will be shown with a hyperlink question mark
+	following it, allowing the \WikiWord to be created.
+	
+	=== \WikiProjects
+	This Wiki supports “projects.” Within each project, a given
+	\WikiWord is unique. Thus, if you have a Default project and a Ruwiki
+	project, you can have two pages called \ReadMe. Any given \WikiWord
+	refers only to topics within its project. That is, if I have \WikiWord
+	in the \ReadMe topic of the Default project, it will refer to the
+	\WikiWord topic of the Default project. (Another term for this
+	capability is “namespaces.”)
+	
+	A cross-project link is composed of the project’s name, two colons
+	(::), and the \WikiWord desired. Thus, from \Default::ReadMe, I can
+	have \Ruwiki::ReadMe as a link. The project index can be referred to
+	with \::Project. This is the same as doing \Project::ProjectIndex.
+	Thus, \::Ruwiki becomes ::Ruwiki, which is the same as
+	\Ruwiki::ProjectIndex (Ruwiki::ProjectIndex).
+	
+	=== Project Lists and Topic Lists
+	The list of known projects may be listed with the %projects() token;
+	the list of known topics for the current project may be listed with the
+	%topics() link. An arbitrary project may be provided to the %topics()
+	token, as in %topics(Default).
+	
+	%topics(Default)
+	
+	%projects()
+	
+	=== Calendars
+	Ruwiki supports a miniature calendar. Future versions of Ruwiki will
+	allow for calendar aggregation. Using the %calendar function, a
+	calendar section will be generated:
+	
+	  %calendar(<year>, <month>[, <project>])
+	  %calendar(today[, <project>])
+	
+	%calendar accepts either the English word &ldquo;today&rdquo; (displaying the
+	calendar for the current month and year) or a specific month and year
+	for display. A calendar for the specified month will be generated
+	where each date in the month is treated as a \WikiWord (as are the
+	links to the current month, the previous month, and the next month)
+	ready for display or editing. As with all other \WikiWord links in
+	Ruwiki, a project may be specified in %calendar, making
+	&ldquo;%calendar(today, Ruwiki)&rdquo; different from &ldquo;%calendar(today, Default)&rdquo;.
+	
+	%calendar(today)
+	%calendar(1999, 08, Default)
+	
+	=== External Resources
+	Ruwiki behaves intelligently about resources external to the Wiki
+	itself.
+	
+	==== External Links
+	\URLs to external resources are automatically detected for web
+	addresses, FTP addresses, newsgroups, and email links. They are
+	automatically converted to clickable \URLs. Be aware that some things
+	that look like URL schemas may be make clickable but are not really
+	\URLs.
+	
+	* \http://www.ruby-lang.org becomes http://www.ruby-lang.org
+	
+	\URLs may be named with the [url name] syntax. If the name is omitted,
+	the URL will be numbered. Numbering is contained to within the page.
+	
+	* \[http://www.rubygarden.org RubyGarden] becomes [http://www.rubygarden.org RubyGarden].
+	* \[http://www.halostatue.ca] and \[http://www.halostatue.ca/ruby] become [http://www.halostatue.ca] and [http://www.halostatue.ca/ruby].
+	
+	==== Images
+	: <strong>Changed in Ruwiki 0.8.0!</strong>
+	
+	In preparation for the anti-wiki-spam features of Ruwiki 0.9.0, it has
+	been necessary to remove the ability for \URLs to be converted into
+	inline images automatically. Inline images are now created with the
+	image markup format, generally of the format \[image:URI options]. The
+	<em>options</em> format is generally the same format as an HTML
+	attribute (<em>name="value"</em>; the quotes are optional for
+	single-word option values) and any valid HTML attribute is also a
+	valid <em>option</em>. There is one special <em>option</em>,
+	<tt>numbered</tt>. This value, if set to any other value than &ldquo;false&rdquo;,
+	will set the <tt>title</tt> of the image to a numbered link.
+	
+	If the <tt>title</tt> attribute is not specified, it will be set from
+	the <tt>alt</tt> attribute (if specified) or the image&rsquo;s URL. If the
+	<tt>alt</tt> attribute is not specified, it will be set from the
+	<tt>title</tt> attribute.
+	
+	* \[image:http://www.halostatue.ca/graphics/maple_leaf.gif] [image:http://www.halostatue.ca/graphics/maple_leaf.gif]
+	* \[image:http://www.halostatue.ca/graphics/maple_leaf.gif title="Maple Leaf"] [image:http://www.halostatue.ca/graphics/maple_leaf.gif title="Maple Leaf"]
+	* \[image:http://www.halostatue.ca/graphics/maple_leaf.gif numbered=true] [image:http://www.halostatue.ca/graphics/maple_leaf.gif numbered=true]
+	* \[image:http://www.halostatue.ca/graphics/maple_leaf.gif style="border: 1px solid black;"] [image:http://www.halostatue.ca/graphics/maple_leaf.gif style="border: 1px solid black;"]
+	
+	==== Ruby Mailing Lists
+	If a Ruby mailing list message tag is provided, it will be converted appropriately.
+	
+	* \[ruby-talk:12345] will become [ruby-talk:12345]
+	* \[ruby-core:12345] will become [ruby-core:12345]
+	* \[ruby-doc:12345] will become [ruby-doc:12345]
+	
+	== Headings and Lists
+	=== Headings
+	Use equals signs (=) for headings. Up to six equals signs can be used
+	for HTML headings 1 - 6.
+	
+	\===== Heading five<br />
+	\====== Heading six
+	===== Heading five
+	====== Heading six
+	
+	=== Lists
+	==== Bulleted Lists
+	Use asterisks (*) to create bulleted lists. More asterisks means more
+	levels.
+	
+	\* level 1<br />
+	\** level 2<br />
+	\*** level 3
+	
+	* level 1
+	** level 2
+	*** level 3
+	
+	==== Numbered Lists
+	Use hash marks (#) for numbered lists. More hash marks means deeper
+	levels.
+	
+	\# level 1<br />
+	\## level 2<br />
+	\### level 3<br />
+	\### level 3.2<br />
+	\## level 2.2<br />
+	\# level 1.2
+	
+	# level 1
+	## level 2
+	### level 3
+	### level 3.2
+	## level 2.2
+	# level 1.2
+	
+	==== Definition Lists
+	Definitions can be created similar to other lists. Unlike &ldquo;standard&rdquo;
+	lists, though, definition lists have both the term and the definition.
+	They are specified like so. As with other lists, repeating the first
+	item (;) will increase the indentation level. The browser may not
+	respect this.
+	
+	\; term : definition<br />
+	\;; term2 : definition<br />
+	\;;; term3 : definition
+	
+	; term : definition
+	;; term2 : definition
+	;;; term3 : definition
+	== Paragraph Formatting
+	=== Rules
+	Four or more dashes ("----") on a line by itself makes a horizontal
+	rule, like so:
+	
+	\----
+	----
+	=== Paragraphs
+	A blank line (it may have whitespace on it) marks a new paragraph. All
+	other lines are joined together (excepting headers, lists, and rules).
+	
+	This line is a new paragraph.
+	
+	=== Block Indent Paragraphs
+	Paragraphs can be indented by beginning the paragraph with one or more
+	colons (:).
+	
+	\: Indent Level 1<br />
+	\:: Indent Level 2<br />
+	\::: Indent Level 3
+	
+	: Indent Level 1
+	:: Indent Level 2
+	::: Indent Level 3
+	
+	Paragraphs may be indented as &ldquo;cites&rdquo; by using one or more
+	greater-than signs (>) at the beginning of the line.
+	
+	\> Indent Level 1<br />
+	\>> Indent Level 2<br />
+	\>>> Indent Level 3
+	
+	> Indent Level 1
+	>> Indent Level 2
+	>>> Indent Level 3
+	
+	=== Code
+	Text that is indented will be presented as formatted in a monospaced
+	font. The only change is to escape HTML entities &lt; (&amp;lt;), &gt;
+	(&amp;gt;), and &amp; (&amp;amp;).
+	
+	  def replace
+	    content = @match[1]
+	    %Q{<pre>#{content}</pre>}
+	  end
+	
+	== Miscellaneous Formatting
+	=== HTML
+	The Ruwiki engine currently passes through HTML without changes. Thus,
+	&lt;strong&gt;strong&lt;/strong&gt; would be shown as
+	<strong>strong</strong>. <strong><em>Note:</em></strong> This
+	capability could be very dangerous as it could expose the Wiki to
+	cross-site scripting (XSS) vulnerabilities. This will be remedied
+	prior to the 1.0 release of Ruwiki.
+	
+	=== Abbreviations
+	Certain abbreviations may be known to the Wiki. While there is not yet
+	any way for a user to query what abbreviations are known, if the
+	abbreviations are told to the users, they may be used. Abbreviations
+	are presented with @{key}, where <em>key</em> is the abbreviation
+	desired. This Wiki, for example, knows that \@{matz} means &ldquo;@{matz}&rdquo;.
+	The special form \@{} will produce the current list of known
+	abbreviations. Unknown abbreviations will simply be put back into the
+	data stream unchanged. Thus, \@{unknownkey} results in @{unknownkey}.
+	
+	==== Known Abbreviations
+	@{}
+	
+	=== Preventing Formatting
+	If you wish to prevent a word or sequence from being interpreted, put
+	a backslash (\) in front of it. This works on all formatting options
+	except paragraph positioning. Thus, if I want to prevent a \WikiWord
+	from being turned into a hyperlink, I need to backslash it:
+	\\WikiWord.
+	
+	=== Other Possible Considerations
+	I&rsquo;m looking at adding styles similar to what is shown on the Wiki
+	below.
+	
+	* http://www.pmichaud.com/wiki/PmWiki/WikiStyles
+properties!project:	Ruwiki
+properties!title:	WikiMarkup
+properties!topic:	WikiMarkup
+properties!version:	1
+ruwiki!content-version:	2
+ruwiki!version:	0.9.0
+properties!editable:	false