Tog Help

A plugin to manage help pages for applications.

== Included functionality

• Link to the help page.
• Url to the help page
• Automatic help page tree creation (with notification to admins)

Resources

Plugin requirements

You need to install another tog platform plugin: In case you haven't installed any of them previously you'll need the following plugins:

• tog_vault

Follow each link above for a short installation guide incase you have to install them.

Install

• Install plugin form source:

ruby script/plugin install git://github.com/jenaiz/tog_help.git

• Generate installation migration:

ruby script/generate migration install_tog_help

with the following content:

class InstallTogHelp < ActiveRecord::Migration
  def self.up
    migrate_plugin "tog_help", 2
  end

  def self.down
    migrate_plugin "tog_help", 0
  end
end

• And...

 
rake db:migrate

You only have to put a link in your views and you automaticaly will have a new CMS page with the name.:

<%= link_to_help %>

For example, if you visit the /home/index the new page will be in:

  /cms/inicio/help/{locale}/home/es_home_index  

Other examples of use:

  link_to_help(cmspage, name, options = {})

The helper define the params:

• cmspage: if it isn't nil, the link go to this cms page.
• name: if you don't want to use the text by default: I18n.t("tog_help.help"), you can use your own text.
• options: They are html_options like: class, etc.

<%= link_to_help('my_own_page', 'help') %>

<%= link_to_help('') %>

By default the plugin has the propeties:

Tog::Config["plugins.tog_help.initial_path"] => "inicio/help/"

You can change it to your personal path.

Copyright (c) 2009 , released under the MIT license