bluemango / screensteps_help

Rails plugin for integrating help content from ScreenSteps Live into your Rails app.

This URL has Read+Write access

screensteps_help / README
100644 87 lines (56 sloc) 3.039 kb
raw blame history 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

ScreenStepsHelp
===============
 
The ScreenStepsHelp plugin allows you to easily add content from ScreenSteps Live (www.screenstepslive.com) to your own Rails application.  The idea is that you can manage all of your help content on ScreenSteps Live but have it show up in your Rails application. 
 
 
Setup
=======
 
You need to add the following to your environment.rb file:
 
ENV['SCREENSTEPS_LIVE_API_KEY'] = "YOUR API KEY FROM SCREENSTEPS LIVE"
ENV['SCREENSTEPS_LIVE_DOMAIN'] = "YOUR_ACCOUNT.screenstepslive.com"
 
If you would like to just try some examples out you can use the following settings to grab content from an example ScreenSteps Live account:
 
ENV['SCREENSTEPS_LIVE_API_KEY'] = "12e5317e88"
ENV['SCREENSTEPS_LIVE_DOMAIN'] = "example.screenstepslive.com"
 
You will also need to add this to your application controller:
 
include ScreenstepsHelp
 
 
Example
=======
 
## CONTROLLER
You might have a help controller in your application.  Here are some example actions:
 
def index
  # returns a hash of all manuals for an account
  @manuals = get_manuals(:show_protected => true)
end
 
def show
  # returns a hash of the contents of a manual
  @manual = get_manual(params[:id], :show_protected => true)
end
 
def show_lesson
  # returns a hash of a lesson that is part of a manual
  @lesson = get_lesson(params[:manual_id], params[:id], :show_protected => true)
end
 
The :show_protected parameter determines whether ScreenSteps Live will return manuals that you have marked as protected.  If you don't pass the parameter then only public manuals will be returned.
 
## Views
 
To insert the manuals and lessons into your views you can iterate over the hashes yourself or use the built in view helpers.  Here are some examples:
 
LIST ALL MANUALS
# returns a ul of all manuals with links to the path specified by :path or the url for the manual on ScreenSteps Live if no :path hash is sent.
 
<%= manuals_list(@manuals, :path => {:action => "show"}, 
						:id => "manuals",
						:list_options => {:class => "manual"},
						:link_options => {:class => "link"}) %>
 
LIST CONTENTS OF A MANUAL
# returns a ul of the sections and lessons in a manual.  Path is handled as described above.
 
<%= show_manual @manual, :title => {:tag => "h2", :class => "title"}, 
						 :sections_list => {:id => "manual", :class => "manual"},
						 :sections => {:class => "section", :tag => "span"},
						 :list_options => {:class => "lesson"},
						 :link_options  => {:class => "link"},
						 :path => {:action => "show_lesson"} %>
 
DISPLAY A LESSON IN A MANUAL
 
<%= show_lesson(@lesson, :title => {:tag => "h1", :class => "title"},
						 :step_titles  =>  {:tag => "h3", :class => "title"}
						  ) %>
 
LINK TO PREVIOUS LESSON IN A MANUAL
<%= previous_lesson(@lesson, {:action => "show_lesson"}) %>
 
LINK TO NEXT LESSON IN A MANUAL					
<%= next_lesson(@lesson, {:action => "show_lesson"}) %>
 
These will add <span>Next Lesson: </span> before the link.
 
 
 
Copyright (c) 2008 Blue Mango Learning Systems, LLC, released under the MIT license