@@ -1,12 +1,10 @@ = Help -This extension provides documentation for Radiant and any registered 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 and: +Installing Help is as easy as any other Radiant extension. Drop it into your vendor/extensions directory. -rake radiant:extensions:help:migrate - -Once the extension is installed, you must ensure that your application will load the Help extension before loading any registered extensions. 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| ... @@ -14,7 +12,7 @@ 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 RDoc help files may be found at /admin/help_extension/:extension_name/:role but a list of links is automatically generated for your clicking pleasure. +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 README.rdoc @@ -1,2 +1,6 @@ -1. Add more regions -2. Read multiple types of docs (markdown, textile, rdoc, txt) \ No newline at end of file +1. Add images +2. Better styling +3. Javascript to hide/show features +4. Integrate full tag list search for developer view +5. Show README and TODO files to admins +6. Tests for the views! \ No newline at end of file TODO @@ -32,6 +32,7 @@ class Admin::HelpController < ApplicationController @role = params[:role].nil? ? 'all' : params[:role] @docs = HelpDoc.find_for(@role) @doc_name = params[:extension_name].titleize - @doc = HelpDoc.find_for(@role,params[:extension_name]).first + @doc_path = HelpDoc.find_for(@role,params[:extension_name]).first + @doc = HelpDoc.formatted_contents_from(@doc_path) end end \ No newline at end of file app/controllers/admin/help_controller.rb @@ -17,10 +17,9 @@ class HelpDoc end def self.formatted_contents_from(doc_path) - case doc_path - when /\.(markdown|md)$/.match(doc_path) + if doc_path.end_with?('markdown') || doc_path.end_with?('md') HelpDoc.parsed_markdown(doc_path) - when /\.textile/.match(doc_path) + elsif doc_path.end_with?('textile') HelpDoc.parsed_textile(doc_path) else HelpDoc.parsed_rdoc(doc_path) app/models/help_doc.rb @@ -5,8 +5,8 @@ = render :partial => 'help_nav' .MainTopics %h1= "#{@doc_name} Extension" - - if @doc - = SM::SimpleMarkup.new.convert(File.read(@doc), SM::ToHtml.new) + - 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 app/views/admin/help/extension_doc.html.haml @@ -9,8 +9,11 @@ describe HelpDoc, "given existing extension docs" do File.open("#{@test_dir}/HELP", 'wb') {|f| f.write('help for all') } File.open("#{@test_dir}/HELP_developer.rdoc", 'wb') {|f| f.write('== Testing help for developers in rdoc') } - File.open("#{@test_dir}/HELP_admin.markdown", 'wb') {|f| f.write('help for admins in **markdown**') } - File.open("#{@test_dir}/HELP_imaginary.md", 'wb') {|f| f.write('help for non-existent role in **markdown**') } + File.open("#{@test_dir}/HELP_admin.markdown", 'wb') {|f| f.write('Test +---- +help for admins in **markdown**') } + File.open("#{@test_dir}/HELP_imaginary.md", 'wb') {|f| f.write('## Test +help for non-existent role in **markdown**') } File.open("#{@test_dir}/HELP_other.textile", 'wb') {|f| f.write('help for _another_ non-existent role in *textile*') } end @@ -71,17 +74,17 @@ help for developers in rdoc') } it "should return Markdown formatted contents of a given extension doc ending in '.markdown'" do test_doc = HelpDoc.find_for(:admin, @test_ext_name).first - HelpDoc.formatted_contents_from(test_doc).should == "\nhelp for admins in *markdown*\n\n" + HelpDoc.formatted_contents_from(test_doc).should == "<h2>Test</h2>\n\nhelp for admins in markdown" end it "should return Markdown formatted contents of a given extension doc ending in '.md'" do test_doc = HelpDoc.find_for(:imaginary, @test_ext_name).first - HelpDoc.formatted_contents_from(test_doc).should == "\nhelp for non-existent role in *markdown*\n\n" + HelpDoc.formatted_contents_from(test_doc).should == "<h2>Test</h2>\n\nhelp for non-existent role in markdown" end it "should return Textile formatted contents of a given extension doc ending in '.textile'" do test_doc = HelpDoc.find_for(:other, @test_ext_name).first - HelpDoc.formatted_contents_from(test_doc).should == "\nhelp for another non-existent role in textile\n\n" + HelpDoc.formatted_contents_from(test_doc).should == "help for another non-existent role in textile" end end @@ -93,7 +96,7 @@ help for developers in rdoc') } it "should call parsed_markdown and return HTML from Markdown formatted text" do test_doc = HelpDoc.find_for(:admin, @test_ext_name).first - HelpDoc.parsed_markdown(test_doc).should == "help for admins in markdown" + HelpDoc.parsed_markdown(test_doc).should == "<h2>Test</h2>\n\nhelp for admins in markdown" end it "should call parsed_textile and return HTML from Textile formatted text" do spec/models/help_doc_spec.rb b4494420e24aa90be1f958a7e3c53f0c6abf67b6 Jim Gay jim@saturnflyer.com http://github.com/saturnflyer/radiant-help-extension/commit/2a08719277b2b2afe8099bb10b7df32219cd7be9 2a08719277b2b2afe8099bb10b7df32219cd7be9

2008-07-14T20:34:20-07:00

corrected view hard-coded SimpleMarkup 7299df9e944a383128bf0747b738967959ca75e3 Jim Gay jim@saturnflyer.com