deplate 0.7.3

data/lib/deplate/messages.rb

@@ -0,0 +1,120 @@
+# mod-en.rb -- Standard messages
+# @Author:      Thomas Link (samul AT web.de)
+# @Website:     http://deplate.sf.net/
+# @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
+# @Created:     07-Mai-2004.
+# @Last Change: 23-Okt-2005.
+# @Revision:    0.193
+
+# The base class for localizations
+class Deplate::Messages
+    class << self
+        def setup(lang)
+            @properties ||= {}
+            @catalog    ||= {}
+            Deplate::Core.module_eval <<-CODE
+                @@messages['#{lang}'] = #{self.name}
+                @@messages_last = #{self.name}
+            CODE
+        end
+
+        # Obsolete. Messages should be defined in a file in the locale 
+        # subdirectory
+        def def_msg(id, text)
+            @catalog[id] = text
+        end
+      
+        # Define a "property" like lang, latex_cmd etc.
+        def def_prop(key, val)
+            @properties[key] = val
+        end
+
+        # Get the localized message with this id
+        def msg(id)
+            case id
+            when Symbol
+                mid = "@#{id}"
+            else
+                mid = id
+            end
+            rv = @catalog[mid] || (id.kind_of?(String) ? id : nil)
+            rv
+        end
+
+        # was property key defined?
+        def has_property?(key)
+            @properties.keys.include?(key)
+        end
+
+        # get property key; check if there exists a specific property for 
+        # the formatter fmt (e.g., latex_lang instead of lang)
+        def prop(key, fmt=nil)
+            if fmt
+                af = [fmt.formatter_name, key].join('_')
+                if has_property?(af)
+                    return @properties[af]
+                end
+            end
+            return @properties[key]
+        end
+
+        # Load the message catalog for lang from the locale subdirectory
+        #
+        # The format is simply (repeating):
+        # MESSAGE/ID/HEAD/KEY
+        # LOCALIZED TEXT
+        # <BLANK LINE>
+        #
+        # Filter out comments -- lines starting with # in the first 
+        # position. Comments can only occur in the head/key position as 
+        # there is no message starting with #.
+        def load_catalog(lang)
+            langs, catalogs = Deplate::Core.collect_deplate_options('locale', 'locale', '')
+            fname = catalogs[lang]
+            if fname
+                cat = []
+                File.open(fname) do |io|
+                    cat = io.readlines
+                end
+                key  = nil
+                text = []
+                for e in cat
+                    e.chomp!
+                    if key
+                        if e =~ /^\s*$/
+                            @catalog[key] = text.join("\n")
+                            key  = nil
+                            text = []
+                        else
+                            text << e
+                        end
+                    elsif e !~ /^#/ and e !~ /^\s*$/
+                        key = e
+                    end
+                end
+            else
+                raise "Unknown language: #{lang} (#{catalogs.keys.join(', ')})"
+            end
+        end
+
+    end
+
+    def initialize(deplate)
+        @deplate = deplate
+        @deplate.variables['encoding'] = prop('encoding')
+        @deplate.options.lang = prop('lang', false)
+    end
+
+    # See Deplate::Messages.msg
+    def msg(key)
+        self.class.msg(key)
+    end
+    
+    # See Deplate::Messages.prop
+    def prop(key, fmt=nil)
+        fmt = @deplate.formatter if fmt.nil?
+        self.class.prop(key, fmt)
+    end
+
+end
+

data/lib/deplate/metadata.rb

@@ -0,0 +1,77 @@
+# metadata.rb
+# @Author:      Thomas Link (samul AT web.de)
+# @Website:     http://deplate.sf.net/
+# @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
+# @Created:     15-Aug-2005.
+# @Last Change: 23-Okt-2005.
+# @Revision:    0.6
+#
+# = Description
+# = Usage
+# = TODO
+# = CHANGES
+
+# require ''
+
+# Metadata: 
+class Deplate::Metadata
+    attr_accessor :metadata
+    
+    def initialize(deplate, output=nil)
+        @deplate  = deplate
+        @output   = output
+        @metadata = {}
+    end
+    
+    def merge_metadata(metadata)
+        if @deplate.options.metadata_model
+            for e in metadata
+                push_metadata(e)
+            end
+        end
+    end
+
+    def push_metadata(data)
+        if @deplate.options.metadata_model
+            type = data["type"]
+            @metadata[type] ||= []
+            @metadata[type] << data
+        end
+    end
+
+    def metadata_available?
+        !@metadata.empty?
+    end
+    
+    def destination(destination=nil)
+        if destination
+            destination
+        elsif @output
+            @output.destination
+        else
+            # <+TBD+>
+            ''
+        end
+    end
+    
+    def metadata_destination(master_file=nil)
+        dest = destination(master_file)
+        Deplate::Core.canonic_file_name(dest, @deplate.options.metadata_suffix)
+    end
+
+    def format_metadata(metadata=@metadata)
+        unless metadata.nil? or metadata.empty?
+            for type, value in metadata
+                if value
+                    for e in value
+                        e['file'] = destination.dup
+                    end
+                end
+            end
+            metadata['creator'] = 'deplate'
+            metadata['creator_version'] = Deplate::Core.version
+            @deplate.dump_metadata(metadata)
+        end
+    end
+end
+

data/lib/deplate/metadata/marshal.rb

@@ -0,0 +1,24 @@
+# yaml.rb
+# @Author:      Thomas Link (samul AT web.de)
+# @Website:     http://deplate.sf.net/
+# @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
+# @Created:     20-M�r-2005.
+# @Last Change: 23-Okt-2005.
+# @Revision:    0.13
+#
+# = Description
+# = Usage
+# = TODO
+# = CHANGES
+
+class Deplate::Core
+    def module_initialize_metadata_marshal
+        @options.metadata_model  = "marshal"
+        @options.metadata_suffix = ".dat"
+    end
+
+    def put_metadata(io, metadata)
+        Marshal.dump(metadata, io)
+    end
+end
+

data/lib/deplate/metadata/xml.rb

@@ -0,0 +1,42 @@
+# xml.rb
+# @Author:      Thomas Link (samul AT web.de)
+# @Website:     http://deplate.sf.net/
+# @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
+# @Created:     20-M�r-2005.
+# @Last Change: 23-Okt-2005.
+# @Revision:    0.29
+#
+# = Description
+# = Usage
+# = TODO
+# = CHANGES
+
+require 'rexml/document'
+
+class Deplate::Core
+    def module_initialize_metadata_marshal
+        @options.metadata_model  = "xml"
+        @options.metadata_suffix = ".xml"
+        @options.metadata_xml = REXML::Document.new <<EOXML
+<deplate>
+</deplate>
+EOXML
+        @options.metadata_xml << REXML::XMLDecl.new
+    end
+
+    def put_metadata(io, metadata)
+        @options.metadata_xml.write(io, 2)
+    end
+    
+    alias :push_metadata_re_metadata_xml :push_metadata
+    def push_metadata(data, array=@metadata)
+        if @options.metadata_model
+            type = data["type"]
+            d    = data.dup
+            d.delete('type')
+            @options.metadata_xml.root.add_element(type, d)
+            push_metadata_re_metadata_xml(data, array)
+        end
+    end
+end
+

data/lib/deplate/metadata/yaml.rb

@@ -0,0 +1,26 @@
+# yaml.rb
+# @Author:      Thomas Link (samul AT web.de)
+# @Website:     http://deplate.sf.net/
+# @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
+# @Created:     20-M�r-2005.
+# @Last Change: 23-Okt-2005.
+# @Revision:    0.10
+#
+# = Description
+# = Usage
+# = TODO
+# = CHANGES
+
+require 'yaml'
+
+class Deplate::Core
+    def module_initialize_metadata_yaml
+        @options.metadata_model  = "yaml"
+        @options.metadata_suffix = ".yml"
+    end
+
+    def dump_metadata(data)
+        YAML.dump(data)
+    end
+end
+

data/lib/deplate/mod/anyword.rb

@@ -0,0 +1,56 @@
+# anyword.rb
+# @Author:      Thomas Link (samul AT web.de)
+# @Website:     http://deplate.sf.net/
+# @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
+# @Created:     11-Sep-2004.
+# @Last Change: 23-Okt-2005.
+# @Revision:    0.93
+
+class Deplate::Core
+    def module_initialize_anyword
+        list = @variables["anyword_list"]
+        acc  = list ? list.split(/\s*,\s*/) : []
+
+        cat  = @variables["anyword_catalog"]
+        if cat
+            acc += File.open(cat) do |io|
+                io.readlines.collect {|l| l.chomp}
+            end
+        end
+
+        suffix  = @variables["anyword_suffix"] || ""
+
+        pattern = @variables["anyword_pattern"]
+        if pattern
+            acc += Dir[pattern].collect {|f| File.basename(f, suffix)}
+        end
+
+        unless list or cat or pattern
+            files = @options.files.collect do |src|
+                Dir[File.join(File.dirname(src), "*" + suffix)]
+            end
+            acc += files.flatten.collect {|f| File.basename(f, suffix)}
+        end
+        
+        rx  = acc.collect {|n| "(?i:\\b%s\\b)" % Regexp.escape(n)}.join("|")
+        body = <<-EOR
+            @rx = /^#{rx}/
+            def setup_element
+                @inter   = nil
+                @literal = nil
+                @anchor  = ""
+                @dest    = @match[0]
+                @name    = @dest
+                idx      = [@deplate.add_index(self, @name)]
+                @idx     = indexing(idx)
+            end
+            def process
+                @name = @deplate.formatter.plain_text(Deplate::Core.remove_backslashes(@name))
+                @elt = [@name, @dest, @anchor]
+                super
+            end
+        EOR
+        cls = Deplate::Cache.particle(deplate, body, :register => true)
+    end
+end
+

data/lib/deplate/mod/babelfish.rb

@@ -0,0 +1,27 @@
+# babelfish.rb
+# @Author:      Thomas Link (samul AT web.de)
+# @Website:     http://deplate.sf.net/
+# @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
+# @Created:     05-Sep-2004.
+# @Last Change: 23-Okt-2005.
+# @Revision:    0.21
+# 
+# Description:
+# 
+# Usage:
+# 
+# TODO:
+# 
+# CHANGES:
+# 
+
+class Deplate::Formatter::HTML
+    def prepare_babelfish
+        if @deplate.formatter.matches?("html")
+            babel = %{<script type="text/javascript" language="JavaScript1.2" src="http://www.altavista.com/r?entr"></script>}
+            # babel = %{<script type="text/javascript" language="JavaScript1.2" src="http://www.altavista.com/r?inc_translate"></script>}
+            output_at(:post, :pre_body_end, %{<div align="right" class="pageicons">%s</div>} % babel)
+        end
+    end
+end
+

data/lib/deplate/mod/code-gvim.rb

@@ -0,0 +1,52 @@
+# code-gvim.rb
+# @Author:      Thomas Link (samul AT web.de)
+# @Website:     http://deplate.sf.net/
+# @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
+# @Created:     26-Feb-2005.
+# @Last Change: 23-Okt-2005.
+# @Revision:    0.93
+# 
+# = Description
+# This module provides a specialized syntax highlighter using gvim. Adds 
+# Deplate::Regions::Code#gvim_to_html.
+# 
+# = Usage
+# = TODO
+# = CHANGES
+
+require 'fileutils'
+require 'tmpdir'
+
+class Deplate::Regions::Code
+    add_highlighter(nil, "html",       :gvim_to_html)
+    add_highlighter(nil, "htmlslides", :gvim_to_html)
+    add_highlighter(nil, "htmlsite",   :gvim_to_html)
+    
+    def gvim_to_html(syntax, style, text)
+        unless @deplate.options.allow_external
+            return
+        end
+        gvim = %{#{Deplate::External.get_app('gvim')} -f +"syn on" +"let use_xhtml = 1" +"setf #{syntax}" +"colorscheme #{style || "default"}" +"run! syntax/2html.vim" +"wq" +"q" deplateGvim}
+        @deplate.in_working_dir(Dir.tmpdir) do
+            FileUtils.rm("deplateGvim.html") if File.exist?("deplateGvim.html")
+            Deplate::External.write_file(self, "deplateGvim") {|io| io.puts(text)}
+            IO.popen(gvim) {|io| puts io.gets until io.eof }
+            if File.exist?("deplateGvim.html")
+                rv = [%{<div class="code">}]
+                File.open("deplateGvim.html") do |io|
+                    until io.eof?
+                        line = io.gets
+                        line.chomp!
+                        rv << line if line =~ /^<pre>$/ .. line =~ /^<\/pre\>$/
+                    end
+                end
+                rv << %{</div>}
+                return rv.join("\n")
+            else
+                log("Error when running gvim", :error)
+            end
+        end
+        return nil
+    end
+end
+

data/lib/deplate/mod/code-highlight.rb

@@ -0,0 +1,91 @@
+# code-highlight.rb
+# @Author:      Thomas Link (samul AT web.de)
+# @Website:     http://deplate.sf.net/
+# @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
+# @Created:     27-Feb-2005.
+# @Last Change: 23-Okt-2005.
+# @Revision:    0.41
+#
+# = Description
+# Highlight code regions using Andr� Simon's 
+# highlight[http://www.andre-simon.de/]. Adds 
+# Deplate::Regions::Code#highlight.
+# 
+# = Usage
+# = TODO
+# = CHANGES
+
+
+class Deplate::Formatter::LaTeX
+    def hook_code_process_highlight(style)
+        unless @deplate.options.did_highlight_init
+            style_ext = Deplate::Regions::Code::get_style_ext(style)
+            add_package(%{color})
+            add_package(%{alltt})
+            add_package(%{highlight#{style_ext}})
+            @deplate.options.did_highlight_init = true
+        end
+    end
+end
+
+class Deplate::Regions::Code
+    add_highlighter(nil, "html",       :highlight)
+    add_highlighter(nil, "htmlslides", :highlight)
+    add_highlighter(nil, "xhtml",      :highlight)
+    add_highlighter(nil, "latex",      :highlight)
+
+    class << self
+        def get_style_ext(style)
+            style_ext = style ? "-#{style}" : nil
+        end
+    end
+    
+    def highlight(syntax, style, text)
+        unless @deplate.options.allow_external
+            return
+        end
+        formatter = @deplate.formatter
+        style_ext = Deplate::Regions::Code::get_style_ext(style)
+        if defined?(Deplate::Formatter::XHTML10transitional) and formatter.kind_of?(Deplate::Formatter::XHTML10transitional)
+            mode      = :xhtml
+            args      = "--xhtml"
+            style_out = "highlight#{style_ext}.css"
+        elsif defined?(Deplate::Formatter::HTML) and formatter.kind_of?(Deplate::Formatter::HTML)
+            mode      = :html
+            args      = "--css-outfile=highlight#{style_ext}.css"
+            style_out = "highlight#{style_ext}.css"
+            css       = formatter.head_link_tag(%{rel="stylesheet" type="text/css" href="#{style_out}"})
+            log(["Code: You need to copy highlight's style definition", "highlight#{style_ext}.css"], :anyway)
+            @postponed_format << Proc.new do |container|
+                container.deplate.formatter.union_at(:pre, :css, css)
+            end
+        elsif defined?(Deplate::Formatter::LaTeX) and formatter.kind_of?(Deplate::Formatter::LaTeX)
+            mode      = :latex
+            args      = "--latex"
+            style_out = "highlight#{style_ext}.sty"
+            log(["Code: You need to copy highlight's style definition", "highlight#{style_ext}.sty"], :anyway)
+        elsif defined?(Deplate::Formatter::Docbook) and formatter.kind_of?(Deplate::Formatter::Docbook)
+            log("Code: ''highlight'' doesn't support docbook!", :error)
+            return nil
+        else
+            log("Code: ''highlight'' can't create output for this formatter!", :error)
+            return nil
+        end
+        if style
+            style = %{--style=#{style}}
+        end
+        tw  = @deplate.variables["tabwidth"] || 4
+        cmd = "#{Deplate::External.get_app('highlight')} --fragment --wrap --replace-tabs=#{tw} --syntax #{syntax} --style-outfile=#{style_out} #{style} #{args}"
+        Deplate::External.log_popen(self, cmd) do |io|
+            io.puts(text)
+            io.close_write
+            text = io.read
+        end
+        case mode
+        when :html, :xhtml
+            text = [%{<div class="code">}, "<pre>", text, "</pre>", %{</div>}].join
+        end
+        return text
+    end
+end
+