Irwi is a Ruby on Rails 4 plugin which adds wiki functionality to your application.
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, edit and
history), 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.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 (see section below). -
paginator- Paginator instance, which display pagination controls (see section below). -
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).
Irwi supports custom formatters which can be configured by setting Irwi.config.formatter to corresponding instance.
Each formatter should have method format, which gets a string and returns it formatted.
There are several supported formatters based on different gems (which tou should add to Gemfile of your application):
Irwi::Formatters::RedCloth- markdown formatter based onRedClothgem.Irwi::Formatters::RedCarpet- markdown formatter based on `redcarpet gem.Irwi::Formatters::BlueCloth- textile formatter based onBlueClothgem.Irwi::Formatters::WikiCloth- formatter based onwiki_clothgem.Irwi::Formatters::SimpleHtmlwhich does nothing.
By default, Irwi will select first available (having corresponding gem in application Gemfile) formatter.
Also, you may select formatter explicitly by specifying Irwi.config.formatter value like:
Irwi.config.formatter = Irwi::Formatters::BlueCloth.new
Irwi supports custom paginators which can be configured by setting Irwi.config.paginator to corresponding instance.
There are following supported paginators (which tou should add to Gemfile of your application):
Irwi::Paginators::WillPaginate- based onwill_paginategem.Irwi::Paginators::Kaminari- based onkaminarigem.Irwi::Paginators::Nonewhich does nothing.
By default, Irwi will select first available (having corresponding gem in application Gemfile) paginator.
Also, you may select paginator explicitly by specifying Irwi.config.paginator value like:
Irwi.config.paginator = Irwi::Paginators::WillPaginate.new
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).
Irwi allows easy attachment integration in your wiki. There area several simple steps to add attachments to wiki pages:
- Call
irwi_wiki_attachmentsgenerator. It will create WikiPageAttachment class. - Include
config.gem "paperclip"in yourenvironment.rbor, if you prefer another library modify generated code for it. - Append to initializer (or create a new one) something like
Irwi.config.page_attachment_class_name = 'WikiPageAttachment'. - Run
rake db:migrateand start using attachments in your wiki!
- Alexey Noskov (http://github.com/alno)
- Ravi Bhim (http://github.com/ravibhim)
- Pavel Valodzka (http://github.com/valodzka)
- Xavier Defrang (http://github.com/xavier)
- Tomáš Pospíšek (http://github.com/tpo)
- Evan Arnold (http://github.com/earnold)
- https://github.com/alno/irwi/contributors
Feel free to add yourself when you add new features.
Copyright (c) 2009 Alexey Noskov, released under the MIT license