app/views/manual/manual_subsection.dryml
@@ -6,4 +6,5 @@ vendor/plugins/footnotes-edge
tmtags
app/views/taglibs/auto
public/img/*
+manual/generators/*.markdown
.gitignore
@@ -1,28 +1,56 @@
class ManualController < ApplicationController
caches_page :index, :manual_section, :manual_subsection
+
+ def self.create_ordered_hash(llist)
+ hash = ActiveSupport::OrderedHash.new
+ llist.each do |key, value|
+ hash[key] = value
+ end
+ hash
+ end
- TITLES = begin
- titles = ActiveSupport::OrderedHash.new
- [['to-do', "To Do List"],
- ['dryml-guide', "The DRYML Guide"],
- ['permissions', "The Permission System"],
- ['controllers', "Controllers and Routing"],
- ['lifecycles', 'Lifecycles'],
- ['viewhints', 'View Hints'],
- ['scopes', 'Automatic Named Scopes'],
- ['hobosupport', 'Hobo Support'],
- ['hobofields', 'Hobo Fields']
- ].each do |title, desc|
- titles[title] = desc
- end
- titles
- end
-
+ TITLES = self.create_ordered_hash([['to-do', "To Do List"],
+ ['dryml-guide', "The DRYML Guide"],
+ ['permissions', "The Permission System"],
+ ['controllers', "Controllers and Routing"],
+ ['lifecycles', 'Lifecycles'],
+ ['viewhints', 'View Hints'],
+ ['scopes', 'Automatic Named Scopes'],
+ ['hobosupport', 'Hobo Support'],
+ ['hobofields', 'Hobo Fields'],
+ ['generators', 'Generators'],
+ ])
+
+ SUBTITLES = {
+ 'hobofields' => self.create_ordered_hash([['rich_types', 'Rich Types'],
+ ['hobofields_api', 'API'],
+ ['migration_generator','Migration Generator']]),
+ 'hobosupport' => self.create_ordered_hash([['enumerable', 'Enumerable'],
+ ['hash', 'Hash'],
+ ['implies', 'Implies'],
+ ['metaid', 'Metaid'],
+ ['methodphitamine', 'Methodphitamine'],
+ ['module', 'Module']]),
+ 'generators' => self.create_ordered_hash([['hobo', 'hobo'],
+ ['hobo_rapid', 'hobo_rapid'],
+ ['hobo_model', 'hobo_model'],
+ ['hobo_model_controller', 'hobo_model_controller'],
+ ['hobo_model_resource', 'hobo_model_resource'],
+ ['hobo_front_controller', 'hobo_front_controller'],
+ ['hobo_user_model', 'hobo_user_model'],
+ ['hobo_user_controller', 'hobo_user_controller'],
+ ['hobo_subsite', 'hobo_subsite'],
+ ['hobo_admin_site', 'hobo_admin_site'],
+ ['hobofield_model', 'hobofield_model'],
+ ['hobo_migration', 'hobo_migration']])
+ }
+
def manual_section
section = params[:section].gsub(/[^a-z_\-]/, '')
filename = "manual/#{section}.markdown"
@title = TITLES[section]
+ @subtitles = SUBTITLES[section]
@content = HoboFields::MarkdownString.new(File.read("#{RAILS_ROOT}/#{filename}"))
@last_update = last_update filename
end
@@ -32,6 +60,8 @@ class ManualController < ApplicationController
subsection = params[:subsection].gsub(/[^a-z_\-]/, '')
filename = "manual/#{section}/#{subsection}.markdown"
@title = TITLES[section]
+ @subtitles = SUBTITLES[section]
+ @current_subtitle = SUBTITLES[section][subsection]
@content = HoboFields::MarkdownString.new(File.read("#{RAILS_ROOT}/#{filename}"))
@last_update = last_update filename
end
app/controllers/manual_controller.rb
@@ -2,7 +2,7 @@
<body: class="manual"/>
<aside-content:>
- <left-navigation with="&ManualController::TITLES" title="Manual" url="#{base_url}/manual" current="&@title" />
+ <left-navigation with="&ManualController::TITLES" title="Manual" url="#{base_url}/manual" current="&@title" subtitles="&@subtitles" />
</aside-content:>
<content:>
app/views/manual/manual_section.dryml
@@ -246,11 +246,19 @@
</def>
-<def tag="left-navigation" attrs="current, title, url">
+<def tag="left-navigation" attrs="current, title, subtitles, current-subtitle, url">
<h2><a href="&url"><%= title %></a></h2>
<navigation current="¤t">
<repeat>
<nav-item href="#{url}/#{this_key}"><%= this %></nav-item>
+ <ul if="¤t == this">
+ <% current_title = this_key -%>
+ <repeat with="&subtitles">
+ <li class="#{'current' if this==current_subtitle}">
+ <a href="#{url}/#{current_title}/#{this_key}"><%= this %></a>
+ </li>
+ </repeat>
+ </ul>
</repeat>
</navigation>
</def>
app/views/taglibs/application.dryml
@@ -15,6 +15,19 @@ namespace :cookbook do
end
end
+ desc "Rebuild generator documentation"
+ task :rebuild_generator_docs => :environment do
+ ManualController::SUBTITLES['generators'].each do |gen, title|
+ raw = `#{RAILS_ROOT}/script/generate #{gen} --help`
+ out = "Generators -- #{title.gsub('_', '\_')}\n{: .document-title}\n\n" +
+ raw.gsub(/^(\w(\w|\s)*):(.*)/) {|s| "\n## #{$1}\n\n #{$3}\n"}.
+ gsub("/work/hobocookbook", ".")
+ open("#{RAILS_ROOT}/manual/generators/#{gen}.markdown", "w") do |f|
+ f.write(out)
+ end
+ end
+ end
+
desc "git pull all plugins/submodules (except for non-Hobo project)"
task :pull_all => :environment do
['vendor/plugins/paperclip_with_hobo', 'vendor/plugins/hobo', 'public/patches/agility', 'taglibs/hoboyui', 'taglibs/hobo-contrib', 'taglibs/hobo-jquery'].each {|sub|
@@ -24,7 +37,7 @@ namespace :cookbook do
end
desc "do all update tasks"
- task :update => [:environment, :pull_all, :load_api_docs, :rebuild_agility] do
+ task :update => [:environment, :pull_all, :load_api_docs, :rebuild_agility, :rebuild_generator_docs] do
true
end
end
lib/tasks/cookbook.rake
app/views/manual/manual_subsection.dryml
509492b8aaa0dba487c065899d3fda5684f89bf1
Bryan Larsen
bryan@larsen.st
http://github.com/tablatom/hobocookbook/commit/a629151635dda01667540eba93a8b4ecb5ca9df2
a629151635dda01667540eba93a8b4ecb5ca9df2
2009-10-23T13:18:15-07:00
2009-10-23T13:18:15-07:00
create a Generators section in the manual.
f9338f5b9af07af3b0f0a03edb3766de25766492
Bryan Larsen
bryan@larsen.st