deplate 0.7.3 → 0.8

data/lib/deplate/fmt/htmlwebsite.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.441
+# @Last Change: 02-Apr-2006.
+# @Revision:    0.442
 
 require "deplate/fmt/htmlslides"
 
@@ -47,7 +47,7 @@ EOF
         idx, _, _ = navbar_output_index(invoker, first, last)
         navextra = @deplate.get_clip("navextra")
         navmenu  = [%{<span class="navmenuhead">#{navextra.elt if navextra}</span>} ]
-        @deplate.each_heading(1) do |section, title|
+        @deplate.each_heading(:top) do |section, title|
             unless section.args["noList"]
                 f = section.output_file_name(:basename => true)
                 v = section.description.gsub(/<\/?[^>]*>/, "")

data/lib/deplate/fmt/latex.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: 02-Nov-2005.
-# @Revision:    0.1817
+# @Last Change: 05-Jun-2006.
+# @Revision:    0.2042
 
 require "deplate/formatter"
 
@@ -65,26 +65,29 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
     end
 
     def prepare
-        @document_class = @deplate.variables["class"] || @@latexDocClass
+        @document_class = @deplate.variables['class'] || @@latexDocClass
 
-        lco = @deplate.variables["classOptions"]
+        lco = @deplate.variables['classOptions']
         lco = lco ? lco.strip.split(/[, ]/) : @@latexVariables
         lang = @deplate.options.messages.prop('lang', self)
         if lang
             lco << lang
         end
-        lco = lco.uniq.join(",")
 
+        div = @deplate.variables['DIV']
+        if div
+            # add_package("typearea", "DIV#{div}")
+            add_package('typearea')
+            lco.unshift("DIV#{div}")
+        end
+
+        lco = lco.uniq.join(',')
         output_at(:pre, :doc_def, "\\documentclass[#{lco}]{#{@document_class}}")
 
         set_document_encoding
         
-        @booktabs = @deplate.variables["useBooktabs"]
-        add_package("booktabs") if @booktabs
-
-
-        div = @deplate.variables["DIV"]
-        add_package("typearea", "DIV#{div}") if div
+        @booktabs = @deplate.variables['useBooktabs']
+        add_package('booktabs') if @booktabs
 
         lang_cmd = @deplate.options.messages.prop('lang_cmd', self)
         if lang_cmd
@@ -103,13 +106,112 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
     
     def prepare_headings
         case @document_class
-        when "book"
-            @headings = ["chapter", "section", "subsection", "subsubsection", "paragraph", "subparagraph"]
+        when 'book'
+            @headings = ['chapter', 'section', 'subsection', 'subsubsection', 'paragraph', 'subparagraph']
         else
-            @headings = ["section", "subsection", "subsubsection", "paragraph", "subparagraph"]
+            @headings = ['section', 'subsection', 'subsubsection', 'paragraph', 'subparagraph']
+        end
+    end
+
+    def initialize_deplate_sty
+        unless @deplate.variables[:deplate_sty]
+            add_package('color')
+            # add_package('ulem')
+            add_package('deplate')
+            pkg  = 'deplate.sty'
+            fn   = @deplate.find_in_lib(pkg, :pwd => true)
+            dir  = File.dirname(output_destination)
+            dest = File.join(dir, pkg)
+            # @deplate.copy_file(fn, dest)
+            Deplate::Template.copy(@deplate, fn, dest)
+            # if fn
+            #     lines = File.read(fn) {|io| io.readlines}
+            #     output_at(:pre, :styles, lines)
+            # end
+            @deplate.variables[:deplate_sty] = true
+        end
+    end
+
+    def wrap_formatted_particle_styles(invoker, value, args)
+        s = args[:styles]
+        unless s.empty?
+            initialize_deplate_sty
+            # if preferred_style_markup(invoker, 'particle', 'span')
+                value = wrap_inject(value, s,
+                                    :spre => '\\%sSpan{',
+                                    :post => '}') do |s, pre, post|
+                    ltx = '%s}' % pre.strip
+                    @deplate.endmessage(ltx, %{You might need to define #{ltx} in deplate.sty.})
+                                    end
+            # else
+            #     value = wrap_accumulate(value, args[:styles]) do |s, ltx|
+            #         ltx = ltx.strip
+            #         @deplate.endmessage(ltx, %{You might need to define #{ltx} in deplate.sty.})
+            #     end
+            # end
+        end
+        value
+    end
+
+    def wrap_formatted_element_styles(invoker, value, args)
+        s = args[:styles]
+        unless s.empty?
+            initialize_deplate_sty
+            # if preferred_style_markup(invoker, 'element', 'block')
+                value = wrap_inject(value, s,
+                                    :spre => "\\begin{%sBlock}\n",
+                                    :spost => "\\end{%sBlock}\n") do |s, pre, post|
+                    ltx = '%sBlock' % s.strip
+                    @deplate.endmessage(ltx, %{You might need to define the #{ltx} environment in deplate.sty.})
+                                    end
+            # else
+            #     value = wrap_accumulate(value, args[:styles]) do |s, ltx|
+            #         ltx = ltx.strip
+            #         @deplate.endmessage(ltx, %{You might need to define #{ltx} in deplate.sty.})
+            #     end
+            # end
+        end
+        value
+    end
+    
+    def preferred_style_markup(invoker, what, style)
+        what = "#{what}Style"
+        (invoker.args[what] || @deplate.variables[what]) == style
+    end
+    private :preferred_style_markup
+    
+    def wrap_inject(text, styles, args={})
+        styles.inject(text) do |v, s|
+            pfx = args[:pre]
+            unless pfx
+                pfx = args[:spre] % s
+            end
+            sfx = args[:post]
+            unless sfx
+                sfx = args[:spost] % s
+            end
+            if block_given?
+                yield(s, pfx, sfx)
+            end
+            [pfx, v, sfx].join
         end
     end
+    private :wrap_inject
 
+    def wrap_accumulate(text, styles, template='\\%sStyle{}')
+        styles = styles.collect do |s|
+            l = template % s
+            if block_given?
+                yield(s, l)
+            end
+            l
+        end
+        text.sub(/\A(\s*)(.*?)(\s*)\Z/m) do |m|
+            %{#$1{#{styles}#$2}#$3}
+        end
+    end
+    private :wrap_accumulate
+    
     def wrap_text(text, args={})
         args[:check] ||= lambda do |line|
             mt = /\\verb(.)/.match(line)
@@ -154,7 +256,7 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
     
 
     ################################################ Lists {{{1
-    def format_list_item(invoker, type, level, item)
+    def format_list_item(invoker, type, level, item, args={})
         indent = format_indent(level, true)
         ctag   = list_wide? ? '' : :empty
         explv  = list_item_explicit_value(item)
@@ -162,17 +264,36 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
             explv = %{[#{explv}]}
         end
         case type
-        when "Numbered"
+        when "Ordered"
             return wrap_text("#{indent}\\item#{explv} #{item.body}", :indent => "  "), ctag
         when "Itemize"
             return wrap_text("#{indent}\\item #{item.body}", :indent => "  "), ctag
         when "Description"
             return wrap_text("#{indent}\\item[#{item.item}] #{item.body}", :indent => "  "), ctag
+        when 'Custom'
+            t = item.opts[:custom]
+            return wrap_text("#{indent}\\#{t}Item{#{item.item}}{#{item.body}}", :indent => "  "), ctag
+        when 'Task'
+            pri  = item.opts[:priority]
+            cat  = item.opts[:category]
+            due  = item.opts[:due]
+            due  = " (#{due})" if due
+            lab  = cat ? "\\task#{cat}{#{cat}#{pri}#{due}}" : "#{cat}#{pri}"
+            body = item.body
+            if item.opts[:done]
+                lab  = "\\taskdone{#{lab}}"
+                body = "\\taskdone{#{body}}"
+            end
+            it   = "#{indent}\\task{#{lab}}{#{body}}"
+            return wrap_text(it, :indent => "  "), nil
         when "Paragraph"
             fs = list_wide? ? "\n%s\n" : "\n%s"
             return fs % wrap_text("#{indent}#{item.body}", :indent => "  "), nil
+        when 'Container'
+            fs = list_wide? ? "\n%s\n" : "\n%s"
+            return fs % item.body, nil
         else
-            raise "Unknown list type: #{item.inspect}"
+            invoker.log(['Unknown list type', type], :error)
         end
     end
     
@@ -194,7 +315,7 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
             post = ""
         end
         case type
-        when "Numbered"
+        when "Ordered"
             case subtype
             when "a", "A"
                 return format_list_enumerate_alpha(invoker, what, subtype, w, pre, post)
@@ -203,10 +324,16 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
             end
         when "Itemize"
             return "#{pre}\\#{w}{itemize}#{post}"
+        when 'Task'
+            initialize_deplate_sty
+            return "#{pre}\\#{w}{tasklist}#{post}"
+        when 'Custom'
+            initialize_deplate_sty
+            return "#{pre}\\#{w}{#{subtype}List}#{post}"
         when "Description"
             return "#{pre}\\#{w}{description}#{post}"
         else
-            raise "Unknown list type: #{self.inspect}"
+            invoker.log(['Unknown list type', type], :error)
         end
     end
 
@@ -241,17 +368,17 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
         caption = invoker.caption
         acc = []
         if inline
-            acc << include_image(elt, args, true)
+            acc << include_image(invoker, elt, args, true)
         else
             floatPos, alignCmd = float_options(invoker)
             in_env   = !(args["inline"] || @deplate.variables["imgInline"])
             in_env &&= floatPos || alignCmd || caption
             if in_env
                 acc << figure_top(invoker)
-                acc << include_image(elt, args)
+                acc << include_image(invoker, elt, args)
                 acc << figure_bottom(invoker)
             else
-                acc << include_image(elt, args)
+                acc << include_image(invoker, elt, args)
                 acc << format_label(invoker, :once)
             end
         end
@@ -283,25 +410,18 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
         join_blocks(acc)
     end
     
-    def include_image(file, options, inline=false)
-        ff   = ""
-        o    = []
+    def include_image(invoker, file, args, inline=false)
+        file = args['file'] if args['file']
+        if file =~ Deplate::HyperLink::Url.rx
+            Deplate::Core.log([%{Can't include remote images in current document}, file], :error)
+            file = File.basename(file)
+        end
+        ff = use_image_filename(file, args)
+        o  = []
         bw, bh, bx, by, desc = nil
         @deplate.in_working_dir do
-            f  = file[0..-(File.extname(file).size + 1)]
-            ls = Dir[File.join("%s.*" % f)]
-            suffixes = image_suffixes
-            catch(:found) do
-                for sfx in suffixes
-                    ff = f + sfx
-                    if ls.include?(ff)
-                        throw :found
-                    end
-                end
-                ff = file
-            end
-            bw = options["bw"]
-            bh = options["bh"]
+            bw = args['bw']
+            bh = args['bh']
             desc = Deplate::External.image_dimension(ff)
             unless (bw and bh) or @deplate.options.pdftex
                 bw, bh, bx, by = desc[:bw]
@@ -310,7 +430,7 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
         unless @deplate.options.pdftex
             o << "bb=0 0 #{bw || "100"} #{bh || "100"}"
         end
-        width = options["w"] || options["width"]
+        width = args['w'] || args['width']
         if width
             if width =~ /^\d+%$/
                 width = width.to_f / 100
@@ -331,7 +451,7 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
                 end
             end
         end
-        height = options["h"]
+        height = args['h']
         if height
             if height =~ /^\d+%$/
                 height = height.to_f / 100
@@ -342,13 +462,13 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
                 o << "height=#{height}pt"
             end
         end
-        o = o.join(",")
+        o = o.join(',')
         if !o.empty?
-            o = "[" + o + "]"
+            o = "[#{o}]"
         end
-        add_package("graphicx")
+        add_package('graphicx')
         rv  = "\\includegraphics#{o}{#{ff}}"
-        rot = options["rotate"] || @deplate.variables["imgRotate"]
+        rot = args['rotate'] || @deplate.variables['imgRotate']
         if rot
             rv = %{\\rotatebox{#{rot}}{#{rv}}}
         end
@@ -357,9 +477,9 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
 
     def image_suffixes
         if @deplate.options.pdftex
-            [".pdf", ".jpeg", ".jpg", ".png", ".gif", ".bmp"]
+            ['.pdf', '.jpeg', '.jpg', '.png', '.gif', '.bmp']
         else
-            [".eps", ".ps", ".jpeg", ".jpg", ".png", ".gif", ".bmp"]
+            ['.eps', '.ps', '.jpeg', '.jpg', '.png', '.gif', '.bmp']
         end
     end
     
@@ -367,20 +487,20 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
         pkg_previous = @packages[pkg]
         if pkg_previous
             if options != pkg_previous
-                log(["Already required package with different options", pkg, pkg_previous, options], :error)
+                log(['Already required package with different options', pkg, pkg_previous, options], :error)
             end
             return
         else
             @packages[pkg] = options.dup
             case pkg
-            when "hyperref", "graphicx"
+            when 'hyperref', 'graphicx'
                 if @deplate.options.pdftex
-                    options << "pdftex"
+                    options << 'pdftex'
                 end
             end
             
             unless options.empty?
-                options = "[" + options.join(",") + "]"
+                options = "[#{options.join(',')}]"
             end
             if pkg =~ /\.\w+$/
                 output_at(:pre, :user_packages, "\\input{#{pkg}}")
@@ -405,7 +525,7 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
         when "!"
             note = "Important"
         else
-            Deplate::Core.log(["Unknown marker", marker], :error)
+            invoker.log(["Unknown marker", marker], :error)
             note = "Note"
         end
         note = "%s: " % @deplate.msg(note)
@@ -466,11 +586,18 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
         join_blocks(acc)
     end
 
-    def format_heading(invoker)
-        args    = invoker.args
-        elt     = invoker.elt
-        caption = invoker.caption
-        level   = invoker.level
+    def format_heading(invoker, level=nil, elt=nil, args=nil)
+        args  ||= invoker.args
+        level ||= invoker.level
+        elt   ||= invoker.elt
+        if invoker
+            caption = invoker.caption
+            invoker.label << args[:id]
+            labels = format_label(invoker, :string)
+        else
+            caption = nil
+            labels  = nil
+        end
         if caption
             cap = "[#{caption.elt}]"
         else
@@ -482,8 +609,6 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
         else
             mode = ""
         end
-        invoker.label << args[:id]
-        labels = format_label(invoker, :string)
         if hd
             join_blocks(["\n\\#{hd}#{mod}#{cap}{#{elt}}", labels])
         else
@@ -542,7 +667,7 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
                     header = e.format_current
                 elsif e.kind_of?(Deplate::Element::Table)
                     if e.elt.size > 1
-                        log("Only the header's first row will be used", :error)
+                        invoker.log("Only the header's first row will be used", :error)
                     end
                     header = e.elt[0].cols.collect{|c| c.cell}
                     while header.last.empty?
@@ -558,7 +683,7 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
             end
         end
         elts = "%s %s" % [elt.size, elt.collect {|e| e.class}.join(", ")]
-        log(["Header must contain only 1 element (a paragraph or a table)", elts], :error)
+        invoker.log(["Header must contain only 1 element (a paragraph or a table)", elts], :error)
     end
 
     def format_footer(invoker)
@@ -609,7 +734,8 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
                     acc << c % elt
                 end
             end
-            acc << "\\maketitle\n" if elts.include?("title") and elts.include?("author")
+            acc << "\\maketitle\n" if elts.include?("title")
+            # and elts.include?("author")
             kw = keywords
             acc << %{#{@deplate.msg("Keywords:")} #{kw.join(", ")}} << "" if kw
         # end
@@ -622,7 +748,10 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
 
     def format_MAKEBIB(invoker)
         style = invoker.elt
-        bib = @deplate.options.bib.collect{|f| File.basename(f, ".bib")}.join(",")
+        if style.empty?
+            style = @deplate.variables['bibStyle']
+        end
+        bib   = @deplate.options.bib.collect{|f| File.basename(f, ".bib")}.join(",")
         "\\bibliographystyle{#{style}}\n\\bibliography{#{bib}}\n"
     end
     alias :format_bibliography :format_MAKEBIB
@@ -637,11 +766,13 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
 
 
     ################################################ Particles {{{1
-    def format_emphasize(invoker, text)
+    def format_emphasize(invoker, text=nil)
+        text ||= invoker.elt || invoker.text
         "\\emph{%s}" % text
     end
     
-    def format_code(invoker, text)
+    def format_code(invoker, text=nil)
+        text ||= invoker.elt || invoker.text
         "\\texttt{%s}" % plain_text(text, true)
     end
     
@@ -658,7 +789,7 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
     def format_wiki(invoker, name, dest, anchor)
         add_package("hyperref")
         if dest and !dest.empty?
-            log(["Wiki name as url", dest], :debug)
+            invoker.log(["Wiki name as url", dest], :debug)
             format_url(invoker, name, dest, anchor)
         else
             # "%s~($\\Rightarrow{}$\\pageref{%s})" % [plain_text(name), anchor]
@@ -745,22 +876,24 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
     def format_footnote(invoker)
         elt = invoker.elt
         if elt
-            fn = elt.elt
-            return "\\footnote{#{fn.body}}"
-        else
-            return ""
+            body = elt.format_current
+            if body
+                return "\\footnote{#{body.rstrip}}"
+            end
         end
+        return ''
     end
 
     def format_ref(invoker)
-        add_package("hyperref")
+        add_package('hyperref')
         args = invoker.args
         text = invoker.text
-        p = args["p"]
+        p = args['p']
+        prefix = invoker.args['prefix'] || '~'
         if p
-            return "~\\pageref{#{text}}"
+            return "#{prefix}\\pageref{#{text}}"
         else
-            return "~\\ref{#{text}}"
+            return "#{prefix}\\ref{#{text}}"
         end
     end
 
@@ -772,11 +905,11 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
     def format_cite(invoker)
         args    = invoker.args
         elt     = invoker.elt
-        add_package("natbib", "round")
-        n  = args["n"]
-        p  = args["p"]
-        np = args["np"]
-        y  = args["y"]
+        add_package('natbib', 'round')
+        n  = args['n']
+        p  = args['p']
+        np = args['np']
+        y  = args['y']
         c  = elt
         o  = []
         o  << "[#{n}]" if n
@@ -867,16 +1000,15 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
  
     
     ################################################ List of ... {{{1
-    def format_list_of_contents(invoker)
+    def format_list_of_toc(invoker)
         "\\tableofcontents{}"
     end
-    alias format_list_of_toc format_list_of_contents
 
-    def format_list_of_tables(invoker)
+    def format_list_of_lot(invoker)
         "\\listoftables{}"
     end
     
-    def format_list_of_figures(invoker)
+    def format_list_of_lof(invoker)
         "\\listoffigures{}"
     end
 
@@ -886,6 +1018,33 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
         "\\printindex{}"
     end
 
+    def listing_prematter(invoker, args, id)
+        type = args[:prefix]
+        @deplate.endmessage("listing_#{type}", %{You might need to edit deplate.sty and define the environment #{type}List and the command \\#{type}Item.}
+                                )
+        nil
+    end
+    
+    def listing_postmatter(invoker, args)
+        ''
+    end
+    
+    def listing_title(invoker, args, name)
+        if name
+            format_heading(nil, 1, @deplate.msg(name), {'noList' => true})
+        end
+    end
+    
+    def listing_item(invoker, args, prefix, title, heading, level, other_args)
+        b = title
+        # <+TBD+> Hyperlinks
+        # use latex contents infrastructure?
+        i = heading.plain_caption? ? nil : heading.level_as_string
+        s = Deplate::ListItem.new(i, b, "Custom", "Custom", level, 0, true)
+        s.opts = {:subtype => prefix, :custom => prefix}
+        s
+    end
+    
 
     ################################################ Table {{{1
     def table_indented_row(invoker, row, indent, cells)