erbook 7.3.0 → 8.0.0

data/lib/erbook.rb

@@ -9,8 +9,8 @@ require 'inochi'
 
 Inochi.init :ERBook,
   :program => 'erbook',
-  :version => '7.3.0',
-  :release => '2009-10-09',
+  :version => '8.0.0',
+  :release => '2009-10-10',
   :website => 'http://snk.tuxfamily.org/lib/erbook/',
   :tagline => 'Write books, manuals, and documents in eRuby',
   :require => {

data/lib/erbook/document.rb

@@ -83,44 +83,54 @@ module ERBook
           #
           def sandbox.__node_impl__ node_type, *node_args, &node_content
             node = Node.new(
-              :type     => node_type,
-              :defn     => @format['nodes'][node_type],
-              :args     => node_args,
-              :trace    => caller,
-              :children => []
+              :type       => node_type,
+              :definition => @format['nodes'][node_type],
+              :arguments  => node_args,
+              :backtrace  => caller,
+              :parent     => @stack.last,
+              :children   => []
             )
+
+            Array(node.definition['params']).each do |param|
+              break if node_args.empty?
+              node.__send__ "#{param}=", node_args.shift
+            end
+
             @nodes << node
             @nodes_by_type[node.type] << node
 
-            # calculate occurrence number for this node
-            if node.defn['number']
+            # calculate ordinal number for this node
+            if node.ordinal_number?
               @count_by_type ||= Hash.new {|h,k| h[k] = 0 }
-              node.number = (@count_by_type[node.type] += 1)
+              node.ordinal_number = (@count_by_type[node.type] += 1)
             end
 
             # assign node family
-            if parent = @stack.last
+            if parent = node.parent
               parent.children << node
               node.parent = parent
               node.depth = parent.depth
-              node.depth += 1 if node.defn['depth']
+              node.depth += 1 if node.anchor?
 
-              # calculate latex-style index number for this node
-              if node.defn['index']
-                ancestry = @stack.reverse.find {|n| n.defn['index'] }.index
-                branches = node.parent.children.select {|n| n.index }
+              # calculate section number for this node
+              if node.section_number?
+                ancestor = @stack.reverse.find {|n| n.section_number }
+                branches = parent.children.select {|n| n.section_number }
 
-                node.index = [ancestry, branches.length + 1].join('.')
+                node.section_number = [
+                  ancestor.section_number,
+                  branches.length + 1
+                ].join('.')
               end
             else
               @roots << node
               node.parent = nil
               node.depth = 0
 
-              # calculate latex-style index number for this node
-              if node.defn['index']
-                branches = @roots.select {|n| n.index }
-                node.index = (branches.length + 1).to_s
+              # calculate section number for this node
+              if node.section_number?
+                branches = @roots.select {|n| n.section_number }
+                node.section_number = (branches.length + 1).to_s
               end
             end
 
@@ -153,9 +163,7 @@ module ERBook
           @processed_document = template.buffer
 
         # chain block-level nodes together for local navigation
-          block_nodes = @nodes.reject do |n|
-            n.defn['bypass'] || n.defn['inline']
-          end
+          block_nodes = @nodes.select {|n| n.anchor? }
 
           require 'enumerator'
           block_nodes.each_cons(2) do |a, b|
@@ -179,16 +187,20 @@ module ERBook
             # calculate the output for this node
             actual_output = Template.new(
               "#{@format_file}:nodes:#{n.type}:output",
-              n.defn['output'].to_s.chomp
+              n.definition['output'].to_s.chomp
             ).render_with(@template_vars.merge(:@node => n))
 
             # reveal child nodes' actual output in this node's actual output
             n.children.each do |c|
-              if c.defn['inline'] && !c.defn['bypass']
+              if c.silent?
+                # this child's output is not meant to be revealed at this time
+                next
+
+              elsif c.inline?
                 actual_output[c.output] = actual_output_by_node[c]
 
               else
-                # pull block-level node out of paragraph tag added by Maruku
+                # pull block-level child out of paragraph tag added by Maruku
                 actual_output.sub! %r/(<p>\s*)?#{Regexp.quote c.output}/ do
                   actual_output_by_node[c] + $1.to_s
                 end
@@ -239,7 +251,31 @@ module ERBook
       # Returns the output of this node.
       #
       def to_s
-        defn['silent'] ? '' : output
+        if silent?
+          ''
+        else
+          output
+        end
+      end
+
+      def section_number?
+        Array(definition['number']).include? 'section'
+      end
+
+      def ordinal_number?
+        Array(definition['number']).include? 'ordinal'
+      end
+
+      def anchor?
+        not inline? and not silent?
+      end
+
+      def inline?
+        definition['inline']
+      end
+
+      def silent?
+        definition['silent']
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: erbook
 version: !ruby/object:Gem::Version 
-  version: 7.3.0
+  version: 8.0.0
 platform: ruby
 authors: 
 - Suraj N. Kurapati
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-09 00:00:00 -07:00
+date: 2009-10-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -82,9 +82,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "1"
     version: 
-description: "                           ERBook 7.3.0\n\n           Write books, manuals, and documents in eRuby\n\n               http://snk.tuxfamily.org/lib/erbook/\n\n   ERBook is an extensible document processor that emits [1]any\n   document you can imagine from [2]eRuby templates, which allow\n   scripting and dynamic content generation.\n\n\
-  Version 7.3.0 (2009-10-09)\n\n   This release improves the printer friendliness of the XHTML\n   format.\n\n     * [3]New features\n\n     * [4]Bug fixes\n\n     * [5]Housekeeping\n\n   New features\n\n     * Do not omit ERBook internals from node stack traces.\n\n     * Hide \"printer friendly\" toggle checkbox when printing\n       (but not when viewing the \"printer friendly\" mode on the\n       computer screen).\n\n     * Hide the \"About\" section in \"printer friendly\" mode.\n\n   Bug fixes\n\n     * Page scrolled to wrong location when links in the table\n       of contents in the \"printer friendly\" mode were clicked.\n\n     * Print style was not used when printing from \"printer\n       friendly\" mode.\n\n     * Sans-serif font was not used in headings in print style.\n\n   Housekeeping\n\n     * Use Ember syntax in [6]Input document for HelloWorld\n       format example.\n\n\
-  References\n\n   1. http://snk.tuxfamily.org/lib/erbook/#HelloWorld\n   2. http://en.wikipedia.org/wiki/ERuby\n   3. http://snk.tuxfamily.org/lib/erbook/#New-features\n   4. http://snk.tuxfamily.org/lib/erbook/#Bug-fixes\n   5. http://snk.tuxfamily.org/lib/erbook/#Housekeeping\n   6. http://snk.tuxfamily.org/lib/erbook/#HelloWorld-input\n"
+description: "                           ERBook 8.0.0\n\n           Write books, manuals, and documents in eRuby\n\n               http://snk.tuxfamily.org/lib/erbook/\n\n   ERBook is an extensible document processor that emits [1]any\n   document you can imagine from [2]eRuby templates, which allow\n   scripting and dynamic content generation.\n\n\
+  Version 8.0.0 (2009-10-10)\n\n   This release simplifies [3]node definitions, adds [4]Table\n   nodes for building tables the HTML way, and introduces\n   [5]Arbitrary floats to combat the [6]explosion of\n   special-purpose document nodes.\n\n     * [7]Incompatible changes\n\n     * [8]New features\n\n     * [9]Housekeeping\n\n   Incompatible changes\n\n     * Reduce and rename [10]node definitions attributes:\n          + toc: true -> index: tree\n          + lof: true -> index: list\n          + index: true -> number: section\n          + number: true -> number: ordinal\n          + depth: true -> (removed)\n          + bypass: true -> (removed)\n\n     * Rename [11]The ERBook::Document::Node class properties to\n       be more self-documenting:\n          + args -> arguments\n          + defn -> definition\n          + trace -> backtrace\n          + index -> section_number\n          + number -> ordinal_number\n\n     * Replace formal blocks (figure, table, example, equation,\n       procedure) with [12]Arbitrary floats.\n\n     * Append an exclamation mark (!) to the names of\n       [13]Admonition nodes, thereby making them a special case\n       of [14]Arbitrary floats.\n\n   New features\n\n     * Add \"params\" attribute to [15]node definitions.\n\n     * Add [16]Table nodes for building tables the HTML way.\n\n   Housekeeping\n\n     * Use YAML hash merging to DRY node definitions in XHTML\n       format.\n\n     * Use [17]Table nodes instead of PHP Markdown Extra table\n       syntax in the user manual.\n\n     * Remove the \"digest\" [18]Node definition attribute from\n       the user manual. Its use was discontinued a few major\n       versions ago.\n\n\
+  References\n\n   1. http://snk.tuxfamily.org/lib/erbook/#HelloWorld\n   2. http://en.wikipedia.org/wiki/ERuby\n   3. http://snk.tuxfamily.org/lib/erbook/#SpecFile-nodes\n   4. http://snk.tuxfamily.org/lib/erbook/#Table-nodes\n   5. http://snk.tuxfamily.org/lib/erbook/#Arbitrary-floats\n   6. http://www.docbook.org/tdg/en/html/part2.html\n   7. http://snk.tuxfamily.org/lib/erbook/#Incompatible-changes\n   8. http://snk.tuxfamily.org/lib/erbook/#New-features\n   9. http://snk.tuxfamily.org/lib/erbook/#Housekeeping\n  10. http://snk.tuxfamily.org/lib/erbook/#SpecFile-nodes\n  11. http://snk.tuxfamily.org/lib/erbook/#Node-class\n  12. http://snk.tuxfamily.org/lib/erbook/#Arbitrary-floats\n  13. http://snk.tuxfamily.org/lib/erbook/#Admonition-nodes\n  14. http://snk.tuxfamily.org/lib/erbook/#Arbitrary-floats\n  15. http://snk.tuxfamily.org/lib/erbook/#SpecFile-nodes\n  16. http://snk.tuxfamily.org/lib/erbook/#Table-nodes\n  17. http://snk.tuxfamily.org/lib/erbook/#Table-nodes\n  18. http://snk.tuxfamily.org/lib/erbook/#SpecFile-nodes\n"
 email: sunaku@gmail.com
 executables: 
 - erbook