Using the online help feature

This page explains how the online help feature should be used.

Specifying the help page

The 'Help' menu item only appears when the @help instance variable is set. The value should be the name of the help page.

Example:

def create
  @help = 'create'
  ...
end

Help page

Help pages are normal erb template files and they are located in the same directory as the other views of the controller. They should be named like:

online_help__PAGE.EXTENSION

PAGE is the name of the help page. The EXTENSION is usually .rhtml but you can use other formats as well.

Future improvements

• Linking - Helper method for generating links to other help pages.