erbook 7.3.0 → 8.0.0

data/doc/usage.erb

@@ -24,7 +24,7 @@
       In the above example, *YOUR\_PATH\_HERE* is the path of the file in which the output should be saved.
 
 
-      %|important "Serve XHTML as HTML for Microsoft web browsers"
+      %|important! "Serve XHTML as HTML for Microsoft web browsers"
 
         If you do not care whether people can read your XHTML documents using Microsoft web browsers, please disregard this message.  Otherwise, please heed the following instructions.
 

data/fmt/xhtml.yaml

@@ -201,21 +201,31 @@ code: |
         atts[:src] = ERBook.base_64_embed_image_data(data, format)
         "<img#{atts.to_xml_atts}/>"
       end
-    end
 
-    class Document::Node
       ##
-      # Returns the user-defined title for this node's content.
+      # Allows float nodes to be instantiated implicitly by name.
       #
-      def title
-        @title ||= args[0]
+      def method_missing name, *args, &block
+        if name.to_s =~ /!$/
+          args[2] = $` # the type of this float node
+          float(*args, &block)
+        else
+          super
+        end
       end
+    end
 
-      ##
-      # Returns the user-defined indentifer for this node.
-      #
-      def id
-        @id ||= args[1]
+    class Document::Node
+      def index?
+        definition['index']
+      end
+
+      def index_toc?
+        Array(definition['index']).include? 'tree'
+      end
+
+      def index_lof?
+        Array(definition['index']).include? 'list'
       end
 
       # utility methods
@@ -242,6 +252,13 @@ code: |
           content.join.to_xhtml
         end
 
+        ##
+        # Returns the content of this node as inline XHTML.
+        #
+        def content_inline_xhtml
+          content.join.to_inline_xhtml
+        end
+
         ##
         # Returns the content of this node as XHTML inside a <div/>.
         #
@@ -257,34 +274,34 @@ code: |
         end
 
         ##
-        # Returns a hyperlink to this node
-        # containing its LaTeX-style index number.
+        # Returns a hyperlink to this node containing its section number.
         #
-        def index_link
-          index
+        def section_number_link
+          section_number
         end
 
         ##
-        # Returns a hyperlink to this node containing its occurrence number.
+        # Returns a hyperlink to this node containing its ordinal number.
         #
-        def number_link
-          [type_label, number].compact.join(' ')
+        def ordinal_number_link
+          [type_label, ordinal_number].compact.join(' ')
         end
 
         ##
         # Returns a hyperlink to this node containing
         # its ocurrence number and its title.
         #
-        def number_and_title_link #:nodoc:
-          "#{number_link}.&nbsp;&nbsp;#{title_link}"
+        def ordinal_number_and_title_link #:nodoc:
+          "#{ordinal_number_link}.&nbsp;&nbsp;#{title_link}"
         end
 
         ##
-        # Returns a hyperlink to this node containing
-        # its LaTeX-style index number and its title.
+        # Returns a hyperlink to this
+        # node containing its section
+        # number and its title.
         #
-        def index_and_title_link #:nodoc:
-          "#{index_link}&nbsp;&nbsp;#{title_link}"
+        def section_number_and_title_link #:nodoc:
+          "#{section_number_link}&nbsp;&nbsp;#{title_link}"
         end
 
         ##
@@ -293,7 +310,7 @@ code: |
         def navigation
           self.class.navigation(
             here_frag,
-            (list_frag if defn['toc'] || defn['lof']),
+            (list_frag if index?),
             (prev_node.here_frag if prev_node),
             (next_node.here_frag if next_node)
           )
@@ -322,7 +339,7 @@ code: |
         # configured to appear in the table of contents.
         #
         def toc_children
-          children.select {|c| c.defn['toc'] }
+          children.select {|c| c.index_toc? }
         end
 
         HERE_TEXT = ERBook::PHRASES['Focus this segment']
@@ -358,7 +375,8 @@ code: |
         #   this node will be used as the label instead.
         #
         def xref_link label = nil
-          prefix = [type_label, index || number].compact.join(' ')
+          prefix = [type_label, section_number || ordinal_number].
+                   compact.join(' ')
 
           caption =
             if type == 'reference'
@@ -386,7 +404,8 @@ code: |
 
             # make it unique
             while @@frags.include? frag
-              frag = "#{frag} #{index || number || salt}".to_uri_fragment
+              frag = [frag, section_number || ordinal_number || salt].
+                     join(' ').to_uri_fragment
             end
 
             @@frags << frag
@@ -408,37 +427,23 @@ code: |
 
 
 nodes:
-  # object model
-    node:
-      toc: false
-      lof: false
-      depth: false
-      index: false
+  # theory
+
+    node: &wrapper
+      index:  false
       number: false
-      silent: false
       inline: true
-      bypass: true
+      silent: false
       output: <%= @node.content_xhtml %>
 
-  # Structure
+  # structure
+
     header: &header
-      toc: false
-      lof: false
-      depth: false
-      index: false
-      number: false
+      <<: *wrapper
       silent: true
-      inline: true
-      output: <%= @node.content_xhtml %>
 
     header_outside_above: &header_insert
-      toc: false
-      lof: false
-      depth: false
-      index: false
-      number: false
-      silent: true
-      inline: true
+      <<: *header
       output: |
         <%= @node.parent_tabs_begin %>
         <div class="<%= @node.type %>" id="<%= @node.here_frag %>"><%= @node.content_xhtml %></div>
@@ -455,33 +460,27 @@ nodes:
     footer_outside_below: *header_insert
 
     abstract:
-      toc: false
-      lof: false
-      depth: false
-      index: false
-      number: false
-      silent: true
-      bypass: false
+      <<: *wrapper
       output: |
         <div id="<%= @node.type_frag %>">
           <h1 class="title"><%= @node.type_label %></h1>
           <%= @node.content_xhtml_div %>
         </div>
 
-  # Organization
+  # organization
+
     part: &latex
-      toc: true
-      lof: false
-      depth: true
-      index: true
-      number: true
+      index:  tree
+      number: section
+      inline: false
       silent: false
+      params: [title, id]
       output: |
         <%= @node.parent_tabs_begin %>
         <div class="<%= @node.type %>" id="<%= @node.here_frag %>">
           <%= @node.navigation %>
           <h1 class="title">
-            <%= @node.type_label %>&nbsp;<%= @node.index_link %>
+            <%= @node.type_label %>&nbsp;<%= @node.section_number_link %>
             <br/>
             <big><%= @node.title_link %></big>
           </h1>
@@ -492,31 +491,22 @@ nodes:
     chapter: *latex
 
     section:
-      toc: true
-      lof: false
-      depth: true
-      index: true
-      number: true
-      silent: false
+      <<: *latex
       output: |
         <% depth = [6, @node.depth + 1].min %>
         <%= @node.parent_tabs_begin %>
         <div class="<%= @node.type %>" id="<%= @node.here_frag %>">
           <%= @node.navigation %>
           <h<%= depth %> class="title">
-            <%= @node.index_and_title_link %>
+            <%= @node.section_number_and_title_link %>
           </h<%= depth %>>
           <%= @node.content_xhtml_div %>
         </div>
         <%= @node.parent_tabs_end %>
 
     paragraph:
-      toc: true
-      lof: false
-      depth: false
-      index: false
+      <<: *latex
       number: false
-      silent: false
       output: |
         <%= @node.parent_tabs_begin %>
         <div class="<%= @node.type %>" id="<%= @node.here_frag %>">
@@ -526,107 +516,104 @@ nodes:
         </div>
         <%= @node.parent_tabs_end %>
 
-  # Admonitions
-    tip: &admonition
-      toc: false
-      lof: true
-      depth: true
-      index: false
-      number: true
+  # arbitrary floats
+  # see also http://www.sagehill.net/docbookxsl/FormalTitles.html
+
+    float:
+      index:  list
+      number: ordinal
+      inline: false
       silent: false
+      params: [title, id, type]
       output: |
         <%= @node.parent_tabs_begin %>
         <div class="<%= @node.type %>" id="<%= @node.here_frag %>">
           <%= @node.navigation %>
-          <p class="title"><%= @node.number_and_title_link %></p>
-          <div class="content">
-            <%= ICON_BY_NAME[@node.type].to_xhtml %>
-            <%= @node.content_xhtml %>
-          </div>
+          <p class="title"><%= @node.ordinal_number_and_title_link %></p>
+          <% if ICON_BY_NAME.key? @node.type %>
+            <div class="content">
+              <%= ICON_BY_NAME[@node.type].to_xhtml %>
+              <%= @node.content_xhtml %>
+            </div>
+          <% else %>
+            <%= @node.content_xhtml_div %>
+          <% end %>
         </div>
         <%= @node.parent_tabs_end %>
 
-    note: *admonition
-    caution: *admonition
-    warning: *admonition
-    important: *admonition
-
-  # Auxilary materials (formal blocks)
-  # see http://www.sagehill.net/docbookxsl/FormalTitles.html
-    figure: &formal
-      toc: false
-      lof: true
-      depth: true
+  # tables
+
+    table: &table
       index: false
-      number: true
+      number: false
+      inline: true
       silent: false
+      params: [xml_atts]
       output: |
-        <%= @node.parent_tabs_begin %>
-        <div class="<%= @node.type %>" id="<%= @node.here_frag %>">
-          <%= @node.navigation %>
-          <p class="title"><%= @node.number_and_title_link %></p>
-          <%= @node.content_xhtml_div %>
-        </div>
-        <%= @node.parent_tabs_end %>
+        <table border="1"<%=
+          (@node.xml_atts || {}).to_xml_atts
+        %>><%= @node.content_xhtml %></table>
+
+    thead: &table_child
+      <<: *table
+      output: |
+        <<%= @node.type %><%=
+          (@node.xml_atts || {}).to_xml_atts
+        %>><%= @node.content_inline_xhtml %></<%= @node.type %>>
 
-    table: *formal
-    example: *formal
-    equation: *formal
-    procedure: *formal
+    tbody:  *table_child
+    tfoot:  *table_child
+    th:     *table_child
+    tr:     *table_child
+    td:     *table_child
 
   # cross-references
     xref:
-      toc: false
-      lof: false
-      depth: true
-      index: false
+      index:  false
       number: false
-      silent: false
       inline: true
+      silent: false
+      params: [query, label]
       output: |
         <%=
-          query, label = @node.args
-
           scope  = @nodes.select {|n| n.content }
-          target = scope.find {|n| n.id == query } || # id has 1st priority
-                   scope.find {|n| n.title == query }
+          target = scope.find {|n| n.id == @node.query } || # id has priority
+                   scope.find {|n| n.title == @node.query }
 
           if target
-            target.xref_link label
+            target.xref_link @node.label
           else
-            raise ArgumentError, "invalid cross-reference to #{@node.title.inspect}", @node.trace
+            raise ArgumentError, "invalid cross-reference to #{@node.query.inspect}", @node.backtrace
           end
         %>
 
-  # Bibliography
-    reference:
-      toc: false
-      lof: false
-      depth: false
-      index: false
-      number: true
+  # bibliography
+
+    reference: &reference
+      index:  false
+      number: ordinal
+      inline: false
       silent: true
-      bypass: true
+      params: [title, id]
 
     cite:
-      toc: false
-      lof: false
-      depth: false
-      index: false
+      index:  false
       number: false
-      silent: false
       inline: true
+      silent: false
+      params: [target]
       output: |
         <%=
-          target = @nodes_by_type['reference'].find {|n| n.title == @node.title }
+          target = @nodes_by_type['reference'].find do |n|
+            n.title == @node.target
+          end
 
           if target
             '<sup>[%s]</sup>' % [
-              target.xref_link(target.number),
-              *@node.args[1..-1]
-            ].join(', ')
+              target.xref_link(target.ordinal_number), *@node.arguments
+            ].compact.join(', ')
           else
-            raise ArgumentError, "invalid citation for #{@node.title.inspect}", @node.trace
+            raise ArgumentError, "invalid citation for #{@node.target.inspect}", @node.backtrace
           end
         %>
 
@@ -652,9 +639,9 @@ output: |
         nested = n.children.inject('') {|s,c| s << toc_builder[c] }
         nested = nil if nested.empty?
 
-        if n.defn['toc']
+        if n.index_toc?
           entry = '%s<a id="%s" href="#%s">%s</a>' % [
-            (n.index.to_s + '&nbsp;&nbsp;' if n.index),
+            (n.section_number.to_s + '&nbsp;&nbsp;' if n.section_number),
             n.list_frag,
             n.here_frag,
             n.title.to_s.to_inline_xhtml
@@ -669,17 +656,19 @@ output: |
       toc = @roots.inject('') {|s,n| s << toc_builder[n] }
 
     # compute list of figures
-      lof_enums = {} # type => nodes
-
-      @format['nodes'].each_pair do |name, info|
-        if info['lof']
-          nodes = @nodes_by_type[name]
-          lof_enums[name] = nodes unless nodes.empty?
+      lof_nodes_by_type = Hash.new {|h,k| h[k] = [] }
+      @nodes.each do |node|
+        if node.index_lof?
+          lof_nodes_by_type[node.type] << node
         end
       end
 
-      lof_sections_frag_and_label = []
+      lof_enums = {} # type => nodes
+      lof_nodes_by_type.each do |type, nodes|
+        lof_enums[type] = nodes unless nodes.empty?
+      end
 
+      lof_sections_frag_and_label = []
       lof = lof_enums.sort.map do |type, nodes|
         nested = nodes.map do |n|
           %{<li><a id="#{n.list_frag}" href="##{n.here_frag}">#{n.title.to_s.to_inline_xhtml}</a></li>}
@@ -878,7 +867,7 @@ output: |
           <div id="__doc__" class="tabs">
             <h1 style="display: none"><%= ERBook::PHRASES['Document'] %></h1>
             <ul>
-              % @roots.select {|n| n.defn['toc'] }.each do |n|
+              % @roots.select {|n| n.index_toc? }.each do |n|
                 <li><a href="#<%= n.here_frag %>"><%= n.title.to_s.to_inline_xhtml %></a></li>
             </ul>