deplate 0.7.3

data/lib/deplate/fmt/htmlsite.rb

@@ -0,0 +1,419 @@
+# htmlsite.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: 01-Nov-2005.
+# @Revision:    0.910
+
+require "deplate/fmt/html"
+
+# A variant of the html-formatter that suppresses paragraphs and creates new 
+# files on page breaks and level-1 headings.
+#
+# Press a-n or double-click on a heading to jump to the next slide. Press a-b 
+# to jump to the previous one.
+# 
+
+class Deplate::Formatter::HTML_Site < Deplate::Formatter::HTML
+    self.myname = "htmlsite"
+    self.rx     = /html?|htmlwebsite/i
+
+    def hook_pre_body_flush_html_pager
+        title = @deplate.get_clip("title")
+        title = title.elt if title
+        top   = @deplate.output.top_heading
+        if top
+            top_title = top.description
+            if top_title
+                title = clean_tags([title, top_title].compact.join(" -- "))
+                set_at(:pre, :head_title, %{<title>%s</title>} % title) unless title.empty?
+            end
+        end
+        
+        invoker = nil
+        navbar  = @deplate.variables["docNavbar"]
+        if navbar
+            case navbar
+            when "top"
+                format_navigation_bar(invoker, :body, :navbar_top,    :top)
+            when "bottom"
+                format_navigation_bar(invoker, :body, :navbar_bottom, :bottom)
+            else
+                format_navigation_bar(invoker, :body, :navbar_top,    :top)
+                format_navigation_bar(invoker, :body, :navbar_bottom, :bottom)
+            end
+        end
+
+        set_relation(:htmlsite_prev, "Prev", "previous")
+        set_relation(:htmlsite_next, "Next", "next")
+        set_relation(:htmlsite_up,   "Home", "up") if @variables["@idx"].to_i > 0
+    end
+
+    def set_relation(slot, service_infix, tag)
+        url = @deplate.invoke_service("page#{service_infix}Dest")
+        if url
+            title = @deplate.invoke_service("page#{service_infix}Title") || tag
+            title = clean_tags(title)
+            set_at(:pre, slot, head_link_tag(%{rel="#{tag}" href="#{url}" title="#{title}"}))
+        end
+    end
+        
+    def setup
+        @deplate.options.multi_file_output = true if @deplate.options.multi_file_output.nil?
+        super
+    end
+
+    # for web sites, a pagebreak means navigation bars + a new file
+    def format_pagebreak(invoker, html_class=nil, major=false)
+        if major
+            invoker.postponed_format << lambda {|e| @deplate.break_output}
+            unless @deplate.body_empty?
+                return format_label(invoker, :closeOpen)
+            end
+            return nil
+        else
+            return super
+        end
+    end
+
+end
+
+class Deplate::Core
+    def formatter_initialize_htmlsite
+        @max_headings = nil
+        @doc_services["tabBarNote"]            = :htmlsite_tabBarNote
+        @doc_services["tabBarLeft"]            = :htmlsite_tabBarLeft
+        @doc_services["tabBarRight"]           = :htmlsite_tabBarRight
+        @doc_services["tabBarTop"]             = :htmlsite_tabBarTop
+        @doc_services["tabBarBottom"]          = :htmlsite_tabBarBottom
+        @doc_services["progressPercent"]       = :htmlsite_progressPercent
+        @doc_services["progressPages"]         = :htmlsite_progressPages
+        @doc_services["progressFirst"]         = :htmlsite_progressFirst
+        @doc_services["progressLast"]          = :htmlsite_progressLast
+        @doc_services["progressBar"]           = :htmlsite_progressBar
+        @doc_services["progressBarHorizontal"] = :htmlsite_progressBarHorizontal
+        @doc_services["progressBarVertical"]   = :htmlsite_progressBarVertical
+        @doc_services["pageNextDest"]          = :htmlsite_pageNextDest
+        @doc_services["pageNextTitle"]         = :htmlsite_pageNextTitle
+        @doc_services["pagePrevDest"]          = :htmlsite_pagePrevDest
+        @doc_services["pagePrevTitle"]         = :htmlsite_pagePrevTitle
+        @doc_services["pageHomeDest"]          = :htmlsite_pageHomeDest
+        @doc_services["pageHomeTitle"]         = :htmlsite_pageHomeTitle
+        # @doc_services["<+TBD+>"]             = :htmlsite_<+TBD+>
+    end
+
+    # def htmlsite_<+TBD+>
+    # end
+
+    def htmlsite_tabBarNote(args, text)
+        unless defined?(@htmlsite_sliding_tabbar_note)
+            @htmlsite_sliding_tabbar_note = msg(:htmlsite_tabbar_note)
+            # @htmlsite_sliding_tabbar_note ||= <<-EON
+            #     <p class="htmlnavigationnote" />In order to pin down the sliding menu, click on the 
+            #     small square on the top left.</p>
+            # EON
+        end
+        return @htmlsite_sliding_tabbar_note
+    end
+
+    def htmlsite_tabBarLeft(args, text)
+        htmlsite_tabBar(args, text, "tabBarLeft", false)
+    end
+    
+    def htmlsite_tabBarRight(args, text)
+        htmlsite_tabBar(args, text, "tabBarRight", false)
+    end
+
+    def htmlsite_tabBarTop(args, text)
+        htmlsite_tabBar(args, text, "tabBarTop", true)
+    end
+
+    def htmlsite_tabBarBottom(args, text)
+        htmlsite_tabBar(args, text, "tabBarBottom", true)
+    end
+
+    def htmlsite_tabBar(args, text, style, horizontal)
+        if horizontal
+            tagsl0 = "table"
+            tagsl1 = ["tr"]
+            tagsl2 = ["td"]
+            # tagsl1 = []
+            # tagsl2 = ["span"]
+            width  = args["width"]  || "100%"
+            heigth = args["heigth"] || "20px"
+        else
+            tagsl0 = "table"
+            tagsl1 = []
+            tagsl2 = ["tr", "td"]
+            width  = args["width"] || "140px"
+            heigth = args["heigth"]
+        end
+        
+        curr = @variables["@idx"]
+        idx  = curr.to_i
+        type = @variables["navBarType"] || :top
+        urlp, prv = @formatter.navbar_button_prev(nil, nil, idx, type, idx > 0)
+        url, home = @formatter.navbar_button_home(nil, nil, idx, type, idx > 0)
+        urln, nxt = @formatter.navbar_button_next(nil, nil, idx, type, idx < top_heading_idx)
+ 
+        tabbar = []
+        tabbar << html_navigation_keys({"next" => urln}, "") if args["nextKey"]
+        # tabbar << %{<#{tagsl0} width="#{width}" class="#{style}" summary="Navigation bar">} if tagsl0
+        tabbar << %{<#{tagsl0} class="#{style}" summary="Navigation bar">} if tagsl0
+        tabbar << htmlsite_tabBar_accum_tags(tagsl1, style, true)
+      
+        if !@variables["noTabBarButtons"]
+            s = "#{style}Buttons"
+            o = htmlsite_tabBar_accum_tags(tagsl2, s, true)
+            c = htmlsite_tabBar_accum_tags(tagsl2, s, false)
+            if @variables["tabBarButtons"]
+                buttons = []
+                for b in @variables["tabBarButtons"].split(/[ ,;]/)
+                    case b
+                    when "home", "h"
+                        buttons << home
+                    when "next", "n"
+                        buttons << nxt
+                    when "prev", "previous", "p"
+                        buttons << prv
+                    end
+                end
+            else
+                buttons = [prv, home, nxt]
+            end
+            buttons.compact!
+            buttons.delete(%{&nbsp;})
+            tabbar << [o, buttons.join(%{&nbsp;}), c].join
+        end
+
+        depth = args["depth"]
+        depth = depth ? depth.to_i : 1
+        inactivedepth = args["depthInactive"]
+        inactivedepth = inactivedepth ? inactivedepth.to_i : depth
+       
+        tabbarsep   = @variables["tabBarSep"] || "|"
+        tabbarsep   = /\s*#{Regexp.escape(tabbarsep)}\s*/
+        tabbarextra = @variables["tabBar"] || ["[auto]"]
+        tabbarextra = tabbarextra.split(/\n/) if tabbarextra.kind_of?(String)
+        if @variables["tabEqualWidths"] || @variables["equalTabs"]
+            tabsize = top_heading_idx + tabbarextra.size
+            tabsize = 100 / tabsize
+            tabsize = %{ #{horizontal ? "width" : "heigth"}="#{tabsize}%"}
+        else
+            tabsize = nil
+        end
+        for e in tabbarextra
+            if e == "[auto]"
+                tabbar_auto_entries(tabbar, idx, style, depth, inactivedepth, tagsl2, tabsize)
+            else
+                title, url = e.split(tabbarsep)
+                html = %{<a class="tabBarEntry" href="#{url}">#{title}</a>}
+                tabbar << tabbar_entry(html, tagsl2, "#{style}Inactive", tabsize)
+            end
+        end
+        
+        if args["spacer"]
+            if horizontal
+                spacer = %{<img width="1px" height="#{height}" src="%s" alt="" />} % args["spacer"]
+            else
+                spacer = %{<img width="#{width}" height="1px" src="%s" alt="" />} % args["spacer"]
+            end
+        else
+            spacer = nil
+        end
+        
+        if args["progressBar"]
+            if horizontal
+                pb = invoke_service("progressBarVertical")
+            else
+                pb = invoke_service("progressBarHorizontal")
+            end
+            s = "#{style}Buttons"
+            o = htmlsite_tabBar_accum_tags(tagsl2, s, true)
+            c = htmlsite_tabBar_accum_tags(tagsl2, s, false)
+            i = invoke_service("progressPercent")
+            tabbar << [o, spacer, pb, i, c].compact.join
+        end
+        
+        tabbar << htmlsite_tabBar_accum_tags(tagsl1, style, false)
+        tabbar << %{</#{tagsl0}>} if tagsl0
+        return tabbar.compact.join("\n")
+    end
+    
+    def htmlsite_progressBar(args, text)
+        horizontal = !args["vertical"]
+        htmlsite_progress_bar(args, horizontal)
+    end
+    
+    def htmlsite_progressBarHorizontal(args, text)
+        htmlsite_progress_bar(args, true)
+    end
+    
+    def htmlsite_progressBarVertical(args, text)
+        htmlsite_progress_bar(args, false)
+    end
+    
+    def htmlsite_progress_bar(args, horizontal)
+        idx     = @variables["@idx"].to_i
+        percent = 100 * idx / top_heading_idx
+        anti    = 100 - percent
+        all     = percent + anti
+        if all != 100
+            anti += 100 - all
+        end
+        height  = args["h"] || args["height"] || (horizontal ? "10pt"  : "100pt")
+        width   = args["w"] || args["width"]  || (horizontal ? "100pt" : "10pt")
+        pb      = []
+        # pb << %{<div class="progressBar">}
+        pb << %{<table align="center" class="progressBar" width="#{width}" style="height:#{height}">}
+        if horizontal
+            pb << %{<tr>}
+            pb << %{<td class="progressBarDone" width="#{percent}%" style="height:100%"></td>} unless percent == 0
+            pb << %{<td class="progressBarToBeDone" width="#{100 - percent}%" style="height:100%"></td>} unless percent == 100
+            pb << %{</tr>}
+        else
+            pb << %{<tr class="progressBarDone" width="100%" style="height:#{percent}%"></tr>} unless percent == 0
+            pb << %{<tr class="progressBarToBeDone" width="100%" style="height:#{100 - percent}%"></tr>} unless percent == 100
+        end
+        pb << %{</table>}
+        # pb << %{</div>}
+        return pb.join
+    end
+
+    def htmlsite_progressPercent(args, text)
+        idx     = @variables["@idx"].to_i
+        percent = 100 * idx / top_heading_idx
+        return %{<span class="progress">#{percent}%</span>}
+    end
+   
+    def htmlsite_progressPages(args, text)
+        idx = @variables["@idx"].to_i
+        max = top_heading_idx
+        return %{<span class="progress">#{idx}/#{max}</span>}
+    end
+
+    def htmlsite_progressFirst(args, text)
+        idx = @variables["@idx"].to_i
+        idx == 0 ? "1" : "0"
+    end
+
+    def htmlsite_progressLast(args, text)
+        idx = @variables["@idx"].to_i
+        max = top_heading_idx
+        idx == max ? "1" : "0"
+    end
+
+    def htmlsite_pageNextDest(args, text)
+        hd = delta_heading(1)
+        pagedest_relpath(hd)
+    end
+    
+    def htmlsite_pageNextTitle(args, text)
+        hd = delta_heading(1)
+        pagedest_relpath(hd)
+    end
+    
+    def htmlsite_pagePrevDest(args, text)
+        hd = delta_heading(-1)
+        pagedest_relpath(hd)
+    end
+    
+    def htmlsite_pagePrevTitle(args, text)
+        hd = delta_heading(-1)
+        hd && hd.description
+    end
+    
+    def htmlsite_pageHomeDest(args, text)
+        hd = top_heading_by_idx(0)
+        pagedest_relpath(hd)
+    end
+    
+    def htmlsite_pageHomeTitle(args, text)
+        hd = top_heading_by_idx(0)
+        (hd && hd.description) || msg("Frontpage")
+    end
+   
+    def delta_heading(delta)
+        idx = @variables["@idx"]
+        if idx
+            idx = idx.to_i + delta + 1
+            if idx >= 0
+                rv = top_heading_by_idx(idx)
+                return rv
+            end
+        end
+        return nil
+    end
+
+    private
+    def pagedest_relpath(hd)
+        if hd
+            idx   = @variables["@idx"].to_i
+            curr  = top_heading_by_idx(idx)
+            return relative_path(hd.output_location, File.dirname(curr.output_location))
+        end
+    end
+    
+    def tabbar_auto_entries(tabbar, idx, style, depth, inactivedepth, tags, tabsize)
+        if @variables["tabBarHomeName"]
+            s     = idx == 0 ? "#{style}Active" : "#{style}Inactive"
+            title = @variables["tabBarHomeName"]
+            file  = @formatter.navbar_guess_file_name(0, idx, :navbar)
+            tabbar << tabbar_entry(%{<a class="tabBarEntry" href="#{file}">#{title}</a>}, tags, s, tabsize)
+        end
+
+        each_heading(depth) do |hd, title|
+            lstr = hd.level_as_string
+            lnr  = hd.top_heading_idx
+            file = hd.output_file_name(:basename => true)
+            if hd.level > 1
+                anchor = hd.args[:id] || hd.label.first
+                if anchor
+                    file = [file, "#", anchor].join
+                end
+            end
+
+            if top_heading_by_idx(idx) == hd.top_heading
+                s = "#{style}Active"
+            else
+                s = "#{style}Inactive"
+                if hd.level > inactivedepth
+                    next
+                end
+            end
+
+            tabbar << tabbar_entry(%{<a class="tabBarEntry" href="#{file}">#{title}</a>}, tags, s, tabsize)
+        end
+    end
+
+    def tabbar_entry(html, tags, html_class, tabsize)
+        o = htmlsite_tabBar_accum_tags(tags, html_class, true,  tabsize)
+        c = htmlsite_tabBar_accum_tags(tags, html_class, false, tabsize)
+        [o, html, c].join
+    end
+
+    def htmlsite_tabBar_accum_tags(tags, htmlClass, open_tags, extra=nil)
+        acc = []
+        unless open_tags
+            tags = tags.reverse
+        end
+        for t in tags
+            if t
+                if open_tags
+                    t = %{<#{t}#{extra} class="#{htmlClass}">}
+                else
+                    t = %{</#{t}>}
+                end
+                acc << t
+            end
+        end
+        if acc.empty?
+            return nil
+        else
+            return acc.join
+        end
+    end
+end
+
+# vim: ff=unix

data/lib/deplate/fmt/htmlslides.rb

@@ -0,0 +1,21 @@
+# fmt-html.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: 23-Okt-2005.
+# @Revision:    0.809
+
+require "deplate/fmt/htmlsite"
+
+# This is html-site with the paragraph swallowing.
+class Deplate::Formatter::HTML_Slides < Deplate::Formatter::HTML_Site
+    self.myname = "htmlslides"
+    self.rx     = /html?|htmlslides/i
+
+    alias :format_paragraph_html :format_paragraph
+    def format_paragraph(invoker)
+        super if invoker.args["noSwallow"] or @deplate.variables["noSwallow"]
+    end
+end
+

data/lib/deplate/fmt/htmlwebsite.rb

@@ -0,0 +1,70 @@
+# fmt-html.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: 23-Okt-2005.
+# @Revision:    0.441
+
+require "deplate/fmt/htmlslides"
+
+# A variant of the html-formatter that generates website to please 
+# Fritz Heinrichmeyer
+
+class Deplate::Formatter::HTML_Website < Deplate::Formatter::HTML_Slides
+    self.myname = "htmlwebsite"
+    self.rx     = /html?|htmlslides|htmlwebsite/i
+
+    def hook_pre_body_flush_html_pager
+        # invoker = @deplate.accum_elements.last
+        invoker = nil
+        format_navigation_bar(invoker, :body, :navbar_top, :top)
+    end
+    
+    def setup
+        super
+        @deplate.variables["headings"] = "plain"
+    end
+    
+    def prepare
+        super
+        metaextra = @deplate.get_clip("metaextra")
+        output_at(:pre, :head_beg, %{#{metaextra.elt if metaextra}})
+        explorerhack=<<EOF
+<style type="text/css">
+@import url(./no_ns.css);
+</style>
+<!--[if gte IE 5]>
+     <link href="./ie5.css" rel="stylesheet" type="text/css">
+<![endif]-->
+<link rel="shortcut icon" href="./favicon.ico" type="image/x-icon" />
+<link rel="icon" href="./favicon.ico" type="image/x-icon" />
+EOF
+        output_at(:pre, :head_end, explorerhack)
+    end 
+
+    def format_navigation_bar(invoker, type, slot, bartype, first=false, last=false)
+        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|
+            unless section.args["noList"]
+                f = section.output_file_name(:basename => true)
+                v = section.description.gsub(/<\/?[^>]*>/, "")
+            end
+            if @deplate.top_heading_idx(section.top_heading) != idx
+                navmenu << %{<a class="navbar" href="#{f}">#{v}</a>}
+            else
+                set_at(:pre, :head_title, %{<title>#{v}</title>})
+                navmenu <<  %{<span class="navbartds">#{v}</span>}
+            end
+        end
+        @deplate.options.navmenu = navmenu.join("\n")
+        
+        output_at(:body, slot, %{<div id="navigation">#{@deplate.options.navmenu}</div> <div id="contentframe"> <div id="innercontentframe"> <div id="content">})
+        output_at(:body, :navbar_bottom, %{<br> </div> </div> </div>})
+    end
+
+    alias :format_paragraph :format_paragraph_html
+end
+