webgen 0.4.7 → 0.5.0

data/lib/webgen/plugins/tags/langbar.rb

@@ -1,55 +0,0 @@
-#
-#--
-#
-# $Id: langbar.rb 563 2006-12-29 08:59:41Z thomas $
-#
-# webgen: template based static website generator
-# Copyright (C) 2004 Thomas Leitner
-#
-# This program is free software; you can redistribute it and/or modify it under the terms of the GNU
-# General Public License as published by the Free Software Foundation; either version 2 of the
-# License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
-# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along with this program; if not,
-# write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-#
-#++
-#
-
-load_plugin 'webgen/plugins/tags/tag_processor'
-
-module Tags
-
-  # Generates a list with all the languages for a page.
-  class LangbarTag < DefaultTag
-
-    infos( :name => 'Tag/Langbar',
-           :author => Webgen::AUTHOR,
-           :summary => 'Provides links to translations of the page'
-           )
-
-    param 'separator', ' | ', 'Separates the languages from each other.'
-    param 'showSingleLang', true, 'Should the link be shown although the page is only available in one language?'
-    param 'showOwnLang', true, 'Should the link to the currently displayed language page be shown?'
-
-    register_tag 'langbar'
-
-    def process_tag( tag, chain )
-      cur_node = chain.last
-      langs = cur_node.parent.find_all {|child| child.node_info[:pagename] == cur_node.node_info[:pagename] }
-      nr_langs = langs.length
-      langs = langs.
-        delete_if {|child| (cur_node['lang'] == child['lang'] && !param( 'showOwnLang' )) }.
-        sort {|a, b| a['lang'] <=> b['lang']}.
-        collect {|n| n.link_from( cur_node, :resolve_lang_node => false, :link_text => n['lang'], :context => { :caller => self.class.plugin_name } )}.
-        join( param( 'separator' ) )
-      ( param( 'showSingleLang' ) || nr_langs > 1 ? langs : "" )
-    end
-
-  end
-
-end

data/lib/webgen/plugins/tags/menu.rb

@@ -1,111 +0,0 @@
-#
-#--
-#
-# $Id: menu.rb 563 2006-12-29 08:59:41Z thomas $
-#
-# webgen: template based static website generator
-# Copyright (C) 2004 Thomas Leitner
-#
-# This program is free software; you can redistribute it and/or modify it under the terms of the GNU
-# General Public License as published by the Free Software Foundation; either version 2 of the
-# License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
-# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along with this program; if not,
-# write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-#
-#++
-#
-
-require 'webgen/node'
-load_plugin 'webgen/plugins/tags/tag_processor'
-
-module Tags
-
-  # Generates a menu. All page files for which the meta information +inMenu+ is set are used.
-  #
-  # The order in which the menu items are listed can be controlled via the meta information
-  # +orderInfo+. By default the menu items are sorted by their titles.
-  class MenuTag < DefaultTag
-
-    # Specialised node class for the menu.
-    class MenuNode < Node
-
-      def initialize( parent, node )
-        super( parent, '' )
-        self['title'] = 'Menu: ' + node['title']
-        self.node_info[:node] = node
-      end
-
-
-      # Sorts recursively all children of the node depending on their order value. If two order
-      # values are equal, sort the items using their title.
-      def sort!
-        self.children.sort! {|a,b| a.node_info[:node] <=> b.node_info[:node] }
-        self.children.each {|child| child.sort! }
-      end
-
-      def inspect
-        @node_info[:node]
-      end
-      alias_method :to_s, :inspect
-
-    end
-
-
-    infos( :name => 'Tag/Menu',
-           :author => Webgen::AUTHOR,
-           :summary => 'Builds a menu'
-           )
-
-    param 'menuStyle', nil, 'Specifies the style of the menu.'
-    param 'options', {}, 'Options that are passed on to the plugin which layouts the menu.'
-    set_mandatory 'menuStyle', true
-
-    register_tag 'menu'
-
-    def process_tag( tag, chain )
-      lang = chain.last['lang']
-      @menus ||= {}
-      unless @menus[lang]
-        @menus[lang] = create_menu_tree( Node.root( chain.last ), nil, lang )
-        @menus[lang].sort! if @menus[lang]
-      end
-
-      style = @plugin_manager['MenuStyle/Default'].registered_handlers[param( 'menuStyle' )]
-      if style.nil?
-        log(:error) { "Invalid style specified in <#{chain.first.node_info[:src]}>" }
-        ''
-      elsif @menus[lang]
-        style.build_menu( chain.last, @menus[lang], param( 'options' ) )
-      else
-        ''
-      end
-    end
-
-
-    #######
-    private
-    #######
-
-    # Returns a menu tree if at least one node is in the menu or +nil+ otherwise.
-    def create_menu_tree( node, parent, lang )
-      menu_node = MenuNode.new( parent, node )
-      parent.del_child( menu_node ) if parent
-
-      node.select do |child|
-        child['lang'] == lang || child['lang'].nil? || child.is_directory?
-      end.each do |child|
-        sub_node = create_menu_tree( child, menu_node, lang )
-        menu_node.add_child( sub_node ) unless sub_node.nil?
-      end if node.is_directory?
-
-      return menu_node.has_children? ? menu_node : ( node['inMenu'] ? menu_node : nil )
-    end
-
-  end
-
-end

data/lib/webgen/plugins/tags/meta.rb

@@ -1,53 +0,0 @@
-#
-#--
-#
-# $Id: meta.rb 563 2006-12-29 08:59:41Z thomas $
-#
-# webgen: template based static website generator
-# Copyright (C) 2004 Thomas Leitner
-#
-# This program is free software; you can redistribute it and/or modify it under the terms of the GNU
-# General Public License as published by the Free Software Foundation; either version 2 of the
-# License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
-# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along with this program; if not,
-# write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-#
-#++
-#
-
-load_plugin 'webgen/plugins/tags/tag_processor'
-
-module Tags
-
-  # This plugin registers itself as default plugin for tags. It substitutes tags with their
-  # respective values from the node meta data.
-  #
-  # This is very useful if you want to add new meta information to the page description files and
-  # simple copy the values to the output file.
-  class MetaTag < DefaultTag
-
-    infos( :name => 'Tag/Meta',
-           :author => Webgen::AUTHOR,
-           :summary => "Replaces all tags without tag plugin with their respective values from the node meta info"
-           )
-
-    register_tag :default
-
-    def process_tag( tag, chain )
-      output = ''
-      if chain.last[tag]
-        output = chain.last[tag].to_s
-      else
-        log(:warn) { "No value for tag '#{tag}' in <#{chain.first.node_info[:src]}> found in <#{chain.last.node_info[:src]}>" }
-      end
-      output
-    end
-
-  end
-
-end

data/lib/webgen/plugins/tags/news.rb

@@ -1,151 +0,0 @@
-#
-#--
-#
-# news.rb
-# Copyright (c) 2006 Jeremy Hinegardner
-#
-# This program is free software; you can redistribute it and/or modify it under the terms of the GNU
-# General Public License as published by the Free Software Foundation; either version 2 of the
-# License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
-# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along with this program; if not,
-# write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-#
-#++
-#
-
-load_plugin 'webgen/plugins/tags/tag_processor'
-
-require 'parsedate'
-require 'stringio'
-
-# This plugin creates a 'news' tag which can be used to display the
-# contents of a news file.
-#
-# The news file by default is 'news.yaml' and placed in the root of
-# the webgen directory.  This can be changed with the 'filename'
-# parameter.
-#
-# The yaml file has the basic format of
-#
-#   date: content
-#   date: content
-#
-# Where the date has the format indicated by the 'dateFormat'
-# parmater, which by default is YYYY-MM-DD.  The content is formated
-# according to the 'contentFormat' parameter and is textile by
-# default.  I recommend using the '|' version of block text for the
-# content.  For example:
-#
-#   2007-03-20: |
-#       h2. this is an entry
-#
-#       This is some content
-#
-# When utilzed in a template the 'news' tag can optionally take to
-# additional parameters 'maxEntries' and 'maxParagraphs'.
-#
-#   maxEntries: the N most recent entries by date in the news.yaml
-#               file to display.
-#
-#   maxParagraphs: the content of an entry is truncated to N
-#                  paragraphs, where a paragraphs ending is defined by
-#                  "\n\n"
-#
-# So the following usage of the news tag would disply the first
-# paragraph of the most recent item in the news.yaml file.
-#
-#   {news: {options: {maxEntries: 1, maxParagraphs: 1}}}
-#
-# While this usage would display all the contents of the news.yaml file
-# sorted in reverse chronological order and displayed fully.
-#
-#   {news: }
-#
-#
-class NewsTag < Tags::DefaultTag
-
-    infos( :name => 'Tag/News',
-           :author => "Jeremy Hinegardner",
-           :summary => "Process a news file and format it on a page."
-         )
-
-    param 'filename', "news.yaml", "The name of the news file, relative to website root"
-    param 'dateFormat', "%Y-%m-%d", "The format of the date for the entry."
-    param 'contentFormat', "textile", "The markup format for the content."
-    param 'dateTag', "h2", "The HTML tag to surround the date."
-    param 'contentTag', nil, "The HTML tag to surround the content entry."
-    param 'options', {}, "Options passed to the plugin which formats the news."
-    set_mandatory 'filename', true
-
-    register_tag 'news'
-
-    def process_tag( tag, chain )
-        content = StringIO.new
-        begin
-            news_file = param( 'filename' )
-            filename = File.join( param( 'websiteDir', 'Core/Configuration' ), news_file ) unless filename =~ /^(\/|\w:)/
-            data = YAML::load( File.read(filename) )
-
-            start_date_tag = param('dateTag')
-            end_date_tag   = start_date_tag.gsub(/ .*/,'') # in case people put attributes on the tag
-            start_content_tag = param('contentTag') || ''
-            end_content_tag   = start_content_tag.gsub(/ .*/,'') # in case people put attributes on the tag
-
-            format         = param('dateFormat')
-            content_handler= @plugin_manager['ContentConverter/Default'].registered_handlers[param('contentFormat')]
-
-            limit_entries(data).each do |datetime,entry|
-                content.puts "<#{start_date_tag}>#{datetime.strftime(format)}</#{end_date_tag}>"
-                content.print "<#{start_content_tag}>" if start_content_tag.length > 0
-                content.print content_handler.call(entry)
-                content.print "</#{end_content_tag}>" if start_content_tag.length > 0
-            end
-        rescue => boom
-            log(:error) { "Given file <#{filename}> specified in <#{chain.first.node_info[:src]}> does not exist or can't be read" }
-        end
-        content.string
-    end
-
-    #######
-    private
-    #######
-
-    def limit_entries(data)
-        # convert the entries to something sortable by date
-        time_content_entries = []
-        data.each_pair do |date,content|
-            case date
-            when String
-                p = ParseDate.parsedate(date)
-            when Date
-                p = [date.year, date.month, date.day]
-            when DateTime
-                p = [date.year, date.month, date.day, date.hour, date.min, date.sec]
-            end
-            time_content_entries << [Time.mktime(*p), content]
-        end
-
-        # limit the entries if there is an options for it
-        limit = param('options')['maxEntries'] || time_content_entries.size
-        max_paragraphs = param('options')['maxParagraphs'] || nil
-
-        # we want a descending sort
-        time_content_entries.sort! { |a,b| b[0] <=> a[0] }
-
-        if max_paragraphs then
-            max_paragraphs = max_paragraphs.to_i
-            time_content_entries[0...limit].collect do |e|
-                e[1] = e[1].split("\n\n")[0...max_paragraphs].join("\n\n")
-                e
-            end
-        else
-            time_content_entries[0...limit]
-        end
-    end
-
-end

data/lib/webgen/plugins/tags/relocatable.rb

@@ -1,94 +0,0 @@
-#
-#--
-#
-# $Id: relocatable.rb 563 2006-12-29 08:59:41Z thomas $
-#
-# webgen: template based static website generator
-# Copyright (C) 2004 Thomas Leitner
-#
-# This program is free software; you can redistribute it and/or modify it under the terms of the GNU
-# General Public License as published by the Free Software Foundation; either version 2 of the
-# License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
-# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along with this program; if not,
-# write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-#
-#++
-#
-
-load_plugin 'webgen/plugins/tags/tag_processor'
-require 'uri'
-
-module Tags
-
-  # Changes the path of file. This is very useful for templates. For example, you normally include a
-  # stylesheet in a template. If you specify the filename of the stylesheet directly, the reference
-  # to the stylesheet in the output file of a page file that is not in the same directory as the template
-  # would be invalid.
-  #
-  # By using the +relocatable+ tag you ensure that the path stays valid.
-  #
-  # Tag parameter: the name of the file which should be relocated
-  class RelocatableTag < DefaultTag
-
-    infos( :name => 'Tag/Relocatable',
-           :author => Webgen::AUTHOR,
-           :summary => 'Adds a relative path to the specified name if necessary'
-           )
-
-    param 'path', nil, 'The path which should be relocatable'
-    param 'resolveFragment', true, 'Specifies if the fragment part (#something) in the path should also be resolved'
-    set_mandatory 'path', true
-
-    register_tag 'relocatable'
-
-
-    def process_tag( tag, chain )
-      uri_string = param( 'path' )
-      result = ''
-      unless uri_string.nil?
-        begin
-          uri = URI.parse( uri_string )
-          if uri.absolute?
-            result = uri_string
-          else
-            result = resolve_path( uri, chain )
-          end
-          log(:error) { "Could not resolve path '#{uri_string}' in <#{chain.first.node_info[:src]}>" } if result.empty?
-        rescue URI::InvalidURIError => e
-          log(:error) { "Error while parsing path for tag relocatable in <#{chain.first.node_info[:src]}>: #{e.message}" }
-        end
-      end
-      result
-    end
-
-    #######
-    private
-    #######
-
-    def query_fragment( uri )
-      (uri.query.nil? ? '' : '?'+ uri.query ) + (uri.fragment.nil? ? '' : '#' + uri.fragment)
-    end
-
-    def resolve_path( uri, chain )
-      dest_node = chain.first.resolve_node( uri.path )
-      if !dest_node.nil? && (File.basename( uri.path ) == dest_node.node_info[:pagename] || dest_node.is_directory?)
-        dest_node = dest_node.node_for_lang( chain.last['lang'] )
-      end
-      if !dest_node.nil? && !uri.fragment.nil? && param( 'resolveFragment' )
-        dest_node = dest_node.resolve_node( '#' + uri.fragment )
-      end
-      if dest_node.nil?
-        ''
-      else
-        chain.last.route_to( dest_node.is_fragment? ? dest_node.parent : dest_node ) + query_fragment( uri )
-      end
-    end
-
-  end
-
-end