• SecurePages: some pages can only be edited by authenticated users, even on a PublicWiki
• Fastcgi support under Apache and Lighttpd
• ViewDiffs to see what changed between two versions of a page
• ConvertForFckEeditor to convert existing Wiki2Go markup to HTML markup suitable to use with the FckEditor

Public wikis

• http://wiki.xp.be Wiki of the Belgian XP users group
• http://www.xpnl.org Wiki of the Dutch XP users group
• http://wiki.systemsthinking.net Wiki of the Dutch-Belgian Systems Thinking group
• http://www.agileopen.com Agile Open conference site organized by Agile Systems
• http://dutchopen.agilesystems.org wiki for the Dutch Open conference of SoL-Neth - the Dutch fractal of the Society for Organizational Learning

• http://www.agilesystems.org site of Agile Systems vzw
• http://www.xpday.net Benelux XP Day Conference
• http://www.johanteirlinck.be Site of Belgian author Johan Teirlinck
• http://www.nayima.be Site of Nayima bvba
• http://blog.nayima.be Blog of Pascal Van Cauwenberghe
• http://www.xp.be Site of the Belgian XP users group
• http://www.secappdev.org Site dedicated to secure application development
• http://www.agileseminars.nl/ Site about "Agile seminars", talks about agile topics

• http://www.satirworkshops.com/ by the Satir Workshops collective

Enhanced webserver support

• Installation generates a configuration file for the lighttpd webserver
• Works with Apache ProxyPass

• Full logging of CVS interaction
• Files with embedded spaces allowed

• Directory browsing to edit file

• File uploaded with Internet Explorer includes full path

Wiki2Go is a wiki written in Ruby, which has the following aims/features:

• Easy to install and configure
• Protection against WikiSpam
• Offline mode to use a public wiki, even when not connected

Administration

DownloadWiki2Go The current version is Wiki2GoRelease17

InstallWiki2Go

ConfigureWiki2Go

Development

ImplementedFeatures

ActiveFeatures

RequestedFeatures

KnownBugs

Who's Who?

WhoDevelopsWiki2Go

WhoUsesWiki2Go]]> pascal 22 October 2005 13:13 GMT http://wiki2go.nayima.be/Wiki2Go/RunWiki2Go.html Wiki2Go/RunWiki2Go Run your wiki

Embedded webserver

Use the following command to use the embedded webserver

Wiki2GoServer.rb 
    -d, --dir < directory>           (default is current directory)
    -p, --port < nb>                 (default is port 8081)
    -w, --wiki < wikiname>           (default is 'Wiki2Go')
    -s, --single                     Single or multi-wiki (default)
    -r, --rublets                    Allow dynamic pages
    -m, --module name                CVS module
    -c, --cvsroot root               CVS root
    -b, --blogstyle                  RSS contains creation date
    -h, --help                       Show this message

Apache

Include < installation dir>/config/site.conf in your apache configuration

Restart apache

lighttpd

lighttpd -f < installation dir>/config/lighttpd.conf]]> pascal 22 October 2005 13:12 GMT http://wiki2go.nayima.be/Wiki2Go/ActiveFeatures.html Wiki2Go/ActiveFeatures Active Features

Features under development in Wiki2GoRelease18

FckEditor]]> pascal 22 October 2005 13:11 GMT http://wiki2go.nayima.be/Wiki2Go/DownloadWiki2Go.html Wiki2Go/DownloadWiki2Go Download Wiki2Go

Prerequisites

• Ruby 1.8 and Ruby gems installed
  • Windows users see: http://rubyinstaller.rubyforge.org/wiki/wiki.pl
  • Debian users see DebianRuby

• Automatic GEM installation
  • (as superuser) 'gem install Wiki2Go'
• Manual download and installation
  • Go to the file download section on Rubyforge http://rubyforge.org/frs/?group_id=726
  • Select and download the version you want
  • (as superuser) 'gem install <the gem file you downloaded>'

• Wiki2GoRelease17
• Wiki2GoRelease16
• Wiki2GoRelease15
• Wiki2GoRelease14
• Wiki2GoRelease13
• Wiki2GoRelease12
• Wiki2GoRelease11

If you've created a new wiki with the following command

sudo Wiki2Go_make_site.rb -s http://wiki2go.nayima.be -u www-data 
  -g siteadmins -w Wiki2Go -t readwrite -d /var/sites/wiki2go 

This is where you can configure most of the working of Wiki2Go. The comments explain what the different options do

#!/usr/bin/env ruby

# Select which version of Wiki2Go is used.
require 'rubygems'
require_gem "Wiki2Go","~>1.17.0"
require "Wiki2Go/ReadWriteWikiConfig"

class CgiOptions < Wiki2Go::ReadWriteWikiConfig

  def initialize
    super('/var/sites/wiki2go')

    # Set this to false when the site works ok.
    @debug = true
    # Choose whether to have a single wiki or several subwikis
    @multi_wiki = true

    # Email of administrator of the site. Will be obfuscated on the page.
    @site_admin = 'wiki2go@nayima.be'

    # System user of the web server
    @user = 'www-data'
    # System group who has access to the files
    @group = 'siteadmins'

    # Set your Amazon affiliate ID for ISBN links
    @amazon_affiliate = 'agilesystems-21'

    # Set to true if you want to allow the execution of Ruby code inside pages
    # SECURITY WARNING: this code can do absolutely anything, only allow for trusted users
    @allow_dynamic_pages = false

    # The base path of the wiki if it is a subsite of a larger site
    @subsite = ''

    # Uncomment if you want to add 'dot' graphics to your page (see http://www.graphviz.org)
    # The path must point to the 'dot' executable
    # enable_dot_graphics('/usr/bin/')

    # Uncomment if you want to add Ruby syntax highlighting
    # You also need to include the html/ruby.css stylesheet in your template
    # enable_syntax_highlighting

    # If you want to enable CVS commit/update support for your wiki, uncomment the following line
    #  and fill in the CVSROOT and the name of the module as parameters
    # The CVS repository and module must exist and the webserver user must have commit access to it
    # You need to have the rscm 0.3 gem installed
    # use_repository('MYCVSROOT','mymodule')

  end

end

documentation:

• with ruby on rails (very simple)
• Developers guide

These are the modifications we made to the edit template.

In the head:

<SCRIPT src="fckeditor/fckeditor.js" type="text/javascript" ></script>

in the body

 <script type="text/javascript">
       window.onload = function()
       {
            var oFCKeditor = new FCKeditor( 'text', '100%', '400' ) ;
            oFCKeditor.ReplaceTextarea() ;
       }
 </script>
 

parameters to new FckEditor: the text areas name is text, width is 100% and height 400. Height and with are optional, but we found the default height (200) too small.

caveat: IT only edits html (so it doesn't like the blank lines in existing wiki pages that much, it prefers <p> tags) - this is something we could make wiki2go aware of.

to mount the site on / and port 80, leave out the -p and -w options:

Wiki2Gomakesite.rb -s agileworkshops.com -t readwrite-u bob -g www-data -d 2go]]> willem 18 October 2005 09:03 GMT http://wiki2go.nayima.be/Wiki2Go/InstallWiki2Go.html Wiki2Go/InstallWiki2Go Creating a new Wiki2Go site

Wiki2Go_make_site.rb
   -s, --server URL              (the url to reach the wiki site)
   -p, --port number             (site port, default is port 80)
   -u, --user username           (owner of the files, typically the Apache web server)
   -g, --group groupname         (group of the files)
   -w, --web default_web         (default subwiki name)
   -t, --type wiki_type          (public, private, readwrite)
   -d, --directory dir           (directory to put wiki in, default = .)
   -h, --help                    Show this message

Public wiki

Everyone can read, write the site. Spam protection is active. Generates HTML.

Private wiki

Only logged-in users can access the site. No spam protection. Generates HTML.

Read/Write wiki

Everyone can read the site. Only logged-in users can edit. No spam protection. Generates HTML.

Further installation steps

1. Create a passwords file in config/passwords using the htpasswd tool
2. (Optionally) edit the config/site.conf file (e.g add ServerAlias entries)
3. Include the config/site.conf file in your main apache config
4. Restart Apache using 'apachectl graceful'
5. Configure the wiki in CgiOptions

See WikiFileLayout

examples]]> yo 09 October 2005 13:02 GMT http://wiki2go.nayima.be/Wiki2Go/Wiki2GoRelease16.html Wiki2Go/Wiki2GoRelease16 Wiki2Go release 1.16

API documentation

Implemented features

• CVS update/commit
• ViewLogfiles
• RubySyntaxHighlighting

Allow the user to embed dot graphics definitions in the page and render them as images. The graphics definitions are embedded in HTML comments.

The parameter after GRAPH: is the filename where the image is stored and determines the type of image to generate (.gif, .jpg, .png). The image filename must be unique within the wiki site.

This image is generated from the following source

<!--GRAPH:demo.png

digraph G { 
  Hello->World
}

-->

Images with client-side maps

If you add URLs to nodes or links, a client-side image map is generated

This image is generated from the following source

<!--GRAPH:mapped.png

digraph G { 
  Home  [URL="FrontPage"] ;
  Graphics [URL="EmbedDotGraphics"];
  Home  ->Graphics 
}

-->

You need to configure the plugin in site/scripts/CgiOptions.rb in the #initialize method

    # Uncomment if you want to add 'dot' graphics to your page (see http://www.graphviz.org)
    # The path must point to the 'dot' executable
    # enable_dot_graphics('/usr/bin/')

Wiki2Go applies formatting to the input text: TextMarkup, InternalLinks, ExternalLinks

The author of a page should be able to disable this formatting for short amounts of texts

Use {!word!} to disable wiki link interpretation for a short piece of text

Use {{! text over several lines!}} to disable wiki link interpretation for several lines

Testcases:

• A WikiWord should not generate a link (disable InternalLinks)
• http://www.rubyforge.com should not generate a link (disable ExternalLinks)
• *This* should not be bold (disable TextMarkup)

def class PublicWikiConfig < Config

  # User is always allowed to edit a public wiki
  def can_edit?
    true
  end 
end

is generated from the following source.

<!--Syntax:ruby
def class PublicWikiConfig < Config

  # User is always allowed to edit a public wiki
  def can_edit?
    true
  end 
end
-->

You need to download the 'syntax' gem and configure the plugin for this feature to work.

Edit the site/html/ruby.css stylesheet to your taste and reference it in your templates.

The default ruby.css is as follows:

.ruby .normal {}
.ruby .comment { color: #005; font-style: italic; }
.ruby .keyword { color: #A00; font-weight: bold; }
.ruby .method { color: #077; }
.ruby .class { color: #074; }
.ruby .module { color: #050; }
.ruby .punct { color: #447; font-weight: bold; }
.ruby .symbol { color: #099; }
.ruby .string { color: #944; background: #FFE; }
.ruby .char { color: #F07; }
.ruby .ident { color: #004; }
.ruby .constant { color: #07F; }
.ruby .regex { color: #B66; background: #FEF; }
.ruby .number { color: #F99; }
.ruby .attribute { color: #7BB; }
.ruby .global { color: #7FB; }
.ruby .expr { color: #227; }
.ruby .escape { color: #277; }

• TextMarkup allows you to style your text
• InternalLinks to create links between pages within the same (sub)wiki
• ExternalLinks to create links outside of the wiki
• FormattingLists to create bulleted or numbered lists
• FormattingTables to create tables
• EmbedDotGraphics to draw graphs
• DoNotInterpret to disable wiki formatting
• RubySyntaxHighlighting to format Ruby code nicely

API documentation

Implemented features

• DoNotInterpret: disable markup interpretation
• ExecutablePages: execute Ruby code embedded in Wiki pages
• SubWiki2Go: install a Wiki2Go as part of an existing site
• UpdateBlacklist: download a new version of the Chongqed Spam blacklist
• TemplateIncludes: allow the administrator to include files into their LayoutTemplates, to reuse common elements.

Executable pages have a name that ends in .rbl

The contents of the page are executed in ERB. This means that <% %> and <%= %> tags are executed.

To enable this potentially dangerous functionality, set the @allow_dynamic_pages to true in CgiOptions

Example: ExecutablePage

1 + 3 = <%= 1 + 3 %> does not get executed on a normal page]]> pascal 05 July 2005 20:22 GMT http://wiki2go.nayima.be/Wiki2Go/ExecutablePage.rbl.html Wiki2Go/ExecutablePage.rbl 1 + 2 = <%= 1 + 2 %>

generates

1 + 2 = <%= 1 + 2 %>]]>