Yaml Help plugin

Plugin details

Documentation

Install the plugin:
ruby script/plugin install http://yaml-help.googlecode.com/svn/trunk/

=== USAGE
* Create a dir under app_root, for instance, app_root/help.

* add yml help files corresponding to controllers.
- app/controllers/doors_controller.rb ~~ help/doors.yml

* create nodes corresponding to controller actions
e.g.

	open:
	  text: Help message goes here
	  image: open_door.gif
	close:
	  text: Another help message
	  image: close_door.gif



* create instances of YamlHelp in controller actions, such as
controller

	class DoorsController < ApplicationController
		def open
			help = YamlHelp.new('doors', "#{RAILS_ROOT}/help") 
			@help_msg = help[:doors][:open]["text"]
			@help_image = help[:doors][:open]["image"]
		end
	end



View

	
	<%= image_tag @help_image %>
	<%= @help_msg %>

Further Documentation

There is currently no advanced documentation for this plugin.

New documentation

Edit plugin | (0 older versions) | Last edited by: scott, about 1 year ago