deac/instiki: a basic wiki clone so pretty and easy to set up, you’ll wonder if it’s really a wiki.

a basic wiki clone so pretty and easy to set up, you’ll wonder if it’s really a wiki.

Find a file

Alexey Verkhovsky 98848397d3 [DRASTIC THING!] Moving trunkto branches/instiki-madeleine, for posterity		2005-11-06 08:19:30 +00:00
app	Cleaned up unit tests and began refactoring link generation	2005-08-25 07:41:25 +00:00
config	Removed debugging code from the last commit	2005-08-09 02:29:51 +00:00
lib	Cleaned up unit tests and began refactoring link generation	2005-08-25 07:41:25 +00:00
natives/osx/desktop_launcher	Committing OS X build files from Oleg	2005-08-15 00:40:34 +00:00
public	Replaced links to static resources with appropriate Rails helpers	2005-07-19 22:27:45 +00:00
script	Added usage documentation to script/debug_storage	2005-05-29 17:08:15 +00:00
test	Cleaned up unit tests and began refactoring link generation	2005-08-25 07:41:25 +00:00
vendor	Upgraded rubyzip to 0.5.8	2005-04-10 16:55:44 +00:00
CHANGELOG	Documented the previous change	2005-08-01 05:08:29 +00:00
instiki	same as before	2005-02-05 12:25:01 +00:00
instiki.gemspec	The right Rails version in gemspec	2005-07-30 07:05:49 +00:00
instiki.rb	compulsive quote editing	2005-02-05 12:15:50 +00:00
rakefile.rb	Corrected shorthand Rake tasks for unit testing	2005-05-12 00:34:37 +00:00
README	Initial import of the sources from SVN	2005-01-15 20:26:54 +00:00

README

===What is Instiki?

Admitted, it's YetAnotherWikiClone[http://c2.com/cgi/wiki?WikiWikiClones], but with a strong focus
on simplicity of installation and running:

Step 1. Download

Step 2. Run "instiki"

Step 3. Chuckle... "There's no step three!" (TM)

You're now running a perfectly suitable wiki on port 2500 
that'll present you with one-step setup, followed by a textarea for the home page
on http://localhost:2500.

Instiki lowers the barriers of interest for when you might consider
using a wiki. It's so simple to get running that you'll find yourself
using it for anything -- taking notes, brainstorming, organizing a 
gathering.

===Features:
* Regular expression search: Find deep stuff really fast
* Revisions: Follow the changes on every page from birth. Rollback to an earlier rev
* Export to HTML or markup in a zip: Take the entire wiki with you home or for reference
* RSS feeds to track recently revised pages
* Multiple webs: Create separate wikis with their own namespace
* Password-protected webs: Keep it private
* Authors: Each revision is associated with an author, so you can see who changed what
* Reference tracker: Which other pages are pointing to the current?
* Speed: Using Madelein[http://madeleine.sourceforge.net] for persistence (all pages are in memory)
* Three markup choices: Textile[http://www.textism.com/tools/textile] 
  (default / RedCloth[http://www.whytheluckystiff.net/ruby/redcloth]), 
  Markdown (BlueCloth[http://bluecloth.rubyforge.org]), and RDoc[http://rdoc.sourceforge.net/doc]
* Embedded webserver: Through WEBrick[http://www.webrick.org]
* Internationalization: Wiki words in any latin, greek, cyrillian, or armenian characters
* Color diffs: Track changes through revisions

===Missing:
* File attachments

===Install from gem:
* Install rubygems
* Run "gem install instiki"
* Change to a directory where you want Instiki to keep its data files (for example,  ~/instiki/)
* Run "instiki" - this will create a "storage" directory (for example, ~/instiki/storage), and start a new Wiki service

Make sure that you always launch Instiki from the same working directory, or specify the storage directory in runtime parameters, such as:
  instiki --storage ~/instiki/storage

===Command-line options:
* Run "instiki --help"

===History:
 * See CHANGELOG

===Download latest from: 
* http://rubyforge.org/project/showfiles.php?group_id=186

===Visit the official Instiki wiki:
* http://www.instiki.org

===License:
* same as Ruby's

---
Author:: David Heinemeier Hansson
Email::  david@loudthinking.com
Weblog:: http://www.loudthinking.com