Blogpad An exercise in brevity.

Amazon introducing A9 Instant Reward →← Bye-bye Opera (for bookmarks)

Using Instiki to manage incoming data gracefully

Background info
Imagine a huge bookmarks file, dozens of text files laying around acting as to-do lists of sorts, and another dozen or so “Post-it” notes in Stickies serving similar purposes.

The quest
In my quest to manage all that data gracefully and effectively, I started considering the use of a Wiki clone.

I started with Qwikiwiki, an easy-to-install and even-easier-to-use web-based Wiki, only to realize after a couple of weeks that it couldn’t meet my needs. (That’s not to say, that it sucks; and the developer was quite helpful when assisting me with a problem I had stumbled upon.)

The destination
Three weeks ago, I decided to give Instiki a go, and I’m here to report that it (almost) rocks.

Installation is a breeze, especially if you’ve already got the Ruby interpreter installed.

Performance-wise, it hits that golden spot between simplicity in use and complexity in features.

Its aesthetics are very good and only a minor tweaking was needed to suit this thing to my tastes. When it comes to interfaces I have to interact with for great amounts of time, a visually pleasing and elegant UI (again: by my standards) is a must.

There are rollbacks; done something wrong and messed the contents of a page? With a couple of clicks you can get to any of that page’s previous states.

The built-in search engine supports even regex queries.

It runs locally, meaning you don’t have to be connected to the Internet to edit the Wiki; a very important point for dial-up users.

Finally, a special mention should go to the export mechanism. In true Instiki spirit, it’s dead-easy to export the Wiki’s content in either HTML (with working links and all) or the pure markup (to import in another Wiki).

A problem comes up
That’s not to say Instiki is flawless (as someone would expect, with a software that’s not even reached v1.0 yet). And before we continue with the bugs I’ve found, let me tell you a short story.

A couple of days ago (and ironically, while I was writing this praise), my PC shut-down due to a power network failure while Instiki was running. Upon restarting my PC, Instiki wouldn’t run, giving me a weird error:
Internal Server Error
incompatible marshal file format (can’t be read) format version 4.8 required; 0.0 given
WEBrick/1.3.1 (Ruby/1.8.1/2003-12-25) at localhost:2500
I was surprised to see Instiki give up, because it was running when the power went down, but it wasn’t processing any data or executing any commands; it was idle.

I tried to find more information about the error over at Instiki’s website and found nothing. Same thing with Google; nothing helpful. I went back to Instiki’s website trying to find a mailing list or a support forum; nothing (the IRC channel was empty). I ended up posting my help question in the FAQ; a week later and nobody replied.

It took some tedious testing, but I was finally able to fix the problem on my own. Since the problem would persist, even after re-installing the Ruby interpreter and Instiki, I discovered that the file causing the trouble was the latest “snapshot” grabbed by Instiki (a snapshot is a file containing all the Instiki changes/commands/etc. that happened in the last 24 hours). I removed it from Instiki’s storage directory and opened it with a text editor to retrieve all the valuable data I had stored. With that last snapshot being removed, Instiki would run normally and I was able to re-input all the data that snapshot contained.

So, not to sound bitter and all, but a dedicated support forum or a mailing list properly linked to from Instiki’s main page would be a welcome addition.

For now, if you need support and you’re not covered by the FAQ, you’re probably out of luck.

Bugs
The bugs I’ve run into are trivial, have mostly to do with some of its auto-formatting features, and I’m sure they’re going to be taken care of soon.

For example, references to non-.com/.net/.org domains are not recognized and auto-formatted as links (e.g. http://soma.fm/ isn’t transformed into a link).

There is one major “complaint”, but I’m not sure if it’s entirely Instiki’s fault: with all the data I’ve inputted into it so far, it takes more than 10 minutes (11 minutes by today’s count) for my first Wiki request (e.g. display the homepage) to be executed; consequent requests for the homepage or other Wiki pages are executed almost instantly.

I’m putting the word “complaint” into quotes for two reasons:
  1. Can this be avoided? I’m not a Wiki clones connoisseur, so I can’t tell if there’s a clone out there who handles a similar situation while avoiding this 10 minute “buffering…”-like wait.
  2. I’m running Instiki on a rather old computer.

Conclusion
I’m 80% done with the bookmarks importing (I’m doing it manually to ensure proper categorisation — ouch), and 100% done with the lists, etc. I like the end result, and feel that the move was right; I’ve now got a place that acts as my central repository for commonly-used data and even brainstorming sessions as the readme file suggests (this entry was written in my Instiki installation).

If you’re in a similar situation to mine, looking for an elegant and working way to manage data you’re (for the lack of a better phrase:) “messing with” on a continuous basis, you may want to consider Instiki.

And of course, if you were in a similar situation, and found a better way to handle things, I’m all ears.
Aug 31st, 2004

Comments on “Using Instiki to manage incoming data gracefully”

  1. Are you still using Instiki? I’ve done some heavy Wiki use and have been playing with Instiki for a few months now. My installation has run into several pretty nasty barriers from my most common use — links lists. You’re right about your issues with Instiki lacking a mailing list and/or forum. Perhaps both of those things could be set up for a 1.0 release. As it stands now, I’ve found a huge amount of issues with Instiki, and I’m waiting impatiently for the current round of patches to be imported so some of the stupider bugs can be fixed. I ran into some walls trying to figure out how to apply patches myself, and went hunting for a mailing list.. and found you. lol.

    Sy on October 6th, 2004 at 3:09 am / Edit
  2. I ended up going with MediaWiki. It’s only a little more difficult to install as instiki, and is feature-rich.

    Sy on November 6th, 2004 at 3:55 pm / Edit
  3. Sy, thanks for your comments and apologies for the late reply; things have become insanely busy lately, and there’ll be no time for Internet or computers for me, until February at least. I’m still using Instiki, but its shortcomings have me looking for an alternative. Thanks for pointing out MediaWiki; from what I can see on your website, it looks good; I’ll give it a shot when I have the time.

    Konstantinos on December 9th, 2004 at 2:24 am / Edit
  4. With some further research, it appears that Instiki’s rollback issues have become a horror. Heck, even the “Rollback Wars” page got rolled back over. Hah! The author is one cool dude, who is doing some great work with rails, but instiki .. I dunno, it got left behind. I had thought that a project which is the host of huge projects like wikipedia would certainly cover all of my requirements, but the more time I spend with MediaWiki the more embarassing flaws I find. Well, nothing’s perfect and maybe I don’t know everything I need to, to be satisfied with MediaWiki, but it’s “good enough” for me, for now.. Although I know just how lacking in time one’s life can get, when you do have the time maybe you’ll remember this here thread of ours. I’m continuing to take notes with MediaWiki, so perhaps they will serve you well once you have time to begin research. http://sysy.homeip.net/index.php/MediaWiki/Sy%27s_Issues Btw, MediaWiki installation on Windows was a breeze. Cheers, Sy

    Sy on December 9th, 2004 at 2:53 am / Edit
  5. Instiki’s rollback issues (as well as most other stuff that you are talking about here) have been fixed. If you are still using Instiki and upgraded to 0.9.2, I’d like to know if your startup time is still 10 minutes. This is unreasonable. Complete www.rubyonrails.org content starts in 5 seconds on my PC. Alex

    Alexey Verkhovsky on January 12th, 2005 at 7:02 pm / Edit
  6. I’ve chanced upon this website out of desperation. I hope someone can help since www.instiki.org has been down for a while now and I can’t get to any faq or documentation online. I’m running Instiki 0.11. My problem is with Instiki consuming increasing amounts of memory (physical/swap) to the extend that it will eventually slow down or even crash the server I’m using. I understand that Instiki caches/journalises all changes to it’s memory for speed but how can I force it to write the changes to the harddisk at regular intervals to bring memory usage down? Any pointers would be appreciated. I was reviewing the change log prior to 0.11 and Btw, where is this ‘snapshot’ file being referred to above?

    Frank on October 11th, 2006 at 4:03 am / Edit