doc_proxy.rb in ruby-vpi-16.0.0

- old
+ new

@@ -1,33 +1,19 @@
-=begin
-  Copyright 2006 Suraj N. Kurapati
+#--
+# Copyright 2006 Suraj N. Kurapati
+# See the file named LICENSE for details.
 
-  This file is part of Ruby-VPI.
-
-  Ruby-VPI is free software; you can redistribute it and/or
-  modify it under the terms of the GNU General Public License
-  as published by the Free Software Foundation; either version 2
-  of the License, or (at your option) any later version.
-
-  Ruby-VPI is distributed in the hope that it will be useful,
-  but WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-  GNU General Public License for more details.
-
-  You should have received a copy of the GNU General Public License
-  along with Ruby-VPI; if not, write to the Free Software Foundation,
-  Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-=end
-
 require 'erb_proxy'
+require 'doc_format'
 
-# Processes ERB templates to produce documentation. Templates may contain "<xref...>" tags where the ... represents the target anchor of the cross-reference.
+# Processes ERB templates to produce documentation. Templates may contain
+# "<xref...>" tags where the ... represents the target anchor of the
+# cross-reference.
 class DocProxy < ErbProxy
   Block = Struct.new :anchor, :title, :type
   Heading = Struct.new :anchor, :title, :depth, :index
   Index = Struct.new :name, :items
-  @@anchorNum = 0
 
   CATEGORIES = {
     :admonition => [:tip, :note, :important, :caution, :warning],
 
     # formal blocks; see http://www.sagehill.net/docbookxsl/FormalTitles.html
@@ -44,11 +30,11 @@
     @indexes = Hash.new {|h,k| h[k] = []}
 
     CATEGORIES[:admonition].each do |type|
       add_block_handler :admonition, type do |index, title, text|
         join_redcloth_elements [
-          %{!<images/#{type}.png(#{type})!},
+          %{!<images/tango/#{type}.png(#{type})!},
           %{p(title). #{type.to_s.capitalize}: #{title}},
           text,
         ]
       end
     end
@@ -61,65 +47,32 @@
         ]
       end
     end
   end
 
-  # Post-processes the given ERB template result by parsing the document structure and expanding cross-references, and returns the result.
-  def post_process! aResult
-    buffer = aResult
+  # Post-processes the given ERB template result by parsing the document
+  # structure and expanding cross-references, and returns the result.
+  def post_process aResult
+    text = aResult.to_html
+    anchors = []
 
-    # parse document structure and insert anchors (so that the table of contents can link directly to these headings) where necessary
-      buffer.gsub! %r{^(\s*h(\d))(.*)$} do
-        head, depth, rest = $1, $2.to_i, $3
-
-        # parse title and class attributes
-          rest =~ /^([\{\(\[].*?[\]\)\}])?\.(.*)$/
-          atts, title = $1, $2.strip
-
-        # put heading index in title
-          prevDepth = @headings.last.depth rescue 0
-          prevIndex = @headings.last.index rescue ""
-          depthDiff = (depth - prevDepth).abs
-
-          index =
-            if depth > prevDepth
-              s = prevIndex + ('.1' * depthDiff)
-              s.sub /^\./, ''
-
-            elsif depth < prevDepth
-              s = prevIndex.sub /(\.\d+){#{depthDiff}}$/, ''
-              s.next
-
-            else
-              prevIndex.next
-            end
-
-          rest = "#{atts}. #{index} &nbsp; #{title}"
-
-        # parse and insert anchor if necessary
-          if atts =~ /#(.*?)\)/
-            anchor = $1
-          else
-            anchor = "anchor#{@@anchorNum += 1}"
-            rest.insert 0, "(##{anchor})"
-          end
-
+    # parse document structure and insert anchors (so that the table of contents
+    # can link directly to these headings) where necessary
+      toc, text = text.table_of_contents do |title, anchor, index, depth, atts|
         @headings << Heading.new(anchor, title, depth, index)
         @blocks[:section] << Block.new(anchor, title, :section)
-
-        head + rest
       end
 
     # expand cross-references into links to their targets
       blocks = @blocks.values.flatten
 
-      buffer.gsub! %r{<xref\s*(.+?)\s*/?>} do
+      text.gsub! %r{<xref\s*(.+?)\s*/?>} do
         anchor = unanchor($1)
         target = blocks.find {|b| b.anchor == anchor}
 
         if target
-          %{"the #{target.type} named &ldquo;#{target.title}&rdquo;":##{target.anchor}}
+          %{<a href="##{target.anchor}">the #{target.type} named &ldquo;#{target.title}&rdquo;</a>}
         else
           warn "unresolved cross-reference to #{anchor}"
           %{"#{anchor}":##{anchor}}
         end
       end
@@ -136,18 +89,23 @@
             @indexes[category] << Index.new(name, items)
           end
         end
       end
 
-    buffer
+    [toc, text]
   end
 
-  # Adds a block handler for the given type of block and outputs the result in a <div> whose CSS class is the given category.
-  # The arguments for the block handler are:
+  # Adds a block handler for the given type of block and outputs the result in a
+  # <div> whose CSS class is the given category. The arguments for the block
+  # handler are:
+  #
   # 1. number of the block
+  #
   # 2. title of the block
+  #
   # 3. content of the block
+  #
   def add_block_handler aCategory, aType
     raise ArgumentError unless block_given?
 
     add_handler aType do |buf, text, title, anchor|
       index = @blocks[aType].length + 1
@@ -173,10 +131,11 @@
     end
   end
 
   private
 
-  # Joins the given elements by putting enough white-space between them so that RedCloth knows they're different elements.
+  # Joins the given elements by putting enough white-space between them so that
+  # RedCloth knows they're different elements.
   def join_redcloth_elements *args
     args.join("\n\n\n") << "\n\n\n"
   end
 
   # Removes the # from a HTML anchor so that only its name is preserved.