radiant-help-extension 1.1.0

data/app/views/admin/help/_extension_docs_list.html.haml

@@ -0,0 +1,9 @@
+- unless @docs.blank?
+  .Docs
+    %h2= "#{(@role.titleize + ' ') unless @role == 'all'}Help Documents"
+    = render :partial => 'docs_introduction'
+    %ul
+      - @docs.each do |doc|
+        %li
+          - doc_name = doc_extension_dir(doc)
+          = link_to doc_name.titleize, help_extension_doc_url(doc_name, @role)

data/app/views/admin/help/_organizing.html.haml

@@ -0,0 +1,7 @@
+%h2 Organizing and Creating Pages
+%p Pages are organized in a parent/child relationship.
+%p That means that if you want an "About Us" section on your website and you want to have a page for each member of your staff, each staff page would be a 'child' of the "About Us" page.
+%h3 Creating
+%p To create a page, you add a child to another page. Your home page, for example, is the root of your website: all pages stem from your home page and it lives at yoursite.com/
+%p A child of the home page lives at yoursite.com/about and a child of that child lives at yoursite.com/about/management-team.
+%p If you think of your pages in terms of a family, you'll see that yoursite.com/about and yoursite.com/services are siblings. That is, they are both children of the home page.

data/app/views/admin/help/_other_index.html.haml

@@ -0,0 +1,2 @@
+%h2 Standard Information wasn't found
+%p= "We could not find any information for the role '#{@custom_role}'."

data/app/views/admin/help/_regions.html.haml

@@ -0,0 +1,34 @@
+.Regions
+  %h2 Current Regions
+  %p Below is a list of editable regions from your installation of the application interface
+  - admin.instance_variables.sort.each do |reg|
+    .ui_region
+      %h3{:class => 'region_header'}= reg.to_s.gsub(/^@/,'').camelize
+      - region_instance = admin.send(:instance_variable_get, reg)
+      - if region_instance.respond_to?(:marshal_dump)
+        - unless region_instance.marshal_dump.blank?
+          %ul
+            - region_instance.marshal_dump.each do |key, value|
+              %li
+                %h4= key
+                - value_regions = value.send(:instance_variable_get, "@regions")
+                - unless value_regions.blank?
+                  %ul
+                    - value_regions.each do |vr_key, vr_value|
+                      %li
+                        = vr_key
+                        - unless vr_value.blank?
+                          %ul
+                            - vr_value.each do |endpoint|
+                              %li= endpoint
+      - else
+        - unless region_instance.blank?
+          %ul
+            - region_instance.each do |reg|
+              %li
+                %h4
+                  = reg.name
+                - reg.each do |r|
+                  %p
+                    = link_to r.name, r.url
+                    = "(#{r.url})"

data/app/views/admin/help/_scripts.js.erb

@@ -0,0 +1,14 @@
+document.observe('dom:loaded', function(){
+  $$('div.ui_region').each(function(element){
+    element.down('ul').hide();
+    element.observe('click',function(e){
+      this.down('ul').toggle();
+    });
+    element.observe('mouseover',function(e){
+      e.target.up('div.ui_region').addClassName('over');
+    });
+    element.observe('mouseout',function(e){
+      e.target.up('div.ui_region').removeClassName('over');
+    });
+  });
+})

data/app/views/admin/help/_styles.html.haml

@@ -0,0 +1,128 @@
+:sass
+  .region_header
+    padding: 3px
+  .ui_region
+    background: rgb(245, 241, 226)
+    padding: 0 0 10px
+    margin: 0 10px
+  .over
+    background: rgb(234, 227, 197)
+    cursor: hand
+    cursor: pointer
+  .Help
+    color: #222
+    font-size: 16px
+    overflow: hidden
+    min-width: 900px
+    .HelpNav
+      background: rgb(245, 241, 226)
+      border: 1px solid rgb(234, 227, 197)
+      margin: 0 0 12px 0
+      padding: 5px 0
+      p
+        margin: 0
+        padding: 0
+      a
+        color: #000
+        line-height: 1.8
+        margin: 0 -4px 0 1px
+        padding: 9px 10px
+        text-decoration: none
+      a:hover
+        color: #000
+        background: #fff
+    .Extras
+      float: right
+      margin-top: 40px
+      padding-bottom: 10px
+      width: 38%
+      .Docs, .Regions
+        background: rgb(245, 241, 226)
+        border-bottom: 2px solid rgb(234, 227, 197)
+        margin: 0
+        *
+          margin: 0 10px 4px 10px
+        * *
+          margin: 0
+        h2
+          background: rgb(234, 227, 197)
+          color: #000
+          font-weight: normal
+          margin: 0 0 5px 0
+          padding: 2px 5px
+        .over
+          background: rgb(234, 227, 197)
+      p, li
+        color: #333
+        line-height: 1.3
+        margin: 0 10px 10px 0
+    .MainTopics
+      float: left
+      margin: 0 0 0 8px
+      width: 60%
+      min-height: 300px
+      h1
+        margin-bottom: 12px
+      h2
+        border-bottom: 4px solid #444
+        font-weight: normal
+        font-size: 1.4em
+        margin: 24px 0 6px 0
+        padding: 2px 2px 6px 0
+      h3
+        color: #222
+        font-size: 1.1em
+        margin: 6px 0 6px 0
+      h4
+        color: #222
+        font-size: 0.95em
+        margin: 3px 0 3px 0
+        padding: 3px 0
+      p, li
+        color: #444
+        line-height: 1.4
+        margin: 0 0 6px 10px
+      ul, ol
+        margin: 0 0 0 20px
+      ul
+        margin: 0 0 0 20px
+        list-style: square
+      ol
+        margin: 0 0 0 28px
+        list-style-type: decimal
+      code
+        background: #eee
+        color: #222
+        line-height: inherit
+        padding: 4px 2px
+      pre
+        background: #eee
+        color: #222
+        line-height: 1.4
+        margin: 16px 0 16px 0
+        padding: 12px 0 12px 12px
+        width: 99%
+        white-space: pre-wrap
+        word-wrap: break-word
+  @media print
+    #header, #footer, .HelpNav, .Extras, hr
+      display: none
+    #footer
+      display: none
+    .MainTopics
+      min-width: 90%
+    body
+      background:-color white
+      font-family: "Cambria", "Hoefler Text", "Georgia", "Times New Roman", times, serif
+      font-size: 12pt
+    a:link:after, a:visited:after
+      color: #222
+      content: " : " attr(href) ""
+      font-size: 9pt
+      font-weight: normal
+  div.popup
+    border: none
+    .reference
+      border: none
+      width: 50em
+      height: 100%

data/app/views/admin/help/_tag_reference.html.haml

@@ -0,0 +1,6 @@
+.reference
+  .tag_description
+    %h4= "<r:#{tag_name} />"
+    %div= description
+    %p= "Available on #{classes.map{|c| c.titleize.gsub(/ Page$/, '')}.sort.to_sentence}."
+    .Additions= render_region tag_name

data/app/views/admin/help/developing.html.haml

@@ -0,0 +1,19 @@
+- content_for :page_css do
+  = render :partial => 'styles.html.haml'
+- content_for :page_scripts do
+  = render :partial => 'scripts.js.erb'
+  
+.Help
+  .MainTopics
+    - render_region :regions do |shard|
+      - shard.regions_introduction do
+        %h2 Altering Regions
+        %p Listed below are the main regions that may be altered with 'partial' injection. You may inject partials into the interface by adding code such this into your extension's activate method:
+        %pre admin.help.index.add :main, "client_welcome", :before => "introduction"
+        %ul
+          %li "admin.help.index" refers to the main help page (the help index) and ".add" is called to add information to the section provided in the next argument. 
+          %li ":main" is the argument that specifies which section will receive your partial. 
+          %li "client_welcome" is the partial that you want to add and should be located in your extension directory app/views/admin/help/_client_welcome.html.haml
+          %li :before => "introduction" will place your partial before the introduction region (or you could do :after). This is optional, and if left out, your partial will be appended to the ":main" section.
+      - shard.regions_map do
+        = render 'regions'

data/app/views/admin/help/extension_doc.html.haml

@@ -0,0 +1,16 @@
+- content_for :page_css do
+  = render :partial => 'styles.html.haml'
+- content_for :page_scripts do
+  = render :partial => 'scripts.js.erb'
+
+.Help
+  .MainTopics
+    - unless @doc.blank?
+      %h1= "#{@doc_name} Extension"
+      - if @doc_path
+        = @doc
+      - else
+        %p= "Sorry. We couldn't find information about the #{@doc_name} Extension#{' for the role: ' + @role unless @role.to_s == 'all'}."
+  .Extras 
+    - render_region :extras do |extras|
+      - extras.render_region :extension_docs_list 

data/app/views/admin/help/index.html.haml

@@ -0,0 +1,16 @@
+- content_for :page_css do
+  = render :partial => 'styles.html.haml'
+- content_for :page_scripts do
+  = render :partial => 'scripts.js.erb'
+
+.Help
+  .MainTopics
+    %h1= @cms_name + " Help"
+    - render_region :main do |main|
+      - main.introduction do
+        %p Use this reference to help guide your way through editing your website.
+      - main.render_region :organizing
+      - main.render_region :editing
+  .Extras
+    - render_region :extras do |extras|
+      - extras.render_region :extension_docs_list 

data/app/views/admin/help/role.html.haml

@@ -0,0 +1,12 @@
+- content_for :page_css do
+  = render :partial => 'styles.html.haml'
+- content_for :page_scripts do
+  = render :partial => 'scripts.js.erb'
+
+.Help
+  .MainTopics
+    %h1= "#{(@custom_role || @role).titleize} Help"
+    = render :partial => "#{@role}_index"
+  .Extras 
+    - render_region :extras do |extras|
+      - extras.render_region :extension_docs_list 

data/config/initializers/radiant_config.rb

@@ -0,0 +1,3 @@
+Radiant.config do |config|
+  # config.define "setting.name", :default => 'value', :select_from => ['foo', 'bar']
+end

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+---
+en:
+  help: Help

data/config/routes.rb

@@ -0,0 +1,8 @@
+ActionController::Routing::Routes.draw do |map|
+  map.with_options :controller => 'admin/help', :conditions => {:method => :get} do |help|
+    help.developing 'admin/help/developing', :action => 'developing'
+    help.help_role 'admin/help/role/:role', :action => 'role', :role => nil
+    help.help_extension_doc 'admin/help/extension/:extension_name/:role', :action => 'extension_doc', :extension_name => 'all', :role => 'all'
+    help.help 'admin/help', :action => 'index'
+  end
+end

data/cucumber.yml

@@ -0,0 +1 @@
+default: --format progress features --tags ~@proposed,~@in_progress

data/features/support/env.rb

@@ -0,0 +1,11 @@
+# Sets up the Rails environment for Cucumber
+ENV["RAILS_ENV"] = "test"
+# Extension root
+extension_env = File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
+require extension_env+'.rb'
+
+Dir.glob(File.join(RADIANT_ROOT, "features", "**", "*.rb")).each {|step| require step unless step =~ /datasets_loader\.rb$/}
+ 
+Cucumber::Rails::World.class_eval do
+  dataset :help
+end

data/features/support/paths.rb

@@ -0,0 +1,22 @@
+module NavigationHelpers
+  
+  # Extend the standard PathMatchers with your own paths
+  # to be used in your features.
+  # 
+  # The keys and values here may be used in your standard web steps
+  # Using:
+  #
+  #   When I go to the "help" admin page
+  # 
+  # would direct the request to the path you provide in the value:
+  # 
+  #   admin_help_path
+  # 
+  PathMatchers = {} unless defined?(PathMatchers)
+  PathMatchers.merge!({
+    # /help/i => 'admin_help_path'
+  })
+  
+end
+
+World(NavigationHelpers)

data/help_extension.rb

@@ -0,0 +1,86 @@
+# Uncomment this if you reference any of your controllers in activate
+require_dependency 'application_controller'
+# You'll need this if you are going to add regions into your extension interface.
+require 'ostruct'
+# These are needed for parsing the HELP.rdoc files
+require 'rdoc/markup/simple_markup'
+require 'rdoc/markup/simple_markup/to_html'
+
+class HelpExtension < Radiant::Extension
+  version RadiantHelpExtension::VERSION
+  description RadiantHelpExtension::DESCRIPTION
+  url RadiantHelpExtension::URL
+  
+  def activate
+    # This adds a tab to the interface after the Layouts tab, and allows all users to access it.
+    tab 'Help' do
+      add_item('Editing', '/admin/help')
+      add_item('Designing', '/admin/help/role/designer')
+      add_item('Administering', '/admin/help/role/admin')
+      if Rails.env.development?
+        add_item('Developing', '/admin/help/developing')
+      end
+      add_item('Extensions', '/admin/help/extension')
+    end
+    # The old way of doing it prior to Radiant 0.9: it now adds a NavSubItem to the "Content" NavTab (e.g. in line with "Pages")
+    # admin.tabs.add "Help", "/admin/help", :after => "Layouts", :visibility => [:all]
+    
+    # This adds information to the Radiant interface. In this extension, we're dealing with "help" views
+    # so :help is an attr_accessor. If you're creating an extension for tracking moons and stars, you might
+    # put attr_accessor :moon, :star
+    Radiant::AdminUI.class_eval do
+      attr_accessor :help
+    end
+    
+    # initialize regions for help (which we created above)
+    admin.help = load_default_help_regions
+    
+    # Provide the ability to replace regions...
+    # Don't like how the regions are setup? Hack it without changing this extension's code
+    # Be forewarned, this allows you to completely change the UI
+    Radiant::AdminUI::RegionSet.class_eval do
+      def replace(region=nil, partial=nil)
+        raise ArgumentError, "You must specify a region and a partial" unless region and partial
+        self[region].replace([partial])
+      end
+    end
+    # You could, for example create your own role based interface with this
+    # admin.help.main.replace('main','main_for_admins_only')
+    # But I only threw this in here to allow you to change the help docs easily if you want.
+    # I am merely providing the rope...
+    
+    # Finally, allow all the helpers to be used anywhere
+    ApplicationController.class_eval {
+      helper Admin::HelpHelper
+    }
+  end
+
+  private
+  
+  # This is where we define all of the regions to be used in the views and partials
+  def load_default_help_regions
+    OpenStruct.new.tap do |help|
+      help.index = Radiant::AdminUI::RegionSet.new do |index|
+        index.main.concat %w{introduction organizing editing}
+        index.page_details.concat %w{page_details_introduction slug breadcrumb}
+        index.filter.concat %w{filter_basics}
+        index.available_tags.concat %w{available_tags_basics}
+        index.layout.concat %w{layout_basics}
+        index.page_type.concat %w{page_type_basics}
+        index.saving.concat %w{saving_basics}
+        index.extras.concat %w{extension_docs_list}
+      end
+      help.role = Radiant::AdminUI::RegionSet.new do |role|
+        role.extras.concat %w{extension_docs_list}
+        role.regions.concat %w{regions_introduction}
+      end
+      help.extension_doc = Radiant::AdminUI::RegionSet.new do |extension_doc|
+        extension_doc.extras.concat %w{extension_docs_list}
+      end
+      help.developing = Radiant::AdminUI::RegionSet.new do |developing|
+        developing.regions.concat %w{regions_introduction regions_map}
+      end
+    end
+  end
+  
+end

data/lib/radiant-help-extension.rb

@@ -0,0 +1,8 @@
+module RadiantHelpExtension
+  VERSION     = "1.1.0"
+  SUMMARY     = "Help for Radiant CMS"
+  DESCRIPTION = "Help Documentation for Radiant CMS!"
+  URL         = "https://github.com/saturnflyer/radiant-help-extension"
+  AUTHORS     = ["Jim Gay"]
+  EMAIL       = ["jim@saturnflyer.com"]
+end

data/lib/tasks/help_extension_tasks.rake

@@ -0,0 +1,29 @@
+namespace :radiant do
+  desc "Shows some help information"
+  task :help do
+    puts %{
+  Finding help for Radiant
+  ========================
+  The Help extension that you have installed in vendor/extensions 
+  provides information about using Radiant.
+  
+  If you need some help with your installation, try joining the 
+  Radiant email lists and ask your questions there. For information 
+  visit http://radiantcms.org/mailing-list/
+
+  You may also find help from the Radiant community in the 
+  #radiantcms IRC channel on irc.freenode.net
+  
+  Lastly, checkout the companies listed at 
+  http://wiki.radiantcms.org/Radiant_Pros
+  
+  Extensions
+  ==========
+  You may find other extensions at http://ext.radiantcms.org
+  
+  To install them (with Radiant version 0.6.9 or later) you may
+  run 'script/extension install the_extension_name'. And if you'd 
+  like more information, try 'script/extension help'
+    }
+  end
+end