webgen 0.3.0

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

@@ -0,0 +1,60 @@
+#
+#--
+#
+# $Id: includefile.rb 203 2005-02-21 18:42:04Z 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 'cgi'
+require 'webgen/plugins/tags/tags'
+
+module Tags
+
+  # Includes a file verbatim. All HTML special characters are escaped.
+  class IncludeFileTag < DefaultTag
+
+    summary "Includes a file verbatim"
+    depends_on 'Tags'
+    add_param 'filename', nil, 'The name of the file which should be included'
+    add_param 'processOutput', true, 'The file content will be processed if true'
+    add_param 'escapeHTML', true, 'Special HTML characters in the file content will be escaped if true'
+    set_mandatory 'filename', true
+
+    def initialize
+      super
+      register_tag( 'includeFile' )
+    end
+
+    def process_tag( tag, node, refNode )
+      @processOutput = get_param( 'processOutput' )
+      content = ''
+      begin
+        filename = refNode.parent.recursive_value( 'src' ) + get_param( 'filename' )
+        self.logger.debug { "File location: <#{filename}>" }
+        content = File.read( filename )
+      rescue
+        self.logger.error { "Given file <#{filename}> does not exist (tag specified in <#{refNode.recursive_value( 'src' )}>" }
+      end
+      content = CGI::escapeHTML( content ) if get_param( 'escapeHTML' )
+
+      content
+    end
+
+  end
+
+end

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

@@ -0,0 +1,50 @@
+#
+#--
+#
+# $Id: lang.rb 203 2005-02-21 18:42:04Z 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/plugins/tags/tags'
+
+module Tags
+
+  # Generates a list with all the languages for a page.
+  class LanguageTag < DefaultTag
+
+    summary 'Provides links to translations of the page'
+    add_param 'separator', ' | ', 'Separates the languages from each other.'
+    add_param 'showSingleLang', true, 'True if the language link should be shown '\
+    'although the page is only available in one language.'
+    depends_on 'Tags'
+
+    def initialize
+      super
+      register_tag( 'lang' )
+    end
+
+    def process_tag( tag, node, refNode )
+      output = node.parent.children.sort do |a, b| a['lang'] <=> b['lang'] end.collect do |n|
+        n['processor'].get_html_link( n, n, n['lang'] )
+      end.join( get_param( 'separator' ) )
+      return ( get_param( 'showSingleLang' ) || node.parent.children.length > 1 ? output : "" )
+    end
+
+  end
+
+end

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

@@ -0,0 +1,198 @@
+#
+#--
+#
+# $Id: menu.rb 203 2005-02-21 18:42:04Z 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'
+require 'webgen/plugins/tags/tags'
+
+module Tags
+
+  # Generates a menu. All page files for which the meta information +inMenu+ is set are displayed.
+  # If you have one page in several languages, it is sufficient to add this meta information to only
+  # one page file.
+  #
+  # The order in which the menu items are listed can be controlled via the meta information
+  # +menuOrder+. By default the menu items are sorted by the file names.
+  #
+  # Tag parameters:
+  # [<b>level</b>]
+  #   The depth of the menu. A level of one only displays the top level menu files. A level of two
+  #   also displays the menu files in the direct subdirectories and so on.
+  class MenuTag < DefaultTag
+
+
+    # Specialised node class for the menu.
+    class MenuNode < Node
+
+      def initialize( parent, node )
+        super( parent )
+        self.logger.info { "Creating menu node for <#{node.recursive_value( 'src', false )}>" }
+        self['title'] = 'Menu: '+ node['title']
+        self['isMenuNode'] = true
+        self['virtual'] = true
+        self['node'] = node
+      end
+
+
+      # Sorts recursively all children of the node depending on their order value.
+      def sort!
+        self.children.sort! {|a,b| get_order_value( a ) <=> get_order_value( b )}
+        self.children.each {|child| child.sort! if child.kind_of?( MenuNode ) && child['node'].kind_of?( FileHandlers::DirHandler::DirNode )}
+      end
+
+
+      # Retrieves the order value for the specific node.
+      def get_order_value( node )
+        # be optimistic and try metainfo field first
+        node = node['node'] if node.kind_of?( MenuNode )
+        value = node['menuOrder'].to_s.to_i unless node['menuOrder'].nil?
+
+        # find the first menuOrder entry in the page files
+        node = node['indexFile'] if node.kind_of?( FileHandlers::DirHandler::DirNode )
+        node = node.find {|child| child['menuOrder'].to_s.to_i != 0} if node.kind_of?( FileHandlers::PageHandler::PageNode )
+        value ||= node['menuOrder'].to_s.to_i unless node.nil?
+
+        # fallback value
+        value ||= 0
+
+        value
+      end
+
+    end
+
+
+    summary 'Builds up a menu'
+    depends_on 'Tags'
+
+    add_param 'menuTag', 'ul', 'The tag used for menus.'
+    add_param 'itemTag', 'li', 'The tag used for menu items.'
+    add_param 'level', 1, \
+    'Specifies how many levels the menu should have by default, ie. how deep it is. ' \
+    'For example, if level = 3, then three levels are always shown at least.'
+    add_param 'subtreeLevel', 3, \
+    'Specifies how many levels should be shown for subtrees. The number specifies ' \
+    'the maximum depth the menu will have.'
+    add_param 'showCurrentSubtreeOnly', true, \
+    'True if only the current subtree should be shown in the menu. If set to false, ' \
+    'each subtree will be shown.'
+
+    def initialize
+      super
+      register_tag( 'menu' )
+    end
+
+    def process_tag( tag, node, refNode )
+      unless defined?( @menuTree )
+        @menuTree = create_menu_tree( Node.root( node ), nil )
+        unless @menuTree.nil?
+          Webgen::Plugin['TreeWalker'].execute( @menuTree, Webgen::Plugin['DebugTreePrinter'] )
+          @menuTree.sort!
+          Webgen::Plugin['TreeWalker'].execute( @menuTree, Webgen::Plugin['DebugTreePrinter'] )
+        end
+      end
+      build_menu( node, @menuTree, 1 )
+    end
+
+
+    #######
+    private
+    #######
+
+
+    def build_menu( srcNode, node, level )
+      if node.nil? \
+        || level > get_param( 'subtreeLevel' ) \
+        || ( level > get_param( 'level' ) \
+             && ( node['node'].level > srcNode.level \
+                  || ( get_param( 'showCurrentSubtreeOnly' ) && !srcNode.in_subtree?( node['node'] ) )
+                  )
+             )
+        return ''
+      end
+
+      out = "<#{get_param( 'menuTag' )}>"
+      node.each do |child|
+        if child.kind_of?( MenuNode )
+          menu = child['node'].kind_of?( FileHandlers::DirHandler::DirNode ) ? build_menu( srcNode, child, level + 1 ) : ''
+          before, after = menu_entry( srcNode, child['node'] )
+        else
+          menu = ''
+          before, after = menu_entry( srcNode, child )
+        end
+
+        out << before
+        out << menu
+        out << after
+      end
+      out << "</#{get_param( 'menuTag' )}>"
+
+      return out
+    end
+
+
+    def menu_entry( srcNode, node )
+      langNode = node['processor'].get_lang_node( node, srcNode['lang'] )
+      isDir = node.kind_of?( FileHandlers::DirHandler::DirNode )
+
+      styles = []
+      styles << 'webgen-submenu' if isDir
+      styles << 'webgen-menuitem-selected' if langNode.recursive_value( 'dest' ) == srcNode.recursive_value( 'dest' )
+
+      style = " class=\"#{styles.join(' ')}\"" if styles.length > 0
+      link = langNode['processor'].get_html_link( langNode, srcNode, ( isDir ? langNode['directoryName'] || node['directoryName'] : langNode['title'] ) )
+
+      itemTag = get_param( 'itemTag' )
+      if isDir
+        before = "<#{itemTag}#{style}>#{link}"
+        after = "</#{itemTag}>"
+      else
+        before = "<#{itemTag}#{style}>#{link}</#{itemTag}>"
+        after = ""
+      end
+
+      self.logger.debug { [before, after] }
+      return before, after
+    end
+
+
+    def create_menu_tree( node, parent )
+      menuNode = MenuNode.new( parent, node )
+
+      node.each do |child|
+        menu = create_menu_tree( child, menuNode )
+        menuNode.add_child( menu ) unless menu.nil?
+      end
+
+      return menuNode.has_children? ? menuNode : ( put_node_in_menu?( node ) ? node : nil )
+    end
+
+
+    def put_node_in_menu?( node )
+      inMenu = node['inMenu']
+      inMenu ||=  node.parent && node.parent.kind_of?( FileHandlers::PageHandler::PageNode ) &&
+                  node.parent.find do |child| child['inMenu'] end
+      inMenu &&= !node['virtual']
+      inMenu
+    end
+
+  end
+
+end

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

@@ -0,0 +1,54 @@
+#
+#--
+#
+# $Id: meta.rb 203 2005-02-21 18:42:04Z 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/plugins/tags/tags'
+
+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
+
+    summary "Replaces all tags without tag plugin with their respective values from the node meta data"
+    depends_on 'Tags'
+
+    def initialize
+      super
+      register_tag( :default )
+    end
+
+    def process_tag( tag, node, refNode )
+      output = ''
+      if node[tag]
+        output = node[tag]
+      else
+        self.logger.warn { "No value for tag '#{tag}' in <#{refNode.recursive_value( 'src' )}> found in <#{node.recursive_value( 'src' )}>" }
+      end
+      return output
+    end
+
+  end
+
+end

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

@@ -0,0 +1,62 @@
+#
+#--
+#
+# $Id: navbar.rb 203 2005-02-21 18:42:04Z 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/plugins/tags/tags'
+
+module Tags
+
+  # Generates a navigation bar. A navigation bar consists of all pages in the hierarchy of the
+  # current page.
+  #
+  # For example, assuming we have the following branch
+  #   /directory1/directory2/currentFile
+  # this plugin will generate something like this:
+  #   root / directory1 / directory2 / currentFile
+  # where each listed name is linked to the corresponding file.
+  class NavbarTag < DefaultTag
+
+    summary 'Shows the hierarchy of current page'
+    add_param 'separator', ' / ', 'Separates the hierachy entries from each other.'
+    depends_on 'Tags'
+
+    def initialize
+      super
+      register_tag( 'navbar' )
+    end
+
+    def process_tag( tag, srcNode, refNode )
+      out = []
+      node = srcNode
+
+      until node.nil?
+        out.push( node['processor'].get_html_link( node, srcNode ) )
+        begin node = node.parent end while !node.nil? && node['virtual']
+      end
+
+      out = out.reverse.join( get_param( 'separator' ) )
+      self.logger.debug { "Navbar for #{srcNode.recursive_value( 'src' )}: #{out}" }
+      out
+    end
+
+  end
+
+end

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

@@ -0,0 +1,58 @@
+#
+#--
+#
+# $Id: relocatable.rb 203 2005-02-21 18:42:04Z 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/plugins/tags/tags'
+
+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
+
+    summary 'Adds a relative path to the specified name if necessary'
+    depends_on 'Tags'
+    add_param 'item', nil, 'The item which should be relocatable'
+    set_mandatory 'item', true
+
+    def initialize
+      super
+      register_tag( 'relocatable' )
+    end
+
+    def process_tag( tag, node, refNode )
+      unless get_param( 'item' ).nil?
+        destNode = refNode.node_for_string( get_param( 'item' ) )
+        return ( destNode.nil? ? '' :  node.relpath_to_node( destNode['processor'].get_lang_node( destNode, node['lang'] ) ) )
+      else
+        return ''
+      end
+    end
+
+  end
+
+end