Instiki
HomePage

Introduction

These pages are devoted to my MathML-enabled branch of Instiki, the nifty Ruby-on-Rails-based Wiki.

Math support is based on itex2MML and is enabled if you choose the “Markdown+itex2MML” text filter. There’s a quite serviceable LaTeX export (click on the “TeX” link at the bottom of any wiki page).

Since this version of Instiki emits real XHTML, you can also do fancy things, like embed inline SVG. It should render in any SVG-capable browser.

You can have multiple wikis (“Webs” in the parlance of Instiki) under the same Instiki instance. Each wiki can be password-protected (with its own distinct password). And, if you’re so-inclined, you can publish a “read-only” version of a password-protected wiki, so that others can read, but not modify, what you’ve written.

Installation is very easy. Instiki comes bundled with its own webserver (which, by default, listens on port 2500), so you should be up-and-running in minutes.

Of course, there are always improvements that can be made. That’s where (I hope) you come in …

Differences

Aside from the obvious difference, of its support for math:

• This branch is based on Rails 2.1.1, rather than 1.2.1. And it incorporates all of the improvements in the current Instiki trunk.
• It’s been extensively modified to work correctly as XHTML.
• It does content-negotiation, to serve application/xhtml+xml to compatible browsers. That includes Internet Explorer, with the MathPlayer plugin installed.
• It uses Maruku as its Markdown engine, instead of BlueCloth. BlueCloth sucks.
• Markdown is the default markup syntax. Textile is available (but not recommended — it’s not expected to work well in an XHTML environment).
• It uses xhtmldiff to generate “redline” documents of changes between successive versions of a wiki page (the “See changes” link at the bottom of any wiki page).
• It has a real, functional, LaTeX view, which produces a TeXable output (equations and all) from your Markdown+itex source.
• It has an S5 output view, which produces an S5 slide show (complete with equations!) from your Markdown+itex source. And it supports S5 Themes, for that customized look-and-feel.
• It uses Atom 1.0, instead of RSS 2.0, for its syndication feeds.
• File system-based caching, full support for Etags and Conditional GETs, for more efficient use of bandwidth.
• Many other improvements and bugfixes.

Source & License

Instiki is free software, licensed under the same license as Ruby. The source to this branch is available from the BZR Repository or as a tarball. The BZR Repository has an Atom feed, with which you can stay abreast of the development of this software.

Math support requires the itex2MML Ruby bindings (tarball, BZR, feed). itex2MML is licensed under a dual GPL and MPL license.

Changelog

Here’s a comprehensive list of the changes made to this branch of Instiki.

Sandbox

If you want to see this MathML-enabled Wiki software in action, feel free to play around in the Sandbox.