initial version of commands index using the related data

git · May 2, 2012 · 5bdcd37 · 5bdcd37
1 parent 5f8fa17
commit 5bdcd37
Show file tree

Hide file tree

Showing 7 changed files with 60 additions and 22 deletions.
diff --git a/TODO.txt b/TODO.txt
@@ -7,7 +7,8 @@ Initial Launch (3.0):
   * "admonition block" (eg. NOTE at the end of git-blame)
 
 * Book content
-  * commands.html
+  - remote fill
+  - commands.html
 
 * Sidebar related content
   - book sections

diff --git a/app/controllers/doc_controller.rb b/app/controllers/doc_controller.rb
@@ -74,6 +74,35 @@ def book_section
     @related = @content.get_related(8)
   end
 
+  CMD_GROUPS = [
+       ['Setup and Config', [ 'config', 'help' ]],
+       ['Getting and Creating Projects', [ 'init', 'clone']],
+       ['Basic Snapshotting', [ 'add', 'status', 'diff', 'commit', 'reset', 'rm', 'mv']],
+       ['Branching and Merging', [ 'branch', 'checkout', 'merge', 'mergetool', 'log', 'stash', 'tag' ]],
+       ['Sharing and Updating Projects', [ 'fetch', 'pull', 'push', 'remote', 'submodule' ]],
+       ['Inspection and Comparison', [ 'show', 'log', 'diff', 'shortlog', 'describe' ]],
+       ['Patching', ['am', 'apply', 'cherry-pick', 'rebase']],
+       ['Debugging', [ 'bisect', 'blame' ]],
+       ['Email', ['am', 'apply', 'format-patch', 'send-email', 'request-pull']],
+       ['External Sytems', ['svn', 'fast-import']],
+       ['Administration', [ 'gc', 'fsck', 'reflog', 'filter-branch', 'instaweb', 'archive' ]],
+       ['Server Admin', [ 'daemon', 'update-server-info' ]],
+  ]
+
+  # commands index
+  def commands
+    @related = {}
+    ri = RelatedItem.where(:content_type => 'reference', :related_type => 'book')
+    ri.each do |item|
+      cmd = item.name.gsub('git-', '')
+      if s = Section.where(:slug => item.related_id).first
+        @related[cmd] ||= []
+        @related[cmd] << [s.cs_number, s.slug, item.score]
+      end
+    end
+    @groups = CMD_GROUPS
+  end
+
   # so we can display urls old progit.org style
   def progit
     chapter = params[:chapter].to_i

diff --git a/app/views/doc/book.html.erb b/app/views/doc/book.html.erb
@@ -27,11 +27,9 @@
       </ol>
     </li>
   <% end %>
-  <!--
-    <li class='chapter'>
-      <h2><a href="#">Index of Commands</a></h2>
-    </li>
-  -->
+  <li class='chapter'>
+    <h2><a href="/book/commands">Index of Commands</a></h2>
+  </li>
   </ol>
 </div>
 
diff --git a/app/views/doc/commands.html.erb b/app/views/doc/commands.html.erb
@@ -0,0 +1,24 @@
+<% @section    = 'documentation' %>
+<% @subsection = 'book' %>
+
+<div id='main'>
+  <h1>Index of Commands</h1>
+  <table>
+  <% @groups.each do |title, commands| %>
+    <tr>
+      <td colspan="10"><h2><%= title %></h2></td>
+    </tr>
+    <% commands.each do |cmd| %>
+    <tr>
+      <th>&nbsp;</th>
+      <th><%= cmd %></th>
+      <% if @related[cmd] %>
+        <% @related[cmd].each do |number, slug, score| %>
+          <td nowrap><a href="/book/en/<%= slug %>"><%= number %></a>(<%= score %>)</td>
+        <% end %>
+      <% end %>
+    </tr>
+    <% end %>
+  <% end %>
+  </table>
+</div>
diff --git a/app/views/doc/index.html.haml b/app/views/doc/index.html.haml
@@ -60,7 +60,7 @@
                 = chapter.number.to_s + '.'
                 %a{:href=>"/book/#{@book.code}/#{chapter.sections.first.slug}"}= chapter.title
           %li.chapter
-            %h2 <a href="#">Index of Commands</a>
+            %h2 <a href="/book/commands">Index of Commands</a>
 
   %h2 Videos
 

diff --git a/config/routes.rb b/config/routes.rb
@@ -10,6 +10,7 @@
   match "/doc/ext" => "doc#ext"
 
   match "/book" => "doc#book"
+  match "/book/commands" => "doc#commands"
   match "/book/ch:chapter-:section.html" => "doc#progit"
   match "/book/:lang/ch:chapter-:section.html" => "doc#progit"
   match "/book/:lang" => "doc#book"

diff --git a/lib/tasks/related.rake b/lib/tasks/related.rake
@@ -19,21 +19,6 @@ CMD_IGNORE = ['aware', 'binaries', 'ci', 'co', 'com', 'directory', 'feature',
          'mygrit', 'project', 'prune', 'rack', 'repository', 'stash-unapply',
          'tarball', 'that', 'user', 'visual', 'will', 'world', 'unstage']
 
-CMD_GROUPS = [
-     ['Setup and Config', [ 'config', 'help' ]],
-     ['Getting and Creating Projects', [ 'init', 'clone']],
-     ['Basic Snapshotting', [ 'add', 'status', 'diff', 'commit', 'reset', 'rm', 'mv']],
-     ['Branching and Merging', [ 'branch', 'checkout', 'merge', 'mergetool', 'log', 'stash', 'tag' ]],
-     ['Sharing and Updating Projects', [ 'fetch', 'pull', 'push', 'remote', 'submodule' ]],
-     ['Inspection and Comparison', [ 'show', 'log', 'diff', 'shortlog', 'describe' ]],
-     ['Patching', ['am', 'apply', 'cherry-pick', 'rebase']],
-     ['Debugging', [ 'bisect', 'blame' ]],
-     ['Email', ['am', 'apply', 'format-patch', 'send-email', 'request-pull']],
-     ['External Sytems', ['svn', 'fast-import']],
-     ['Administration', [ 'gc', 'fsck', 'reflog', 'filter-branch', 'instaweb', 'archive' ]],
-     ['Server Admin', [ 'daemon', 'update-server-info' ]],
-]
-
 # book content
 #  - reference calls
 def find_book_links