.gitignore app/views/admin/help/_editing.html.haml app/views/admin/help/_introduction.html.haml app/views/admin/help/_organizing.html.haml @@ -16,7 +16,11 @@ end == Extensions using Help -If you're building an extension that takes advantage of Help, you can register your help information in the database. +If you're building an extension that takes advantage of Help, there are 2 ways to provide help to your users: database registered help, and partial injection based help. + +=== Database Registered Help + +Registering your help documentation in the database presents your information in a list of "Additional Features." You can register your help information in the database with: HelpfulExtension.register() @@ -33,4 +37,17 @@ You may unregister your extension (thereby deleting all help information in the HelpfulExtension.unregister('Featured_Pages') +=== Partial Injection Based Help + +You may inject partials into the interface by adding code such this into your extension's activate method: + + admin.help.index.add :main, "client_welcome", :before => "introduction" + +* "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. +* ":main" is the argument that specifies which section will receive your partial. +* "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 +* :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. + +For a list of all of the regions provided by Help, see help_extension.rb around line 36. + Built by Saturn Flyer http://www.saturnflyer.com \ No newline at end of file README @@ -1,77 +1,42 @@ - content_for :page_css do :sass .Help - overflow: hidden - min-width: 900px + :overflow hidden + :min-width 900px .Extensions - background: #eee - float: right - width: 38% + :background #eee + :float right + :width 38% * - margin: 0 10px + :margin 0 10px * * - margin: 0 + :margin 0 .MainTopics - float: left - width: 60% + :float left + :width 60% * - margin: 0 + :margin 0 h2 - font-size: 1.4em + :font-size 1.4em h3 - margin-bottom: 10px + :margin-bottom 10px h4 - color: #666 - border-bottom: 1px solid #666 - padding-bottom: 2px + :color #666 + :border-bottom 1px solid #666 + :padding-bottom 2px p - color: #333 - margin: 0 0 10px - ol - list-style-position: inside - padding: 0 - margin: 0 - li - list-style: none - margin: 0 - padding: 0 - back + :color #333 + :margin 0 0 10px %h1 = Radiant::Config['admin.title'] + " Help" .Help - .MainTopics - %h2 The Basics - %ol - %li - %h3 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. - %li - %h3 Editing Pages - %ol - %li - %h4 Page Details - %p Each page has information that is used when your pages are generated. When you type your Page Title, the page Slug and Breadcrumb are automatically typed for you (click the 'More' link below the title to see these details). The slug is arguably the most important of these because it determines where your page will be found when visitors browse your website. - %h5 What is the Slug? - %p It's the smallest part of the page URL. - %p If you want your "About Us" page to be found in a location such as yoursite.com/about, then the Slug for your "About Us" page is "about". - %p Likewise, if the "About Us" page has any children, such as a "Management Team" page, then the location of that page might be yoursite.com/about/management-team. In this case, the Slug for the "Management Team" page is "management-team". - %h5 Why do I need a Slug? - %p You may not want to make changes to it, but if you do you may make your "About Us" page available at yoursite.com/about or yoursite.com/about-us or yoursite.com/allaboutus... It's up to you. - %h5 Breadcrumb - %p Breadcrumbs trace your path from the home page to where your are. If you're on the "Management Team" page, for example, your breadcrumbs might look like this: Home > About Us > Management Team - %p The Breadcrumb field allows you to edit the text that will be displayed if and when your website uses breadcrumbs. - %li - %h4 Filter - %li - %h4 Available Tags - %li - %h4 Layout - %li - %h4 Page Type - %li - %h4 Status + - render_region :main do |main| + = main.render_region :introduction + .MainTopics + = main.render_region :organizing + = main.render_region :editing + - unless @extensions.blank? .Extensions %h2 Additional Features @@ -79,10 +44,4 @@ %h3 = link_to e.name, (help_url() + '/' + e.name) = render :partial => 'details', :locals => {:extension => e} - -:javascript - var setup = function(){ - - } - Event.observe(window, 'load', setup); \ No newline at end of file app/views/admin/help/index.html.haml @@ -1,5 +1,7 @@ # Uncomment this if you reference any of your controllers in activate require_dependency 'application' +# You'll need this if you are going to add regions into your extension interface. +require 'ostruct' class HelpExtension < Radiant::Extension version "1.0" @@ -15,10 +17,32 @@ class HelpExtension < Radiant::Extension def activate 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 end def deactivate - # admin.tabs.remove "Help" + end + + private + + # This is where we define all of the regions to be used in the views and partials + def load_default_help_regions + returning OpenStruct.new do |help| + help.index = Radiant::AdminUI::RegionSet.new do |index| + index.main.concat %w{introduction organizing editing} + end + help.show = Radiant::AdminUI::RegionSet.new do |show| + # show. + end + end end end \ No newline at end of file help_extension.rb f0f3155288d89d41aea2512f4dfb2e9e87a96d31 Jim Gay jim@saturnflyer.com http://github.com/saturnflyer/radiant-help-extension/commit/230b9c7a52c3bb9ac827579328ee4cff594d8771 230b9c7a52c3bb9ac827579328ee4cff594d8771 2008-06-12T20:54:25-07:00 2008-06-12T20:54:25-07:00 adding in editable regions, updated README 44fb24b3042f64dbebda96f154bcdf53f674a427 Jim Gay jim@saturnflyer.com