webgen 0.3.8 → 0.4.0

data/lib/webgen/plugins/menustyles/vertical.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: vertical.rb 369 2005-12-24 11:37:40Z thomas $
+# $Id: vertical.rb 555 2006-12-27 15:40:14Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,86 +20,66 @@
 #++
 #
 
-require 'webgen/plugins/menustyles/default'
+load_plugin 'webgen/plugins/menustyles/default'
 
 module MenuStyles
 
   class VerticalMenuStyle < MenuStyles::DefaultMenuStyle
 
-    summary "Builds a vertical menu"
+    infos( :name => 'MenuStyle/Vertical',
+           :author => Webgen::AUTHOR,
+           :summary => "Builds a vertical menu and is very flexible"
+           )
 
-    register_menu_style 'vertical'
+    register_handler 'vertical'
 
-    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.'
+    param 'startLevel', 1, 'The level at which the menu starts. For example, if set to 2 the top most ' +
+      'menu items are not shown.'
+    param 'minLevels', 1, 'Specifies how many levels should be always be shown, ie. how deep the menu is. ' +
+      'For example, if minLevels = 3, then three levels are always shown at least.'
+    param 'maxLevels', 3,  'Specifies the maximum number of levels that should be shown. ' +
+      'For example, if maxLevels = 1, then only one level is shown.'
+    param 'showCurrentSubtreeOnly', true, 'True if only the current subtree should be shown in the menu. ' +
+      'If set to false, each subtree will be shown.'
 
-    CSS = "
-/* START Webgen vertical menu style */
-.webgen-menu-vert li > ul {
-  font-size: 95%;
-}
-
-.webgen-menu-vert ul {
-  padding: 0px;
-  margin-left: 10px;
-}
-
-.webgen-menu-vert li {
-  padding-left: 5px;
-}
-
-.webgen-menu-vert .webgen-menu-submenu-inhierarchy > a {
-  font-weight: bold;
-}
-
-.webgen-menu-vert .webgen-menu-item-selected > a {
-  font-weight: bold;
-}
-/* STOP Webgen vertical menu style */
-"
-
-    def internal_build_menu( srcNode, menuTree )
-      unless defined?( @css_added )
-        Webgen::Plugin['ResourceManager'].append_data( 'webgen-css', CSS )
-        @css_added = true
-      end
-      "<div class=\"webgen-menu-vert #{get_param('divClass')}\">#{submenu( srcNode, menuTree, 1 )}</div>"
+    def internal_build_menu( src_node, menu_tree )
+      "<div class=\"webgen-menu-vert #{param('divClass')}\">#{submenu( src_node, menu_tree, 1 )}</div>"
     end
 
     #######
     private
     #######
 
-    def submenu( 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'] ) )
+    def submenu( src_node, menu_node, level )
+      if menu_node.nil? \
+        || level > param( 'maxLevels' ) + param( 'startLevel' ) - 1 \
+        || ( ( level > param( 'minLevels' ) + param( 'startLevel' ) - 1 ) \
+             && ( menu_node.level >= src_node.level \
+                  || ( param( 'showCurrentSubtreeOnly' ) && !src_node.in_subtree_of?( menu_node.node_info[:node] ) )
                   )
-             )
+             ) \
+        || src_node.level < param( 'startLevel' ) \
+        || (level == param('startLevel') && !src_node.in_subtree_of?( menu_node.node_info[:node] ))
         return ''
       end
 
+      submenus = ''
       out = "<ul>"
-      node.each do |child|
-        menu = child['node']['int:directory?'] ? submenu( srcNode, child, level + 1 ) : ''
-        style, link = menu_item_details( srcNode, child['node'] )
-
+      menu_node.each do |child|
+        menu = child.has_children? ? submenu( src_node, child, level + 1 ) : ''
+        style, link = menu_item_details( src_node, child.node_info[:node] )
+        submenus << menu
         out << "<li #{style}>#{link}"
         out << menu
         out << "</li>"
       end
       out << "</ul>"
 
-      return out
+      if level < param( 'startLevel' )
+        '' + submenus
+      else
+        out
+      end
     end
 
   end

data/lib/webgen/plugins/menustyles/vertical_dropdown.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: vertical_dropdown.rb 369 2005-12-24 11:37:40Z thomas $
+# $Id: vertical_dropdown.rb 531 2006-11-17 17:56:14Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,25 +20,29 @@
 #++
 #
 
-require 'webgen/plugins/menustyles/default'
+load_plugin 'webgen/plugins/menustyles/default'
 
 module MenuStyles
 
   class VerticalDropdownMenuStyle < MenuStyles::DefaultMenuStyle
 
-    summary "Builds a vertical menu with CSS drop down submenus"
+    infos( :name => 'MenuStyle/VerticalDropdown',
+           :author => Webgen::AUTHOR,
+           :summary => "Builds a vertical menu with CSS drop down submenus"
+           )
 
-    register_menu_style 'vertical-dropdown'
+    register_handler 'vertical-dropdown'
 
-    CSS = "
-/* START Webgen vertical dropdown menu style */
+    def initialize( plugin_manager )
+      super
+      @css = "
+/* START webgen vertical dropdown menu style */
 .webgen-menu-vert-dd ul {
   list-style-type: none;
   margin: 0;
   padding: 0;
   width: 15em;
 }
-
 .webgen-menu-vert-dd ul ul {
   border: 1px solid black;
   position: absolute;
@@ -46,50 +50,38 @@ module MenuStyles
   left: 100%;
   top: 0;
 }
-
 .webgen-menu-vert-dd a {
   display: block;
   margin: 0px;
   padding: 3px 3px;
   background-color: white;
 }
-
-.webgen-menu-vert-dd li {
-  position: relative;
-}
-
-.webgen-menu-vert-dd ul ul {
-  display: none;
-}
-
-.webgen-menu-vert-dd ul li:hover > ul > ul {
-  display: none;
-}
-
-.webgen-menu-vert-dd ul li:hover > ul {
-  display: block;
-}
-/* STOP Webgen vertical dropdown menu style */
+.webgen-menu-vert-dd li { position: relative; }
+.webgen-menu-vert-dd ul ul { display: none; }
+.webgen-menu-vert-dd ul li:hover > ul > ul { display: none; }
+.webgen-menu-vert-dd ul li:hover > ul { display: block; }
+/* STOP webgen vertical dropdown menu style */
 "
+    end
 
-    def internal_build_menu( srcNode, menuTree )
+    def internal_build_menu( src_node, menu_tree )
       unless defined?( @css_added )
-        Webgen::Plugin['ResourceManager'].append_data( 'webgen-css', CSS )
+        @plugin_manager['Core/ResourceManager'].append_data( 'webgen-css', @css )
         @css_added = true
       end
-      "<div class=\"webgen-menu-vert-dd #{get_param('divClass')}\">#{submenu( srcNode, menuTree, 1 )}</div>"
+      "<div class=\"webgen-menu-vert-dd #{param('divClass')}\">#{submenu( src_node, menu_tree, 1 )}</div>"
     end
 
     #######
     private
     #######
 
-    def submenu( srcNode, node, level )
+    def submenu( src_node, menu_node, level )
       out = ''
       out = "<ul>" if level > 1
-      node.each do |child|
-        menu = child['node']['int:directory?'] ? submenu( srcNode, child, level + 1 ) : ''
-        style, link = menu_item_details( srcNode, child['node'] )
+      menu_node.each do |child|
+        menu = (child.has_children? ? submenu( src_node, child, level + 1 ) : '')
+        style, link = menu_item_details( src_node, child.node_info[:node] )
 
         out << "<ul>" if level == 1
         out << "<li #{style}>#{link}"

data/lib/webgen/plugins/miscplugins/smileyreplacer.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: smileyreplacer.rb 369 2005-12-24 11:37:40Z thomas $
+# $Id: smileyreplacer.rb 558 2006-12-27 20:11:05Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -20,20 +20,23 @@
 #++
 #
 
-require 'webgen/plugins/filehandlers/filehandler'
-require 'webgen/plugins/coreplugins/resourcemanager'
+load_plugin 'webgen/plugins/filehandlers/page'
+load_plugin 'webgen/plugins/coreplugins/resourcemanager'
 
 module MiscPlugins
 
   class SmileyReplacer < Webgen::Plugin
 
-    summary "Replaces smiley characters with actual smileys"
-    depends_on 'FileHandler', 'ResourceManager'
+    infos( :name => 'Misc/SmileyReplacer',
+           :author => Webgen::AUTHOR,
+           :summary => "Replaces smiley characters with actual smileys"
+           )
 
-    add_param 'emoticonPack', nil, 'The name of the emoticon package which should be used. If set to nil, ' \
-    'smileys are not replaced.'
+    depends_on 'File/PageHandler'
+
+    param 'emoticonPack', nil, 'The name of the emoticon package which should be used. If set to nil, ' +
+      'smileys are not replaced.'
 
-    used_meta_info 'emoticonPack'
 
     SMILEY_MAP = {
       ':-@' => 'angry',
@@ -50,8 +53,9 @@ module MiscPlugins
     }
     SMILEY_REGEXP = Regexp.union( *SMILEY_MAP.keys.collect {|t| /#{Regexp.escape(t)}/ } )
 
-    def initialize
-      Webgen::Plugin['PageFileHandler'].add_msg_listener( :AFTER_CONTENT_RENDERED, method( :replace_smileys ) )
+    def initialize( plugin_manager )
+      super
+      @plugin_manager['File/PageHandler'].add_msg_listener( :after_node_rendered, method( :replace_smileys ) )
     end
 
     #######
@@ -60,23 +64,22 @@ module MiscPlugins
 
     def replace_smileys( content, node )
       pack = smiley_pack( node )
-      return if pack.nil?
+      return content if pack.nil?
 
-      logger.info { "Replacing smileys in file <#{node.recursive_value('dest')}>..." }
+      log(:info) { "Replacing smileys in file <#{node.full_path}>..." }
       content.gsub!( SMILEY_REGEXP ) do |match|
-        logger.info { "Found smiley #{match}, trying to replace it with emoticon..." }
-        if res = Webgen::Plugin['ResourceManager'].get_resource( "webgen-emoticons-#{pack}-#{SMILEY_MAP[match]}" )
+        if res = @plugin_manager['Core/ResourceManager'].get_resource( "webgen-emoticons-#{pack}-#{SMILEY_MAP[match]}" )
           res.referenced!
-          "<img src=\"#{res.relpath_from_node( node )}\" alt=\"smiley #{match}\" />"
+          "<img src=\"#{res.route_from( node )}\" alt=\"smiley #{match}\" />"
         else
-          logger.warn { "Could not replace smiley '#{match}'(#{SMILEY_MAP[match]}) in <#{node.recursive_value('src')}>: resource not found!" }
+          log(:warn) { "Could not replace smiley '#{match}'(name: #{SMILEY_MAP[match]}, pack: #{pack}) in <#{node.full_path}>: resource not found!" }
           match
         end
       end
     end
 
     def smiley_pack( node )
-      node.metainfo.has_key?( 'emoticonPack' ) && node['emoticonPack'].nil? ? nil : node['emoticonPack'] || get_param( 'emoticonPack' )
+      node.meta_info.has_key?( 'emoticonPack' ) && node['emoticonPack'].nil? ? nil : node['emoticonPack'] || param( 'emoticonPack' )
     end
 
   end

data/lib/webgen/plugins/miscplugins/syntax_highlighter.rb

@@ -0,0 +1,72 @@
+#
+#--
+#
+# $Id: executecommand.rb 484 2006-09-02 07:55:59Z 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_optional_part( 'syntax-highlighting',
+                    :needed_gems => ['coderay'],
+                    :error_msg => "Coderay not available, therefore syntax highlighting is not available",
+                    :info => "Syntax highlighting of source code will be available (e.g. for the includeFile tag)" ) do
+
+  require 'coderay'
+
+end
+
+
+module MiscPlugins
+
+  class SyntaxHighlighter < Webgen::Plugin
+
+    infos( :name => 'Misc/SyntaxHighlighter',
+           :author => Webgen::AUTHOR,
+           :summary => "Utility plugin for syntax highlighting"
+           )
+
+    depends_on 'Core/ResourceManager'
+
+    def initialize( plugin_manager )
+      super
+      @sl_available = plugin_manager.optional_part( 'syntax-highlighting' )[:loaded]
+      if @sl_available
+        @plugin_manager['Core/ResourceManager'].append_data( 'webgen-css', CodeRay::Encoders[:html]::CSS.new.stylesheet )
+      end
+    end
+
+    # Highlights the given +content+ in language +lang+.
+    def highlight( content, lang )
+      if @sl_available
+        CodeRay.scan( content, (lang.kind_of?( String ) ? lang.to_sym : lang ) ).html( :wrap => :div, :line_numbers => :inline )
+      else
+        content
+      end
+    end
+
+    # Returns all available syntax highlighting languages.
+    def self.available_languages
+      if Object.const_defined?( :CodeRay )
+        CodeRay::Scanners.list
+      else
+        []
+      end
+    end
+
+  end
+
+end

data/lib/webgen/plugins/miscplugins/treewalker.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: treewalker.rb 369 2005-12-24 11:37:40Z thomas $
+# $Id: treewalker.rb 531 2006-11-17 17:56:14Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -28,21 +28,13 @@ module TreeWalkers
   # so that it is called when the main class' #execute method is called.
   class TreeWalker < Webgen::Plugin
 
-    summary "Super plugin for traversing the data tree"
+    infos( :author => Webgen::AUTHOR,
+           :summary => "Super plugin for traversing the node tree"
+           )
 
-    attr_reader :walkers
-
-    def initialize
-      @walkers = []
-    end
-
-    # Uses either all registered walkers or the specified +walker+. Walks the +tree+ for each walker
-    # separately.
-    def execute( tree, walker = nil, direction = :forward )
-      walkers = ( walker.nil? ? @walkers : [walker] )
-      walkers.each do |walker|
-        walk_tree( tree, walker, 0, direction )
-      end
+    # Walks the +tree+ for the +walker+ in the +direction+, either +:forward+ or +:backward+.
+    def execute( tree, walker, direction = :forward )
+      walk_tree( tree, walker, 0, direction )
     end
 
     #######
@@ -51,30 +43,11 @@ module TreeWalkers
 
     # Walks the tree and calls the plugin +walker+ for each and every node.
     def walk_tree( node, walker, level, direction = :forward )
-      walker.handle_node( node, level ) if direction == :forward
+      walker.call( node, level ) if direction == :forward
       node.each do |child|
         walk_tree( child, walker, level + 1, direction )
       end
-      walker.handle_node( node, level ) if direction == :backward
-    end
-
-  end
-
-
-  # Prints the whole tree of read files if the log level is at least DEBUG.
-  class DebugTreePrinter < Webgen::Plugin
-
-    summary "Prints out the information in the tree for debug purposes."
-    depends_on 'TreeWalker'
-
-    def initialize
-      Webgen::Plugin['TreeWalker'].walkers << self
-    end
-
-    def handle_node( node, level )
-      self.logger.debug do
-        "   "*level  << "\\_ "*(level > 0 ? 1 : 0) << (node['virtual'] ? "[V]" : "") << "#{node['title']}: #{node['src']} -> #{node['dest']}"
-      end
+      walker.call( node, level ) if direction == :backward
     end
 
   end