Restful Citations plugin

Plugin details

Comment system for Ruby on Rails applications, which includes: classical tree-view comments, citations and notes. Main targeting feature is simplicity of integration in Ruby on Rails application.

Websitehttp://rubyforge.org/projects/rf-comments/ Repositoryhttp://rf-comments.rubyforge.org/svn/trunk/restful_citations/ Author Alexey Noskov Tags Rest, comment LicenseMIT

Documentation

Install the plugin:
ruby script/plugin install http://rf-comments.rubyforge.org/svn/trunk/restful_citations/

Using
==========

Common configuring:
1. Add *map*.*from_plugin* :*restful_citations* to your *routes*.*rb*
2. Copy localization files from {*RAILS_ROOT*}/*vendor*/*plugins*/*restful_citations*/*lang*/*ui* directory to your {*RAILS_ROOT*}/*lang*/*ui* directory, or add their content to your existing localization files
3. In *environment*.*rb* set your localization language (for example, *Globalite*.*language* = :*en*)
4. If you want to specify per-user access rules and your helpers haven't method *current_user*, implement this method in *ApplicationHelper*.

For citable:
1. Add *acts_as_restful_citable* into your model class to declare it as citable
2. Add <%=*restful_citations_include*%> into your erb template to include styles and javascripts
3. Don't forget to add <%= *javascript_include_tag* :*defaults* %> to your layout
4. Add <%= *restful_citations_for* {*model_instance*} %> into view to render citation editor for {model_instance}
5. Add <%= *restful_citations_toggle_link* {text}, {model_instance} %> to create link to toggle citation editor.

Further Documentation

There is currently no advanced documentation for this plugin.

New documentation

Edit plugin | (0 older versions) | Last edited by: hardway, 9 months ago