deplate 0.7.3 → 0.8

data/lib/deplate/fmt/null.rb

@@ -0,0 +1,32 @@
+# null.rb
+# @Author:      Thomas Link (samul AT web.de)
+# @Website:     http://deplate.sf.net/
+# @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
+# @Created:     17-M�r-2004.
+# @Last Change: 08-Jan-2006.
+# @Revision:    0.3747
+
+require 'deplate/formatter'
+
+class Deplate::Formatter::NULL < Deplate::Formatter
+    self.myname = 'null'
+    self.rx     = /null?/i
+    
+    def format_particle(agent, invoker, *args)
+        ''
+    end
+
+    def format_element(agent, invoker, *args)
+        ''
+    end
+
+    def output(invoker, *body)
+    end
+end
+
+
+class Deplate::Core
+    def body_write
+    end
+end
+

data/lib/deplate/fmt/php.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: 23-Okt-2005.
-# @Revision:    0.911
+# @Last Change: 21-Apr-2006.
+# @Revision:    0.914
 
 require 'deplate/fmt/html'
 require 'deplate/mod/php-extra'
@@ -12,8 +12,8 @@ require 'deplate/mod/php-extra'
 # A variant of the html-formatter that is suited for php output.
 
 class Deplate::Formatter::Php < Deplate::Formatter::HTML
-    self.myname = "php"
+    self.myname = 'php'
     self.rx     = /php[0-9]?/i
-    self.suffix = ".php"
+    self.suffix = '.php'
 end
 

data/lib/deplate/fmt/phpsite.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: 29-Okt-2005.
-# @Revision:    0.916
+# @Last Change: 21-Apr-2006.
+# @Revision:    0.918
 
 require 'deplate/fmt/htmlsite'
 require 'deplate/mod/php-extra'
@@ -12,8 +12,9 @@ require 'deplate/mod/php-extra'
 # A variant of the htmlsite-formatter that is suited for php output.
 
 class Deplate::Formatter::PhpSite < Deplate::Formatter::HTML_Site
-    self.myname = "phpsite"
-    self.rx     = /php[0-9]?/i
-    self.suffix = ".php"
+    self.myname  = 'phpsite'
+    self.related = ['php']
+    self.rx      = /php[0-9]?/i
+    self.suffix  = '.php'
 end
 

data/lib/deplate/fmt/plain.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.3450
+# @Last Change: 05-Jun-2006.
+# @Revision:    0.3577
 
 require "deplate/formatter"
 
@@ -13,7 +13,7 @@ require "deplate/formatter"
 class Deplate::Formatter::Plain < Deplate::Formatter
     self.myname = "plain"
     self.rx     = /plain/i
-    self.suffix = ".txt"
+    self.suffix = '.text'
 
     self.label_mode     = :delegate
     self.label_delegate = []
@@ -21,6 +21,7 @@ class Deplate::Formatter::Plain < Deplate::Formatter
     
     def initialize(deplate, args)
         super
+        @color        = deplate.variables['ansiColor'] && defined?(Deplate::Color)
         @list_counter = {}
     end
 
@@ -29,18 +30,17 @@ class Deplate::Formatter::Plain < Deplate::Formatter
     end
 
     def format_label(invoker, mode=nil, label=nil)
-        ""
+        ''
     end
 
     def format_figure(invoker, inline=false, elt=nil)
-        if elt
-            if inline
-                elt
-            else
-                "\n#{elt}\n"
-            end
-        elsif inline
-            include_image(invoker.elt, invoker.args)
+        elt ||= invoker.elt
+        unless elt.kind_of?(String)
+            invoker.log(['Unexpected argument', elt.class], :error)
+            elt = elt.to_s
+        end
+        if inline or invoker.args['inline']
+            include_image(invoker, elt, invoker.args, true)
         else
             acc = []
             fig     = @deplate.msg("Figure")
@@ -55,7 +55,7 @@ class Deplate::Formatter::Plain < Deplate::Formatter
             if caption and capAbove
                 acc << cap
             end
-            acc << include_image(invoker.elt, invoker.args)
+            acc << include_image(invoker, elt, invoker.args)
             if caption and !capAbove
                 acc << cap
             end
@@ -64,10 +64,26 @@ class Deplate::Formatter::Plain < Deplate::Formatter
         end
     end
 
-    def include_image(file, args, inline=false)
-        # alt = args["alt"]
-        # alt ? "[#{alt}]" : "[IMG:#{file}]"
-        "[#{args["alt"] || file}]"
+    def include_image(invoker, file, args, inline=false)
+        file = args['file'] if args['file']
+        if inline or !@deplate.variables['asciiArt']
+            return "[#{args["alt"] || @deplate.variables['imgAlt'] || file}]"
+        else
+            file = use_image_filename(file, args)
+            if File.exist?(file)
+                acc = [file]
+                args[:deplate] ||= @deplate
+                # case @deplate.variables['asciiArt']
+                # else
+                return Deplate::External.jave(invoker, file, args)
+                # end
+            end
+        end
+    end
+
+    def image_suffixes
+        # [".png", ".jpeg", ".jpg", ".gif", ".bmp"]
+        ['.jpeg', '.jpg', '.gif', '.bmp']
     end
 
     alias :format_IMG :format_figure
@@ -204,12 +220,13 @@ class Deplate::Formatter::Plain < Deplate::Formatter
             elt = [invoker.level_as_string, elt].join(" ")
         end
         if ul
-            [nil, elt, ul * elt.size, nil].join("\n")
+            elt = [nil, elt, ul * elt.size, nil].join("\n")
             # [elt, ul * elt.size].join("\n")
-        else
-            # "\n#{elt}\n"
-            elt
         end
+        if @color
+            elt = Deplate::Color.bold(elt)
+        end
+        elt
     end
 
     def format_list(invoker)
@@ -230,17 +247,18 @@ class Deplate::Formatter::Plain < Deplate::Formatter
     LIST_ITEMIZE_MARKERS   = ['*', '*', '+', '+', '-', '-']
     LIST_ITEMIZE_MARKERS_N = LIST_ITEMIZE_MARKERS.size
     # <+TBD+>Alphabethic lists give strange counters if the index passes beyond 'z'
-    def format_list_item(invoker, type, level, item, html_class=nil, explicit=false)
+    def format_list_item(invoker, type, level, item, args={})
         # indent = format_indent(level, true)
-        indent = "  " * level
+        indent   = "  " * level
+        explicit = args[:explicit]
         case type
-        when "Numbered"
+        when "Ordered"
             if explicit or item.explicit and item.item
                 # and !item.item.empty?
                 i = item.item
             else
                 i = @list_counter[type][-1] += 1
-                case list_subtype(type, item.item)
+                case list_subtype(type, item)
                 when "a"
                     i = "%c" % (96 + i)
                 when "A"
@@ -264,16 +282,34 @@ class Deplate::Formatter::Plain < Deplate::Formatter
                 i += " "
             end
             return wrap_text([indent, i, item.body].join, :hanging => 2), :none
+        when 'Task'
+            pri  = item.opts[:priority]
+            cat  = item.opts[:category]
+            done = item.opts[:done] ? 'done' : nil
+            due  = item.opts[:due]
+            task = [cat, pri]
+            task << " #{due}" if due
+            body = ['{', task, '} ', item.body].join
+            body = indent_text(wrap_text(body), 
+                               :mult => level,
+                               :hanging => true,
+                               :indent => indent
+                              )
+            return body, :none
         when "Description"
             accum = [indent, item.item, "\n"]
             accum << indent << "  " << item.body if item.body
             return wrap_text(accum.join), :none
         when "Paragraph"
+            t = "\n" + wrap_text(indent + item.body)
+            # t = wrap_text(indent + item.body)
+            return t, nil
+        when 'Container'
             # t = "\n" + wrap_text(indent + item.body)
-            t = wrap_text(indent + item.body)
+            t = "\n" + item.body
             return t, nil
         else
-            raise "Unknown list type: #{item.inspect}"
+            invoker.log(['Unknown list type', type], :error)
         end
     end
 
@@ -284,12 +320,14 @@ class Deplate::Formatter::Plain < Deplate::Formatter
 
     def format_abstract(invoker)
         text = invoker.elt
-        wrap_text("    " + text) + "\n"
+        # wrap_text("    " + text) + "\n"
+        indent_text(text) + "\n"
     end
 
     def format_quote(invoker)
         text = invoker.elt
-        wrap_text("> " + text, :indent => "> ") + "\n"
+        # wrap_text("> " + text, :indent => "> ") + "\n"
+        indent_text(text, :indent => '> ') + "\n"
     end
 
     def format_title(invoker)
@@ -317,11 +355,18 @@ class Deplate::Formatter::Plain < Deplate::Formatter
         nil
     end
 
-    def format_emphasize(invoker, text)
-        text
+    def format_emphasize(invoker, text=nil)
+        text ||= invoker.elt || invoker.text
+        if @color
+            # Deplate::Color.italic(text)
+            Deplate::Color.bold(text)
+        else
+            text
+        end
     end
 
-    def format_code(invoker, text)
+    def format_code(invoker, text=nil)
+        text ||= invoker.elt || invoker.text
         text
     end
 
@@ -330,13 +375,21 @@ class Deplate::Formatter::Plain < Deplate::Formatter
         idx = @deplate.footnote_last_idx += 1
         fn = "[#{idx}]"
         # invoker.container.postponed_format << Proc.new do |container|
-            output_at(:body, :footnotes, %{#{fn} #{Deplate::HyperLink.url_anchor(dest, anchor)}})
+            hlink = Deplate::HyperLink.url_anchor(dest, anchor)
+            if @color
+                hlink = Deplate::Color.underline(hlink)
+            end
+            output_at(:body, :footnotes, %{#{fn} #{hlink}})
         # end
         if name and !(name.empty?)
-            [name, fn].join
+            rv = [name, fn].join
         else
-            fn
+            rv = fn
         end
+        if @color
+            rv = Deplate::Color.underline(rv)
+        end
+        rv
     end
 
     alias :format_wiki :format_url
@@ -354,39 +407,43 @@ class Deplate::Formatter::Plain < Deplate::Formatter
     end
 
     def format_index(invoker, idx)
-        ""
+        ''
     end
 
     def format_footnote(invoker)
         elt = invoker.elt
-        if elt and elt.elt and elt.elt.consumed
-            fn  = elt.elt
-            lab = fn.label
+        if elt and elt.elt and elt.fn_consumed
+            lab = elt.fn_label
             if !@deplate.footnotes_used.include?(lab)
-                idx      = @deplate.footnote_last_idx +=1
-                lab      = "[#{idx}]"
-                fn.n     = idx
-                fn.label = lab
+                idx          = @deplate.footnote_last_idx +=1
+                lab          = "[#{idx}]"
+                elt.fn_n     = idx
+                elt.fn_label = lab
                 @deplate.footnotes_used << lab
-                text     = wrap_text("#{lab} #{fn.body}", :hanging => 4)
+                # text         = wrap_text("#{lab} #{elt.format_current}", :hanging => 4)
+                text         = [
+                    lab,
+                    indent_text(elt.format_current, :indent => '', :hanging => 4)
+                ].join(' ')
                 # invoker.container.postponed_format << Proc.new do |container|
                     output_at(:body, :footnotes, text)
                 # end
             end
         end
-        return fn.label
+        return elt.fn_label
     end
 
     def format_ref(invoker)
-        " " + @deplate.labels[invoker.text]
+        prefix = invoker.args['prefix'] || ' '
+        prefix + @deplate.labels[invoker.text]
     end
 
     def format_break(invoker)
-        "-" * 72
+        '-' * 72
     end
     
     def format_anchor(invoker)
-        ""
+        ''
     end
     
     def format_paragraph(invoker)
@@ -456,64 +513,61 @@ class Deplate::Formatter::Plain < Deplate::Formatter
         return ""
     end
 
-    def format_list_of_contents(invoker)
-        format_list_of(invoker, "Table of Contents", @deplate.table_of_contents, "hd", 
-                       :flat => false)
+    def format_list_of_toc(invoker)
+        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)
-        data = @deplate.table_of_contents.find_all {|e| e.level == 1}
-        format_list_of(invoker, "Contents", data, "hd", 
-                       :flat => false) do |hd|
+        data = @deplate.options.listings.get('toc').find_all {|e| e.level == 1}
+        format_list_of(invoker, 
+                       :title => "Contents", 
+                       :prefix => "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)
-        format_list_of(invoker, "List of Tables", @deplate.table_of_tables, "tab", 
-                       :flat => true)
+    def format_list_of_lot(invoker)
+        format_list_of(invoker, 
+                       :title => "List of Tables", 
+                       :prefix => "tab", 
+                       :listing => 'lot', :flat => true)
     end
 
-    def format_list_of_figures(invoker)
-        format_list_of(invoker, "List of Figures", @deplate.table_of_figures, "fig", 
-                       :flat => true)
+    def format_list_of_lof(invoker)
+        format_list_of(invoker, 
+                       :title => "List of Figures",
+                       :prefix => "fig", 
+                       :listing => 'lof', :flat => true)
     end
 
     def format_list_of_index(invoker)
         format_the_index(invoker, "Index", @deplate.index, "idx", true)
     end
 
-    def format_list_of(invoker, name, data, prefix, other_args)
-        args = invoker.args
-        flat = other_args[:flat] || false
-        name = args["title"] || name
-        id   = name.gsub(/\W/, "_")
-        
-        acc  = []
-        unless args["plain"] || args["noTitle"]
-            acc << format_heading(nil, 1, @deplate.msg(name))
-        end
-        ll = 1
-        accData = []
-        for hd in data
-            unless hd.nil? or hd.args["noList"]
-                l = if flat then 1 else hd.level end
-                v = nil
-                if block_given?
-                    v = yield(hd)
-                end
-                unless v
-                    v = if hd.caption then hd.caption.elt else v = hd.elt.dup end
-                end
-                v = [hd.level_as_string, v].join(" ") unless hd.plain_caption?
-                s = Deplate::ListItem.new("", v, "Itemize", "Itemize", l, 0, true)
-                accData << s
-            end
+    def listing_prematter(invoker, args, id)
+        nil
+    end
+    
+    def listing_postmatter(invoker, args)
+        ''
+    end
+    
+    def listing_title(invoker, args, name)
+        if name
+            format_heading(nil, 1, @deplate.msg(name))
         end
-        acc << printable_list(invoker, accData) << ""
-        join_blocks(acc)
+    end
+    
+    def listing_item(invoker, args, prefix, title, heading, level, other_args)
+        v = [heading.level_as_string, title].join(' ') unless heading.plain_caption?
+        s = Deplate::ListItem.new('', v, 'Itemize', 'Itemize', level, 0, true)
+        s
     end
 
     def format_the_index(invoker, name, data, prefix="", flat=false, other_args={})
@@ -536,33 +590,33 @@ class Deplate::Formatter::Plain < Deplate::Formatter
                     f = i.file || invoker.output_file_name(:level_as_string => i.level_as_string,
                                                            :relative => invoker)
                     if f == ff
-                        f = ""
+                        f = ''
                         l = i.level_as_string
                         if l and !l.empty?
                             t = l
                         elsif @deplate.options.multi_file_output
-                            t = "<>"
+                            t = '<>'
                         else
-                            t = "I"
+                            t = 'I'
                         end
                     else
-                        t = @deplate.file_with_suffix(f, "", true)
+                        t = @deplate.file_with_suffix(f, '', true)
                     end
                     acc << t
                 else
-                    log(["Index: Neither file nor level defined: dropping", i.label], :error)
+                    invoker.log(['Index: Neither file nor level defined: dropping', i.label], :error)
                 end
             end
-            s = Deplate::ListItem.new(plain_text(n), acc.join(", "))
-            ot, et = format_list_item(invoker, "Description", 0, s)
+            s = Deplate::ListItem.new(plain_text(n), acc.join(', '))
+            ot, et = format_list_item(invoker, 'Description', 0, s)
             accum << ot
             accum << et unless et == :none
         end
-        accum << format_list_env(invoker, "Description", 0, :close)
+        accum << format_list_env(invoker, 'Description', 0, :close)
         acc = []
-        acc << chars.join(" ")
+        acc << chars.join(' ')
         acc << accum.compact.join("\n")
-        acc << ""
+        acc << ''
         join_blocks(acc)
     end
 end
@@ -570,9 +624,9 @@ end
 
 class Deplate::Command::MAKEBIB
     accumulate_pre(self, Deplate::Formatter::Plain) do |src, array, deplate, text, match, args, cmd|
-        unless args["plain"]
-            n = deplate.msg("Bibliography")
-            m = [nil, "*", n]
+        unless args['plain']
+            n = deplate.msg('Bibliography')
+            m = [nil, '*', n]
             o = Deplate::Element::Heading.new(deplate, src, n, m).finish
             o.update_options(args)
             deplate.options.html_makebib_heading = o
@@ -584,9 +638,9 @@ end
 
 class Deplate::Command::LIST
     accumulate_pre(self, Deplate::Formatter::Plain) do |src, array, deplate, text, match, args, cmd|
-        if text == "index" and !args["plain"] and !args["noTitle"]
-            n = deplate.msg("Index")
-            m = [nil, "*", n]
+        if text == 'index' and !args['plain'] and !args['noTitle']
+            n = deplate.msg('Index')
+            m = [nil, '*', n]
             h = Deplate::Element::Heading.new(deplate, src, n, m).finish
             h.update_options(args)
             array << h