Instiki
Feature Request

Current versions
0.13:ZIP | TGZ

Instiki source

About
What Is Instiki?
User's Guide
FAQ
Instiki Features
Real World Usage

Mail list
IRC
Lavish Praise
Constructive Criticism
Report a Bug
How To Contribute
Feature Request

Sandboxes
Play around with Instiki:
Textile | Markdown | RDoc

Key Features

Revisions
Follow or rollback any change to any page.

Exporting
Take the entire wiki home with you as HTML or markup rolled up in a zip.

Internationalization
Camel Case Wiki Words are supported- in Latin, Greek, Cyrillic, and Armenian characters. Bracket Style wiki words work in all languages.

RSS feeds
Know when content is added.

Markup choices
Write wiki pages in Textile, Markdown or RDoc.

More: Instiki Features

dreams

  • vim editing features
  • Someone to pick pick up carrying this project into Rails 2.x and get us out of this cul-de-sac
  • tag support

Administration Features

  • Ability to turn spam filtering off.
  • Default session_key could be instiki specific, e.g. instiki_session_id, to avoid muddying the cookie namespace when there are other rails apps on the host.
  • Ability to log out
  • Don’t store password in cookie
  • Easily Delete a Wiki Web
  • Easily Delete or rename a page
    • Note: One can delete all orphan pages, but not individual pages.
  • Easily (at all?) review orphaned pages
  • Lock an individual page, rather than a whole web.
    • The front page on this wiki was covered with spam, just reverted
  • User level permissions
  • Import instiki exports into a new web!
  • Bayesian SPAM blocking and support for IP blacklists.
  • Password management
    • Ability to change master password and recover lost passwords.
    • Ability to password protect Edit separately from View for a wiki web. Dual view should be an alternative solution but image references etc. doesn’t seem to work in the published view.
    • Ability to set page specific password for Edit. Pages referred to from a password protected page should inherit the same password protection. This requires that password may be set from Page Edit view (using System password). This would be a very powerful way to share a common working area within a wiki that a subset group has edit access to.
      • Actually, I would like to see more fine-grained access-controls (as in, say, Apache). It would be nice if I could specify that “Bob” (and his password) could access webs “A”, “B” and “C”, while user “Carol” can access webs “B” and “D”.
  • Module/Extensions
    • Even just extending markup would be fine, with this feature people could easily implement syntax highlighting etc. For example one could extend tag <syntax lang="c"> to run the block through a syntax highlighter which returns HTML code for Instiki to append to the output. (Kaali)
  • SSL ability – privacy from firewall logging while working in an invite-only wiki site
  • Provide documentation for installing at Dreamhost, one of the more popular hosting companies.
  • Moderation of anonymous posts. (Anti-spam feature).
  • Option to have links to pages outside of the current domain use “target=”_blank”

Formatting & Editing Features

  • Attachment feature! Ability to upload files and place them along the contents. (which should also allow inline image viewing as well.)
  • A spell checker?..possibly based on: raspell gem? seeHere
  • WYSIWYG editor integration, such as Kupu
  • Add Smartypants support by default (via Ruby Pants?)
  • Ability to include blocks of HTML within the wiki
  • Ability to implement redirection pages as in MediaWiki (using
    REDIRECT# link in internal link style
    )
  • Ability to sign edits as in Media Wiki (with ~~~~)
  • Ability to write equations in Latex. This isn’t hard by using jsMath.
    See TeX Equations with jsMath.
    Would it be possible to include ritex support, seems more elegant to transform a TeX equation to MathML instead of relying on js
    • Yes, it’s possible. I’ve done it . However:
      1. Ritex is based on a rather old version of itex2MML, so I decided to port itex2MML as a Ruby extension.
      2. I also replaced Blue Cloth with Maruku, a vastly superior Markdown implementation.
      3. Serving MathML currently means sending application/xhtml+xml, which requires some tweaks to instiki. I’ve created a BZR Branch with my changes . The list of fixes is quite extensive. For instance: Instiki’s method for producing “redline” diff’s between versions of a page (lib/diff.rb) is very lame, and frequently produces ill-formed XHTML. In my branch of Instiki, I’ve replaced it with xhtmldiff , which produces well-formed XHTML redline documents.
      4. None of these new features work with Textile (Red Cloth) or RDOC formatting.
  • Web-wide content, like a sidebar.
    • Note, currently can be done with an “include” command.
  • Media Wiki style templates.
  • Consolidation of global CSS in one file (e.g. newWiki Word style is in instiki.css, but existingWiki Word style is not)
  • Distinguish between internal and external links
    • Note, this is possible, to some degree with CSS
      
          a[href^="http:"]:before {
              color:#f00;
          }
      
  • GeSHi like Syntax Highlighter (or bridge to the GeSHi PHP code)
  • Removal of inline styles. The text-area on the edit page has fixed width. This should be set in the stylesheet, so we can override it.
  • Formatting conversion – convert existing pages between formatting styles (Markdown,Textile,RDoc) and personal formatting options: user should be able to choose his own formatting style.
  • Table of Contents – Hierarchical layout drawn from Header layers.
  • Integrate advanced formating Tips into distribution (no link to external website) → it stayes usable without an internet connection
  • Random page selector, like Media Wiki
  • Media Wiki syntax. It’s quite likely the most common Wiki syntax because of Wikipedia, so supporting it would be a logical choice. (Kaali)
  • Don’t link Wiki words if the link would point to the current page. (Kaali)
  • As a personal-wiki feature, I would love to email my wiki a page, with the page name as the subject line. Entry points! Entry points!
  • Ability to include syntax-highlighted Ruby code in pages
  • Support for CREOLE markup
  • How about Bi-Directional language support? (Hebrew, Arabic, etc.)
  • Ability to link to local PDF and HTML files (ie, file:///f:/myfolder/myown.html). This format normally works in any browser, but Instiki only recognizes things that begin with http.

Wiki Features

  • Prompt ‘unlock page’ when user leave the edit page by close browser window or clicking back button rather than clicking the ‘cancel’ link.
  • The ability to redirect on page to another i.e. someone searches for Windows and it sends them to Microsoft.
  • Email subscription to any pages for change notification?
  • Visual confirmation for editing to help keep spam out.
    • Catchpas are quite annoying. Maybe a system which detects the percentage of modification on the page, if the percent is too big, then it would use a catchpa. (Kaali)
  • Allow for account creation/login when submitting. (see point 6 Administration Features)
  • Talk back pages (like Media Wiki) or Comments on pages (like WakkaWiki).
  • Comments in margins
  • The ability to list all pages in a category in a sidebar.
    • Note: Categories can be added by writing category: 'category name' (without quotes)
  • Include export to HTML/PDF/Textile for “published” (read-only) webs. The PDF export is useful at end of projects when a wiki typically will be closed,
  • Full feeds for protected webs.
  • Search available in “published” content.
  • Edit preview.
  • Images displayed on a page, and stored locally
  • Section editing (a la mediawiki) for long pages
  • Graphviz integration
  • Ability to insert textboxes which save their state (e.g., for a todo list)
  • Easy Blog-style pages which allow automatic posting with date/time (could also be edited like any other wiki page
    • I took a crack at implementing blog-style pages. You can see it here .
  • Shortcuts (e.g. Alt+b for bold)
  • AJAX Style Editing – and auto saving of draft edits like Google Mail.
  • Quick navigation keys “previous page”, “next page”. Although the browser has keys for moving back and forth in the page history, it can not distinguish between edit and view mode.
  • Macro/Plugin support a la MoinMoin. Use a special syntax, for example:
<<MacroClass(attr1=value,attr2=value)>>content<</MacroClass>> to replace with the invocation of MacroClass. This can be used to implement searches, tables of content, includes etc.
  • Add keyword: functionality, similar to category: but any words after it will be picked up in the search but not displayed on the page
  • History view where you can see a list of revisions with a date and a author. It would be a lot easier to remove multiple entries of spam by checking a list like this rather than guessing if there is a entry between two spams and being worried about backtracking. (Kaali)

Import / Export / View Features

  • Openoffice Import / Export
  • DokuWiki import/export
  • How about being able to sync between different machines?
  • Export namespace and/or entire wiki to properly marked up PDF document (useful at end of project).
  • Remove “Print view” and add a proper print CSS instead.
  • Would it be possible to have the:

    Edit | Views: Print | Linked from: Home Page

    line that is at the bottom of each on the top of each page also? I would not mind changing it but I do not know which changes to make.

    Regards – great tool!

  • Atom 1.0 feed (in addition to or instead of the RSS feed).

Mac OS X specific

  • A simple installation procedure. I used Instiki in the past, but I can’t get it to run anymore, with the new database.
  • Icon in menu bar, instead of the word ‘Wiki’. Or get rid of menu bar presence altogether; the commands contained in the menu add little value over a simple bookmark in the user’s default browser.
  • I agree with changing the OS X menu bar to an icon, and possibly making that icon optional, but there’s a key feature that should be kept: it’s trivial to create a personal Instiki on OS X by adding Instiki.app to the user’s Login Items in System Preferences → Accounts. This will automatically startup and shutdown Instiki when the user logs in or out. Given how delightfully easy this is, it’s ridiculous to mess about with a launchd script for any system not using Instiki as a publicly exposed service.
  • Spotlight integration (make Instiki web content searchable with Spotlight)
  • Universal Binary (make instiki image run natively on both plattforms)

category: Feature

Search Feature

  • The ability to do a search for 2 or more words or categories on a page, ie Boolean logic, rather than single string.
  • You could use Ferret for this?

As a gem or plugin

Be self-contained to support mashup-style integration within larger applications that want wiki features. Any social application these days needs a wiki, but also needs discussions, blogs, photos, etc etc etc.

Documentation

  • How to get by spam filtering

Simple

  • if you want mediawiki features, use mediawiki—i like instiki being simple