Irwi¶ ↑

Irwi is a Ruby on Rails 3 plugin which adds wiki functionality to your application.

Summary of modifications in this fork¶ ↑

This gem has been modified from its forked version to support generic file attachments, rather than just images, as well as private S3 uploads. However, it currently assumes that you are using Paperclip + Fog for storage, since it calls expiring_url on attachments to get expiring urls for private S3 files.

In addition, this version includes formatting instructions for Markdown by default.

Installation¶ ↑

Add to your Gemfile:

gem 'irwi', :git => 'git://github.com/neilgupta/irwi.git'

Then in your application directory call:

script/generate irwi_wiki

It will generate:

WikiPageController to serve wiki pages
WikiPage model to represent page
Migration to prepare database

Also it will add to your routes.rb something like:

map.wiki_root '/wiki'

Wiki syntax (links to other pages)¶ ↑

You can link pages by using

[Some page title]

construction in text. If linked page exists, when it will be replaced with link to this page, in other case it will be replaced with link to new page with such path/title.

Template definition¶ ↑

You may create your own templates for controller actions (show, edit and history), in other case default built-in templates will be used.

Helper definition¶ ↑

Following helpers are defined by default and you may replace them with you own:

wiki_user - Renders user name or link by given user object. By default renders <Unknown> for nil and “User#{user.id}” for others.

Configuration¶ ↑

Configuration options are acessed via Irwi.config object. Currently supported options:

user_class_name - Name of user model class. By default - ‘User’

Define a method named 'current_user' method on WikiPagesController that returns the object for the current user

formatter - Formatter instance, which process wiki content before output. It should have method format, which gets a string and returns it formatted. By default instance of Irwi::Formatters::RedCloth is used (requires RedCloth gem). Other built-in formatter is Irwi::Formatters::BlueCloth (requires BlueCloth gem). Option accepts formatter instance, not class, so correct usage is:

Irwi.config.formatter = Irwi::Formatters::RedCarpet.new
comparator - Comparator instance, which builds and renders a set of changes between to texts. By default instance of Irwi::Comparators::DiffLcs is used (requires diff-lcs gem).

Access control¶ ↑

If you want (and it’s good idea) to specify which users can see or edit certain pages you should simply override following methods in your controller:

show_allowed? - should return true when it’s allowed for current user to see current page (@page).
history_allowed? - should return true when it’s allowed for user to see history of current page (@page) and compare it’s versions.
edit_allowed? - should return true when it’s allowed for current user to modify current page (@page).

Attachments¶ ↑

Irwi allows easy attachment integration in your wiki. There area several simple steps to add attachments to wiki pages:

Call irwi_wiki_attachments generator. It will create WikiPageAttachment class.
Include gem "paperclip" and gem "fog" in your Gemfile
Append to initializer (or create a new one) something like

Irwi.config.page_attachment_class_name = ‘WikiPageAttachment’

Paperclip::Attachment.default_options = :fog Paperclip::Attachment.default_options = { aws_access_key_id: ‘AWS ACCESS KEY’, aws_secret_access_key: ‘AWS SECRET’, provider: ‘AWS’, region: ‘us-east-1’ } Paperclip::Attachment.default_options = “AWS BUCKET” Paperclip::Attachment.default_options = false

Run rake db:migrate and start using attachments in your wiki!

Contributors¶ ↑

Alexey Noskov (github.com/alno)
Ravi Bhim (github.com/ravibhim)
Pavel Valodzka (github.com/valodzka)
Xavier Defrang (github.com/xavier)
Tomáš Pospíšek (github.com/tpo)
Evan Arnold (github.com/earnold)
github.com/alno/irwi/contributors

Feel free to add yourself when you add new features.

loofel / irwi