saturnflyer / radiant-help-extension
watch download tarball
public
Forks7Right
Watchers21Right
Description: Help documentation extension for radiant cms
Homepage: http://www.saturnflyer.com
Clone URL: git://github.com/saturnflyer/radiant-help-extension.git
Click here to lend your support to: radiant-help-extension and make a donation at www.pledgie.com ! 
still set template_name for now
saturnflyer (author)
Fri Jul 03 09:45:05 -0700 2009
commit  290a353e313e42b3b7d54af415e03c7b9121d568
tree    ff3b9eb16e4ec7bed7d3550423d97626e209e069
parent  0ef4c8150da07cabaa38bb160f5620155dec8781
name age
history
message
file .gitignore Thu Jun 12 20:54:25 -0700 2008 adding in editable regions, updated README [saturnflyer]
file HELP_developer.rdoc Thu Sep 04 12:51:40 -0700 2008 updated dependency doc [saturnflyer]
file README.rdoc Wed Sep 17 14:13:08 -0700 2008 updated README [saturnflyer]
file Rakefile Mon Jun 09 12:22:51 -0700 2008 initial commit [saturnflyer]
file TODO Mon Jul 14 20:34:20 -0700 2008 corrected view hard-coded SimpleMarkup [saturnflyer]
directory app/ Fri Jul 03 09:45:05 -0700 2009 still set template_name for now [saturnflyer]
file help_extension.rb Tue Jun 30 05:25:54 -0700 2009 radiant 0.8.0 dependency [saturnflyer]
directory lib/ Thu Sep 11 06:49:08 -0700 2008 updated radiant:help task [saturnflyer]
directory spec/ Tue Jun 30 06:48:11 -0700 2009 fixed controller specs [saturnflyer]
README.rdoc

Help

This extension provides documentation for Radiant and any installed extensions.

Installing Help is as easy as any other Radiant extension. Drop it into your vendor/extensions directory.

Once the extension is installed, you must ensure that your application will load the Help extension before loading any extensions that rely on the help regions. To do so, edit your config/environment.rb to load Help first:

Radiant::Initializer.run do |config| … 

        config.extensions = [ :help, :all ]

… end

Help provides basic information for the average user at admin/help, but also provides documentation for tasks and features available to developers and admins at admin/help_role/developer and admin/help_role/admin. Additionally, any extensions loaded with HELP files may be found at /admin/help_extension/:extension_name/:role but a list of links is automatically generated for your clicking pleasure.

For more information about developing for Help, install it and go to /admin/help_extension/help/developer or read the included HELP_developer.rdoc

Some content taken from radiantcms.org/

Built by Saturn Flyer www.saturnflyer.com