@@ -1,10 +1,15 @@ = Help -This extension provides documentation for Radiant and any installed extensions. +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. +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: +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| ... @@ -12,9 +17,18 @@ Radiant::Initializer.run do |config| ... 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 +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 http://radiantcms.org/ README.rdoc ce3117565ced79b12c0621187fa5cbe5e92f4928 Jim Gay jim@saturnflyer.com http://github.com/saturnflyer/radiant-help-extension/commit/f8f12d77e7606c46999b617a1be865013b021c33 f8f12d77e7606c46999b617a1be865013b021c33 2008-09-17T14:13:08-07:00 2008-09-17T14:13:08-07:00 updated README 499be12d470b6291103c60b97f1b26cde7babff2 Jim Gay jim@saturnflyer.com