deplate 0.8 → 0.8.1

data/lib/deplate/fmt/htmlsite.rb

@@ -1,10 +1,10 @@
 # htmlsite.rb
-# @Author:      Thomas Link (samul AT web.de)
+# @Author:      Thomas Link (micathom AT gmail com)
 # @Website:     http://deplate.sf.net/
 # @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 # @Created:     17-M�r-2004.
-# @Last Change: 25-Apr-2006.
-# @Revision:    0.1008
+# @Last Change: 2007-09-28.
+# @Revision:    0.1026
 
 require "deplate/fmt/html"
 
@@ -79,8 +79,12 @@ class Deplate::Formatter::HTML_Site < Deplate::Formatter::HTML
     end
 
     def format_heading(invoker)
-        output_at(:body, :inner_body_end, %{</div>\n})
-        [super, %{<div class="pagebody">\n}].join
+        if invoker.is_top_heading?
+            output_at(:body, :inner_body_end, %{</div>\n})
+            [super, %{<div class="pagebody">\n}].join
+        else
+            super
+        end
     end
 
 
@@ -197,7 +201,7 @@ class Deplate::Formatter::HTML_Site < Deplate::Formatter::HTML
         urlp, prv = navbar_button_prev(nil, nil, idx, type, idx > @deplate.home_index)
         url, home = navbar_button_home(nil, nil, idx, type, idx > @deplate.home_index)
         urln, nxt = navbar_button_next(nil, nil, idx, type, idx < @deplate.top_heading_idx)
- 
+
         tabbar = []
         tabbar << invoke_service('navigation_keys', {'next' => urln}) if args['nextKey']
         # tabbar << %{<#{tagsl0} width="#{width}" class="#{style}" summary="Navigation bar">} if tagsl0
@@ -210,7 +214,7 @@ class Deplate::Formatter::HTML_Site < Deplate::Formatter::HTML
             c = htmlsite_tabbar_accum_tags(tagsl2, s, false)
             if @variables['tabBarButtons']
                 buttons = []
-                for b in @variables['tabBarButtons'].split(/[ ,;]/)
+                for b in Deplate::Core.split_list(@variables['tabBarButtons'], ',', '; ')
                     case b
                     when 'home', 'h'
                         buttons << home
@@ -276,14 +280,20 @@ class Deplate::Formatter::HTML_Site < Deplate::Formatter::HTML
             i = invoke_service('progressPercent')
             tabbar << [o, spacer, pb, i, c].compact.join
         end
-        
+       
+        if (about = (args['about'] || @variables['tabBarAbout']))
+            title = @deplate.msg('About this page')
+            html  = %{<a class="tabBarAbout tabBarEntry" href="#{about}">#{title}</a>}
+            tabbar << tabbar_entry(html, tagsl2, "#{style}Inactive #{style}About", tabsize)
+        end
+
         tabbar << htmlsite_tabbar_accum_tags(tagsl1, style, false)
         tabbar << %{</#{tagsl0}>} if tagsl0
         return tabbar.compact.join("\n")
     end
     
     def htmlsite_progress_bar(args, horizontal)
-        idx     = @deplate.output_index
+        idx     = @deplate.output_index || 0
         percent = 100 * idx / @deplate.top_heading_idx
         anti    = 100 - percent
         all     = percent + anti

data/lib/deplate/fmt/htmlslides.rb

@@ -1,5 +1,5 @@
 # fmt-html.rb
-# @Author:      Thomas Link (samul AT web.de)
+# @Author:      Thomas Link (micathom AT gmail com)
 # @Website:     http://deplate.sf.net/
 # @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 # @Created:     17-M�r-2004.

data/lib/deplate/fmt/htmlwebsite.rb

@@ -1,5 +1,5 @@
 # fmt-html.rb
-# @Author:      Thomas Link (samul AT web.de)
+# @Author:      Thomas Link (micathom AT gmail com)
 # @Website:     http://deplate.sf.net/
 # @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 # @Created:     17-M�r-2004.

data/lib/deplate/fmt/latex-dramatist.rb

@@ -0,0 +1,175 @@
+# latex-dramatist.rb
+# @Last Change: 2007-09-30.
+# Author::      Thomas Link (micathom AT gmail com)
+# License::     GPL (see http://www.gnu.org/licenses/gpl.txt)
+# Created::     2007-08-09.
+#
+# = Description
+# = Usage
+# = TODO
+# = CHANGES
+
+require 'deplate/fmt/latex.rb'
+
+class Deplate::Formatter::LaTeX_Dramatist < Deplate::Formatter::LaTeX
+    self.myname = 'latex-dramatist'
+    self.rx     = /(la)?tex(-dramatist)?/i
+    self.related = ['latex']
+
+    self.latexDocClass  = 'book'
+    # self.latexVariables = ['11pt', 'a4paper']
+
+
+    def formatter_initialize_dramatist
+        @ignored_styles << /^play/
+    end
+
+    def prepare_headings
+        @headings  = ['Scene']
+        @headings0 = ['scene']
+    end
+
+    def prepare_dramatist
+        add_package('dramatist')
+        # output_at(:pre, :body_beg, %{\\pagestyle{myheadings}})
+    end
+
+    # +++
+    def format_heading(invoker, level=nil, elt=nil, args=nil)
+        # elt ||= invoker.elt
+        # if elt.empty?
+            args  ||= invoker.args
+            level ||= invoker.level
+            hd     = @headings0[level - 1]
+            mod    = heading_mod(args)
+            cap    = heading_caption(invoker)
+            labels = invoker && format_label(invoker, :string)
+            join_blocks(["\n\\#{hd}#{mod}#{cap}{}", labels])
+        # else
+        #     super
+        # end
+    end
+   
+
+    # Open stage directions.
+    # \StageDir{...}
+    def format_paragraph(invoker)
+        if invoker.args['plain']
+            super
+        else
+            join_blocks([wrap_text("\\StageDir{%s}" % invoker.elt), ""])
+        end
+    end
+
+
+    def format_CAST(invoker)
+        return '\\DramPer{}'
+    end
+
+
+    def format_ACT(invoker)
+        elt = invoker.elt
+        if elt.empty?
+            return '\\act{}'
+        else
+            return '\\Act{%s}' % elt
+        end
+    end
+
+    # * Unordered -> stage directions or cast group
+    # * Descriptions -> dialog or cast
+    #
+    # Cast list:
+    # \Character[NAME]{Name}{name}
+    # \begin{CharacterGroup}{NAME}
+    # \GCharacter[NAME]{Name}{name}
+    # ...
+    # \end{CharacterGroup}
+    # \DramPer
+    #
+    # Dialog:
+    # \namespeaks \direct{...} ...
+    def format_list_item(invoker, type, level, item, args={})
+        indent = format_indent(level, true)
+        ctag   = list_wide? ? '' : :empty
+        explv  = list_item_explicit_value(item)
+        if explv
+            explv = %{[#{explv}]}
+        end
+        case type
+        when 'Itemize'
+            if is_cast?(invoker)
+                return wrap_text("#{indent}\\begin{CharacterGroup}{#{item.body}}", :indent => "  "), "#{indent}\\end{CharacterGroup}"
+            else
+                return wrap_text("#{indent}\\StageDir{#{item.body}}", :indent => "  "), ctag
+            end
+        when 'Description'
+            if is_cast?(invoker)
+                full_name    = [item.item.upcase, item.body].compact.join(', ')
+                display_name = item.item
+                tex_name     = speaker(item.item)
+                if level > 1
+                    char = '%s\\GCharacter{%s}{%s}{%s}'
+                    full_name << ','
+                else
+                    char = '%s\\Character[%s]{%s}{%s}'
+                    full_name << '.'
+                end
+                return wrap_text(char % [indent, full_name, display_name, tex_name], :indent => "  "), ctag
+            else
+                speaker = item.item.sub(/^(\S+)/) {|t| speaker($1) + 'speaks'}
+                return wrap_text("#{indent}\\#{speaker} #{item.body}", :indent => "  "), ctag
+            end
+        else
+            super
+        end
+    end
+
+
+    def is_cast?(invoker)
+        return invoker.args['cast'] || invoker.tagged_as?('cast')
+    end
+
+    
+    def speaker(name)
+        name.downcase
+    end
+
+
+    def format_list_env(invoker, type, level, what, subtype=nil)
+        indent = format_indent(level)
+        if is_cast?(invoker)
+            return ''
+        else
+            case what
+            when :open
+                w    = "begin"
+                if list_wide?
+                    pre  = "\n#{indent}"
+                    post = "\n"
+                else
+                    pre  = indent
+                    post = ""
+                end
+            when :close
+                w    = "end"
+                pre  = indent
+                post = ""
+            end
+            if level == 0 and type == 'Description' and !invoker.args['plain']
+                "#{pre}\\#{w}{drama}#{post}"
+            else
+                ''
+            end
+        end
+    end
+
+
+    # Stage direction
+    # \direct{...}
+    def format_direct(invoker, text=nil)
+        "\\direct{%s}" % (text || invoker.elt || invoker.text)
+    end
+
+end
+

data/lib/deplate/fmt/latex-snippet.rb

@@ -1,5 +1,5 @@
 # latex-snippet.rb
-# @Author:      Thomas Link (samul AT web.de)
+# @Author:      Thomas Link (micathom AT gmail com)
 # @Website:     http://deplate.sf.net/
 # @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 # @Created:     11-Aug-2005.

data/lib/deplate/fmt/latex.rb

@@ -1,10 +1,10 @@
 # fmt-latex.rb
-# @Author:      Thomas Link (samul AT web.de)
+# @Author:      Thomas Link (micathom AT gmail com)
 # @Website:     http://deplate.sf.net/
 # @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 # @Created:     17-M�r-2004.
-# @Last Change: 05-Jun-2006.
-# @Revision:    0.2042
+# @Last Change: 2007-09-30.
+# @Revision:    0.2110
 
 require "deplate/formatter"
 
@@ -31,8 +31,8 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
         :format_anchor,
     ]
 
-    @@latexDocClass   = "article"
-    @@latexVariables = ["11pt", "a4paper"]
+    class_attribute :latexDocClass, 'article'
+    class_attribute :latexVariables, ['11pt', 'a4paper']
 
 
     ################################################ Setup {{{1
@@ -59,26 +59,36 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
                         escaped ? "~" : " "
                     end,
         }
+        @encodings = {
+            'utf-8' => 'utf8',
+        }
         @packages  = {}
         @consumed_preludes = []
         build_plain_text_rx
+        ignore_styles
     end
 
     def prepare
-        @document_class = @deplate.variables['class'] || @@latexDocClass
+        @document_class = @deplate.variables['class'] || self.class.latexDocClass
+        ignore_styles
 
         lco = @deplate.variables['classOptions']
-        lco = lco ? lco.strip.split(/[, ]/) : @@latexVariables
+        lco = lco ? Deplate::Core.split_list(lco.strip, ',', '; ') : self.class.latexVariables
         lang = @deplate.options.messages.prop('lang', self)
+        # p "DBG", lang
         if lang
             lco << lang
         end
 
-        div = @deplate.variables['DIV']
+        div = @deplate.variables['DIV'] || @deplate.variables['typeareaDIV']
         if div
-            # add_package("typearea", "DIV#{div}")
-            add_package('typearea')
-            lco.unshift("DIV#{div}")
+            add_package("typearea", "DIV#{div}")
+        else
+            div = @deplate.variables['DIV_'] || @deplate.variables['typeareaDIV_']
+            if div
+                add_package('typearea')
+                lco.unshift("DIV#{div}")
+            end
         end
 
         lco = lco.uniq.join(',')
@@ -103,10 +113,21 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
 
         output_at(:post, :body_end, "\\end{document}")
     end
-    
+
+    def ignore_styles
+        @ignored_styles ||= []
+        @ignored_styles += Deplate::Core.split_list(@deplate.variables['ignoredStyles']).map {|s| Regexp.new(s)}
+    end
+
     def prepare_headings
-        case @document_class
-        when 'book'
+        as_book = case @document_class
+                  when 'book', 'memoir', 'scrbook', 'report', 'scrreprt'
+                      true
+                  else
+                      bc = @deplate.variables['bookClass']
+                      bc == true || Deplate::Core.split_list(bc).include?(@document_class)
+                  end
+        if as_book
             @headings = ['chapter', 'section', 'subsection', 'subsubsection', 'paragraph', 'subparagraph']
         else
             @headings = ['section', 'subsection', 'subsubsection', 'paragraph', 'subparagraph']
@@ -119,15 +140,16 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
             # 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
+            unless File.exist?(dest)
+                fn = @deplate.find_in_lib(pkg, :pwd => true)
+                if fn
+                    Deplate::Template.copy(@deplate, fn, dest)
+                else
+                    log(['Library file not found', pkg], :error)
+                end
+            end
             @deplate.variables[:deplate_sty] = true
         end
     end
@@ -140,8 +162,8 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
                 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.})
+                                        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|
@@ -174,33 +196,42 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
         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 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)
+            if @ignored_styles.any? {|i| s =~ i}
+                v
+            else
+                s   = clean_style_name(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
-            [pfx, v, sfx].join
         end
     end
     private :wrap_inject
 
+    def clean_style_name(style)
+        style.gsub(/\W(.)/) {|t| $1.capitalize}
+    end
+
     def wrap_accumulate(text, styles, template='\\%sStyle{}')
         styles = styles.collect do |s|
-            l = template % s
+            l = template % clean_style_name(s)
             if block_given?
                 yield(s, l)
             end
@@ -244,7 +275,7 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
             if m
                 pkg = m[4]
                 if m[3]
-                    add_package(pkg, m[3].split(","))
+                    add_package(pkg, m[3].split(/,/))
                 else
                     add_package(pkg)
                 end
@@ -278,7 +309,12 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
             cat  = item.opts[:category]
             due  = item.opts[:due]
             due  = " (#{due})" if due
-            lab  = cat ? "\\task#{cat}{#{cat}#{pri}#{due}}" : "#{cat}#{pri}"
+            if cat
+                task = plain_text([cat, pri, due].join)
+                lab  = "\\task#{cat}{#{task}}"
+            else
+                lab  = plain_text([pri, due].join)
+            end
             body = item.body
             if item.opts[:done]
                 lab  = "\\taskdone{#{lab}}"
@@ -413,7 +449,7 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
     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)
+            Deplate::Core.log([%{Cannot include remote images in current document}, file], :error)
             file = File.basename(file)
         end
         ff = use_image_filename(file, args)
@@ -510,34 +546,38 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
         end
     end
 
+    def include_package?(pkg)
+        @packages.include?(pkg)
+    end
+
 
     ################################################ Elements {{{1
     def format_note(invoker)
         elt    = invoker.elt
         marker = invoker.marker
         case marker
-        when "#"
-            note = "Note"
-        when "+"
-            note = "Elaborate"
-        when "?"
-            note = "Discussion"
-        when "!"
-            note = "Important"
+        when '#'
+            note = 'Note'
+        when '+'
+            note = 'Elaborate'
+        when '?'
+            note = 'Discussion'
+        when '!'
+            note = 'Important'
         else
-            invoker.log(["Unknown marker", marker], :error)
-            note = "Note"
+            invoker.log(['Unknown marker', marker], :error)
+            note = 'Note'
         end
-        note = "%s: " % @deplate.msg(note)
-        size = @deplate.variables["noteSize"] || "footnotesize"
-        "\\protect\\marginpar{\\%s{}%s%s}" % [size, note, elt]
+        note = '%s: ' % @deplate.msg(note)
+        size = @deplate.variables['noteSize'] || 'footnotesize'
+        wrap_text('\\protect\\marginpar{\\%s{}%s%s}' % [size, note, elt])
     end
 
     def format_table(invoker)
         args      = invoker.args
         elt       = invoker.elt
         caption   = invoker.caption
-        capAbove  = caption && (caption.args && caption.args.include?("above") || @deplate.variables["floatCaptionAbove"])
+        capAbove  = caption && (caption.args && caption.args.include?('above') || @deplate.variables['floatCaptionAbove'])
         indent    = format_indent(1)
         dblindent = format_indent(2)
         mode      = :normal
@@ -591,31 +631,34 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
         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
-            cap = ""
-        end
         hd = @headings[level - 1]
-        if args["noList"]
-            mod = "*"
-        else
-            mode = ""
-        end
         if hd
+            cap = heading_caption(invoker)
+            mod = heading_mod(args)
             join_blocks(["\n\\#{hd}#{mod}#{cap}{#{elt}}", labels])
         else
             "\n#{elt}#{labels}: "
         end
     end
 
+    def heading_mod(args)
+        args["noList"] || args["plain"] ? "*" : ""
+    end
+
+    def heading_caption(invoker)
+        caption = invoker && invoker.caption
+        if caption
+            return "[#{caption.elt}]"
+        else
+            return ""
+        end
+    end
+
     def format_list(invoker)
         add_package("hyperref")
         acc = list_wide? ? [""] : []
@@ -782,7 +825,7 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
             # dest = "file://" + File.expand_path(dest)
         # end
         dest = Deplate::HyperLink.url_anchor(dest, anchor)
-        dest.gsub!(/([%#])/, "\\\\\\1")
+        dest.gsub!(/([&%#])/, "\\\\\\1")
         "\\href{%s}{%s}" % [dest, name]
     end
 
@@ -898,7 +941,11 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
     end
 
     def format_linebreak(invoker)
-        return "\\newline{}"
+        if invoker.args['inline']
+            return '\\\\'
+        else
+            return '\\newline{}'
+        end
     end
 
     # Currently assumes the use of natbib
@@ -906,12 +953,15 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
         args    = invoker.args
         elt     = invoker.elt
         add_package('natbib', 'round')
-        n  = args['n']
-        p  = args['p']
-        np = args['np']
-        y  = args['y']
-        c  = elt
-        o  = []
+        n   = args['n']
+        p   = args['p']
+        ip  = args['ip']
+        np  = ip || args['np']
+        y   = args['y']
+        sep = args['sep'] || (np ? '' : '\ ')
+        sep = @deplate.parse_and_format(invoker.container, sep) unless sep.empty?
+        c   = elt
+        o   = []
         o  << "[#{n}]" if n
         if p
             p = @deplate.parse_and_format(invoker.container, "#{@deplate.msg('p.\\ ')}#{p}")
@@ -921,11 +971,13 @@ class Deplate::Formatter::LaTeX < Deplate::Formatter
         end
         o  = o.join unless o.empty?
         if np
-            cmd = if y then "citeyear" else "citealp" end
+            cmd = if y then 'citeyear' else 'citealp' end
+        elsif ip
+            cmd = if y then 'citeyear' else 'citet' end
         else
-            cmd = if y then "citeyearpar" else "citep" end
+            cmd = if y then 'citeyearpar' else 'citep' end
         end
-        return "~\\#{cmd}#{o}{#{c.join(",")}}"
+        return "#{sep}\\#{cmd}#{o}{#{c.join(",")}}"
     end
 
     def format_subscript(invoker)