Irwi is a Ruby on Rails 4 plugin which adds wiki functionality to your application.
<img src=“https://secure.travis-ci.org/alno/irwi.png?branch=master” alt=“Build Status” />
Add to your Gemfile:
gem 'irwi', :git => 'git://github.com/alno/irwi.git'
Then in your application directory call:
rails g 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:
wiki_root '/wiki'
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.
You may create your own templates for controller actions (
show,editandhistory), in other case default built-in templates will be used.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> forniland “User#{user.id}” for others.
Configuration options are acessed via
Irwi.configobject. 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 methodformat, which gets a string and returns it formatted. By default instance ofIrwi::Formatters::RedClothis used (requires RedCloth gem). Other built-in formatter isIrwi::Formatters::BlueCloth(requires BlueCloth gem). Option accepts formatter instance, not class, so correct usage is:Irwi.config.formatter = Irwi::Formatters::BlueCloth.new
-
comparator- Comparator instance, which builds and renders a set of changes between to texts. By default instance ofIrwi::Comparators::DiffLcsis used (requires diff-lcs gem).
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 returntruewhen it’s allowed for current user to see current page (@page). -
history_allowed?- should returntruewhen it’s allowed for user to see history of current page (@page) and compare it’s versions. -
edit_allowed?- should returntruewhen it’s allowed for current user to modify current page (@page).
Attachments¶ ↑
-