deplate 0.7.3 → 0.8

data/lib/deplate/structured.rb

@@ -3,8 +3,8 @@
 # @Website:     http://deplate.sf.net/
 # @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 # @Created:     17-M�r-2004.
-# @Last Change: 28-Okt-2005.
-# @Revision:    0.2590
+# @Last Change: 05-Jun-2006.
+# @Revision:    0.2707
 # 
 # TODO:
 # - am Ende des Dokuments muss ein Stapel mit offenen tags abgearbeitet werden
@@ -18,13 +18,13 @@ class Deplate::Formatter::Structured < Deplate::Formatter
     @@bibentries      = {}
     @@openLabels      = []
 
-    label_delegate = [
+    self.label_delegate = [
         # :format_heading, 
         :format_LIST,
         :format_anchor,
     ]
 
-    label_once = [
+    self.label_once = [
         :format_list_env,
         :format_table,
         :format_IMG,
@@ -41,18 +41,19 @@ class Deplate::Formatter::Structured < Deplate::Formatter
     def output_at(type, slot, text)
         ind = @deplate.options.indentation_level.last
         if ind > 0
-            text = indent_text(text, ind)
+            text = indent_text(text, :mult => ind)
         end
         super(type, slot, text)
     end
     
 
     ################################################ Lists {{{1
-    def format_list_item(invoker, type, level, item, explicit=false)
-        args = invoker.args
+    def format_list_item(invoker, type, level, item, args={})
+        args     = invoker.args
+        explicit = args[:explicit]
         # $stderr << "Item #{type}: #{item.body}\n" if $DEBUG
         case type
-        when "Numbered"
+        when "Ordered"
             open  = get_item_numbered_open(args, item.item, item.body)
             close = get_item_numbered_close(args)
         when "Itemize"
@@ -61,14 +62,29 @@ class Deplate::Formatter::Structured < Deplate::Formatter
         when "Description"
             open  = get_item_description_open(args, item.item, item.body)
             close = get_item_description_close(args)
+        when 'Task'
+            open  = get_item_task_open(args, item.item, item.body, item.opts)
+            close = get_item_task_close(args)
         when "Paragraph"
             open  = get_item_paragraph(args, item.item, item.body)
             close = nil
+        when 'Container'
+            open  = item.body
+            close = nil
         else
-            raise "Unknown list type: #{item.inspect}"
+            f = item.preformatted
+            if f
+                open, close = f
+            else
+                raise "Unknown list type: #{item.inspect}"
+            end
         end
-        open  = indent_text(open, level, true)
-        close = indent_text(close, level, true)
+        if type != 'Container'
+            # open = indent_text(open, level, :shift => true)
+            open = indent_text(open, :mult => level)
+        end
+        # close = indent_text(close, level, :shift => true)
+        close = indent_text(close, :mult => level)
         return open, close
     end
     
@@ -77,7 +93,7 @@ class Deplate::Formatter::Structured < Deplate::Formatter
     def format_list_env(invoker, type, level, what, subtype=nil)
         args = invoker.args
         case type
-        when "Numbered"
+        when "Ordered"
             if what == :open
                 tag = get_list_numbered_open(args, subtype)
             elsif what == :close
@@ -89,16 +105,25 @@ class Deplate::Formatter::Structured < Deplate::Formatter
             elsif what == :close
                 tag = get_list_itemize_close(args)
             end
+        when 'Task'
+            if what == :open
+                tag = get_list_task_open(args)
+            elsif what == :close
+                tag = get_list_task_close(args)
+            end
         when "Description"
             if what == :open
                 tag = get_list_description_open(args)
             elsif what == :close
                 tag = get_list_description_close(args)
             end
+        when nil
+            invoker.log('List type is nil', :debug)
         else
             raise "Unknown list type: #{type}"
         end
-        return indent_text(tag, level, true)
+        # return indent_text(tag, level, :shift => true)
+        return indent_text(tag, :mult => level)
     end
 
     def_abstract :get_list_numbered_open, :get_list_numbered_close
@@ -127,7 +152,7 @@ class Deplate::Formatter::Structured < Deplate::Formatter
                 end
             when :once
                 for l in label
-                    text = if block_given? then yield(l) else "" end
+                    text = if block_given? then yield(l) else '' end
                     acc << get_label(args, l, mode, text)
                 end
             when :closeOpen
@@ -137,7 +162,7 @@ class Deplate::Formatter::Structured < Deplate::Formatter
                 end
             else
                 for l in label.uniq
-                    text = if block_given? then yield(l) else "" end
+                    text = if block_given? then yield(l) else '' end
                     acc << get_label(args, l, mode, text)
                 end
             end
@@ -149,31 +174,26 @@ class Deplate::Formatter::Structured < Deplate::Formatter
         elt ||= invoker.elt
         args  = invoker.args
         if inline
-            include_image(elt, args, inline)
+            include_image(invoker, elt, args, inline)
         else
             caption  = invoker.caption
-            fig      = @deplate.msg("Figure")
-            capAbove = !(caption && caption.args && caption.args.include?("below"))
+            fig      = @deplate.msg('Figure')
+            capAbove = !(caption && caption.args && caption.args.include?('below'))
             if caption
                 ti  = %{#{fig} #{invoker.level_as_string}}
                 cap = get_figure_caption(args, ti, caption.elt, capAbove)
             else
                 cap = nil
             end
-            get_figure(args, cap, include_image(elt, args))
+            get_figure(args, cap, include_image(invoker, elt, args))
         end
     end
 
     def_abstract :get_figure_caption, :get_figure
 
-    def include_image(file, args, inline=false)
-        f = file[0..-(File.extname(file).size + 1)]
-        for sfx in image_suffixes
-            ff = f + sfx
-            if File.exist?(File.join(@deplate.options.dir || "", ff))
-                return get_image(args, ff, f, inline)
-            end
-        end
+    def include_image(invoker, file, args, inline=false)
+        f    = File.basename(file, '*')
+        file = use_image_filename(file, args)
         return get_image(args, file, f, inline)
     end
 
@@ -288,14 +308,11 @@ class Deplate::Formatter::Structured < Deplate::Formatter
     def format_verbatim(invoker, text=nil)
         text = invoker.elt unless text
         args = invoker.args
-        begin
-            @deplate.options.indentation_level << 0
-            # It's up to get_pre_format to deal with this.
-            # text = plain_text(text, false, false)
-            get_pre_format(args, text)
-        ensure
-            @deplate.options.indentation_level.pop
+        @deplate.options.indentation_level << 0
+        invoker.postponed_format << Proc.new do |container|
+            container.deplate.options.indentation_level.pop
         end
+        get_pre_format(args, text)
     end
 
     def format_abstract(invoker)
@@ -377,29 +394,38 @@ class Deplate::Formatter::Structured < Deplate::Formatter
 
 
     ################################################ Particles {{{1
-    # Shouldn't this be an alias to get_emphasize?
-    def format_emphasize(args, text)
+    def format_emphasize(invoker, text=nil)
+        text ||= invoker.elt || invoker.text
+        args = invoker.args
         get_emphasize(args, text)
     end
 
     def_abstract :get_emphasize
 
-    def format_code(args, text)
+    def format_code(invoker, text=nil)
+        text ||= invoker.elt || invoker.text
+        args = invoker.args
         get_code(args, plain_text(text, true, false))
     end
     
     def_abstract :get_code
     
-    def format_url(args, name, dest, anchor, literal=false)
+    def format_url(invoker, name, dest, anchor, literal=false)
         dest = Deplate::HyperLink.url_anchor(dest, anchor)
+        args = invoker.args
         get_url(args, name, dest, anchor)
     end
         
     def_abstract :get_url
     
-    def format_wiki(args, name, dest, anchor)
-        dest = Deplate::HyperLink.url_anchor(dest, anchor)
-        get_wiki(args, name, dest, anchor)
+    def format_wiki(invoker, name, dest, anchor)
+        if dest.empty? and (name.empty? or name == anchor)
+            get_ref(invoker.args, '', anchor, invoker.top_heading.get_id)
+        else
+            dest = Deplate::HyperLink.url_anchor(dest, anchor)
+            args = invoker.args
+            get_wiki(args, name, dest, anchor)
+        end
     end
  
     def_abstract :get_wiki
@@ -417,19 +443,22 @@ class Deplate::Formatter::Structured < Deplate::Formatter
     def format_footnote(invoker)
         args = invoker.args
         elt = invoker.elt
-        if elt and elt.elt and elt.elt.consumed
-            fn  = elt.elt
-            lab = fn.label
-            if @deplate.footnotes_used.include?(lab)
-                return get_footnote_ref(args, lab, fn.body)
+        if elt and elt.elt and elt.fn_consumed
+            lab = elt.fn_label ||= elt.args['id']
+            if lab
+                body = elt.format_current
+                if @deplate.footnotes_used.include?(lab)
+                    return get_footnote_ref(args, lab, body)
+                else
+                    @deplate.footnotes_used << lab
+                    @deplate.footnote_last_idx +=1
+                    return get_footnote(args, lab, body)
+                end
             else
-                @deplate.footnotes_used << lab
-                @deplate.footnote_last_idx +=1
-                return get_footnote(args, lab, fn.body)
+                invoker.log(['Internal error', 'No footnote label', body, elt ? elt : ''], :error)
             end
-        else
-            return ""
         end
+        return ''
     end
 
     def_abstract :get_footnote, :get_footnote_ref
@@ -441,15 +470,17 @@ class Deplate::Formatter::Structured < Deplate::Formatter
         o = @deplate.label_aliases[text]
         if o
             t   = o.top_heading.get_id
-            f0  = container.output_file_name
-            f   = container.output_file_name(:label => text)
-            f   = "" if f == f0
+            f   = @deplate.get_filename_for_label(invoker, text)
+            # f0  = container.output_file_name
+            # f   = container.output_file_name(:label => text)
+            # f   = '' if f == f0
             ref = get_ref(args, f, text, t)
         else
-            log(["Undefined label", text], :error)
-            ref = "??"
+            log(['Undefined label', text], :error)
+            ref = '??'
         end
-        return nonbreakingspace(nil) + ref
+        prefix = invoker.args['prefix'] || nonbreakingspace(nil)
+        return prefix + ref
     end
 
     def_abstract :get_ref
@@ -464,15 +495,15 @@ class Deplate::Formatter::Structured < Deplate::Formatter
         args = invoker.args
         elt  = invoker.elt
         container = invoker.container
-        n  = args["n"]
-        p  = args["p"]
+        n  = args['n']
+        p  = args['p']
         acc = []
         for c in elt
             cc = bib_entry(c)
             if cc
                 e  = {}
-                yr = cc.assoc("year")
-                yr = if yr then yr[1] else "" end
+                yr = cc.assoc('year')
+                yr = if yr then yr[1] else '' end
                 e[:year] = yr
                 if n
                     e[:note] = @deplate.parse_and_format(container, n)
@@ -482,9 +513,9 @@ class Deplate::Formatter::Structured < Deplate::Formatter
                     p = @deplate.parse_and_format(container, "#{@deplate.msg("p.\\ ")}#{p}")
                     e[:pages] = p
                 end
-                nm = cc.assoc("author") || cc.assoc("editor")
+                nm = cc.assoc('author') || cc.assoc('editor')
                 if nm
-                    nm = nm[1].gsub(/\s+/, " ").split(" and ").collect do |a|
+                    nm = nm[1].gsub(/\s+/, ' ').split(' and ').collect do |a|
                         a.scan(/\w+$/)
                     end
                     e[:name] = nm
@@ -566,7 +597,7 @@ class Deplate::Formatter::Structured < Deplate::Formatter
     end
 
     alias :format_bib_entry_re_structured :format_bib_entry
-    def format_bib_entry(invoker, bibdef)
+    def format_bib_entry(invoker, key, bibdef)
         args = invoker.args
         bib = Hash[*bibdef.flatten]
         be  = ["author", "title", "pages"]
@@ -581,13 +612,13 @@ class Deplate::Formatter::Structured < Deplate::Formatter
         #     end
         # end
         container = {}
-        bc  = ["editor", "year", "booktitle", "publisher", "journal", "volume", "number"]
+        bc  = ['editor', 'year', 'booktitle', 'publisher', 'journal', 'volume', 'number']
         process_bib_entry_part(invoker, args, container, bib, bc)
         # for e in bc
         #     ee = bib[e]
         #     container[e] = self.send("get_bib_%s" % e, args, simple_latex_reformat(ee)) if ee
         # end
-        return get_bib_relation(args, bib["type"], entry, container)
+        return get_bib_relation(args, bib['@type'], entry, container)
     end
 
     def process_bib_entry_part(invoker, args, accum, bibdef, parts)
@@ -595,7 +626,11 @@ class Deplate::Formatter::Structured < Deplate::Formatter
             ee = bibdef[e]
             if ee
                 ee = simple_latex_reformat(ee)
-                ee = @deplate.parse_and_format(invoker.container, ee)
+                ee = @deplate.parse_and_format(invoker, ee, false, [
+                                         Deplate::HyperLink::Extended,
+                                         Deplate::HyperLink::Simple,
+                                         Deplate::HyperLink::Url,
+                ])
                 accum[e] = self.send("get_bib_#{e}", args, ee)
             end
         end
@@ -611,14 +646,21 @@ class Deplate::Formatter::Structured < Deplate::Formatter
     def format_heading_open(invoker)
         l = format_label(invoker)
         @deplate.options.indentation_level << invoker.level
+        invoker.postponed_format << Proc.new do |container|
+            container.deplate.options.indentation_level << (container.level + 1)
+        end
         get_heading_open(invoker.args, invoker.level, invoker.level_as_string, invoker.elt, l)
     end
 
     def format_heading_close(invoker)
         @deplate.options.indentation_level.pop
+        @deplate.options.indentation_level.pop
+        # invoker.postponed_format << Proc.new do |container|
+        #     container.deplate.options.indentation_level.pop
+        # end
         get_heading_close(invoker.args, invoker.level)
     end
-    
+ 
     def close_headings(level)
         hds = @deplate.options.headings
         if hds
@@ -626,7 +668,7 @@ class Deplate::Formatter::Structured < Deplate::Formatter
             loop do
                 hd = hds.last
                 if hd and level <= hd.level
-                    acc << format_heading_close(hd)
+                    acc << indent_text(format_heading_close(hd), :mult => hd.level - level)
                     hds.pop
                 else
                     break
@@ -639,26 +681,32 @@ class Deplate::Formatter::Structured < Deplate::Formatter
 
     ################################################ List of ... {{{1
     def format_list_of_contents(invoker)
-        format_list_of(invoker, "Table of Contents", @deplate.table_of_contents, "hd", false)
+        format_list_of(invoker, 
+                       :title => 'Table of Contents', 
+                       :prefix => 'hd', 
+                       :listing => 'toc',
+                       :flat => false)
     end
     alias :format_list_of_toc :format_list_of_contents
 
     def format_list_of_minitoc(invoker)
-        # <+TBD+>
-        # data = @deplate.table_of_contents.find_all {|e| e.level == 1}
-        # format_list_of("Contents", data, "hd", false, deplate.variables["navGif"]) do |hd|
-            # hd.args["shortcaption"] || hd.args["id"]
+        # data = @deplate.options.listings.get('toc').find_all {|e| e.level == 1}
+        # format_list_of(invoker, "Contents", "hd", 
+        #                :data => data, :flat => false, 
+        #                :img => @variables["navGif"],
+        #                :html_class => "minitoc") do |hd|
+        #     hd.args["shortcaption"] || hd.args["id"]
         # end
     end
 
     def format_list_of_tables(invoker)
-        get_list_of_tables(invoker.args, @deplate.table_of_tables)
+        get_list_of_tables(invoker.args, @deplate.options.listings.get('lot'))
     end
 
     def_abstract :get_list_of_tables
 
-    def format_list_of_figures(invoker)
-        get_list_of_figures(invoker.args, @deplate.table_of_figures)
+    def format_list_of_lof(invoker)
+        get_list_of_figures(invoker.args, @deplate.options.listings.get('lof'))
     end
 
     def_abstract :get_list_of_figures
@@ -669,29 +717,40 @@ class Deplate::Formatter::Structured < Deplate::Formatter
 
     def_abstract :get_list_of_index
 
-    def format_list_of(invoker, name, data, prefix, flat=false)
-        args = invoker.args
-        name = args["title"] || name
-        acc  = []
-        acc << get_contents_open(args, prefix)
-        ll = 1
-        accData = []
-        for hd in data
-            unless hd.args["noList"]
-                l = if flat then 1 else hd.level end
-                f = hd.output_file_name(:relative => invoker)
-                d = f + "#" + @deplate.elt_label(prefix, hd.level_as_string)
-                v = if hd.caption then hd.caption.elt else v = hd.elt.dup end
-                v = [hd.level_as_string, v].join(" ")
-                b = format_url(invoker, v, d, nil, true)
-                s = Deplate::ListItem.new(nil, b, "Itemize", "Itemize", l, 0, true)
-                accData << s
-            end
-        end
-        acc << get_contents_list(args, prefix, accData)
-        acc << get_contents_close(args, prefix)
-        join_blocks(acc)
-    end
+    # def format_list_of(invoker, other_args)
+    #     args   = invoker.args
+    #     name   = other_args[:title]
+    #     prefix = other_args[:prefix]
+    #     data   = other_args[:data]
+    #     unless data
+    #         list = other_args[:listing]
+    #         data = invoker.deplate.options.listings.get(list)
+    #         unless data
+    #             invoker.log(['Unknown list', list], :error)
+    #         end
+    #     end
+    #     flat = other_args[:flat] || false
+    #     name = args["title"] || name
+    #     acc  = []
+    #     acc << get_contents_open(args, prefix)
+    #     ll = 1
+    #     accData = []
+    #     for hd in data
+    #         unless hd.args["noList"]
+    #             l = if flat then 1 else hd.level end
+    #             f = hd.output_file_name(:relative => invoker)
+    #             d = f + "#" + @deplate.elt_label(prefix, hd.level_as_string)
+    #             v = if hd.caption then hd.caption.elt else v = hd.elt.dup end
+    #             v = [hd.level_as_string, v].join(" ")
+    #             b = format_url(invoker, v, d, nil, true)
+    #             s = Deplate::ListItem.new(nil, b, "Itemize", "Itemize", l, 0, true)
+    #             accData << s
+    #         end
+    #     end
+    #     acc << get_contents_list(args, prefix, accData)
+    #     acc << get_contents_close(args, prefix)
+    #     join_blocks(acc)
+    # end
 
     # <+TBD+>
     def format_the_index(invoker, name, data, prefix="", flat=false)
@@ -719,12 +778,12 @@ class Deplate::Formatter::Structured < Deplate::Formatter
                     if l and !l.empty?
                         t = l
                     elsif @deplate.options.multi_file_output
-                        t = @deplate.variables["refButton"]
+                        t = @deplate.variables['refButton']
                     else
-                        t = "I"
+                        t = 'I'
                     end
                 else
-                    t = @deplate.file_with_suffix(f, "", true)
+                    t = @deplate.file_with_suffix(f, '', true)
                 end
                 acc << format_url(invoker, t, f, i.label, true)
             end
@@ -755,9 +814,8 @@ class Deplate::Formatter::Structured < Deplate::Formatter
 
 end
 
+
 class Deplate::Element::Heading
-    def hook_post_setup_structured
-        @label_mode = :after
-    end
+    self.label_mode = :after
 end