webgen 0.3.2 → 0.3.3

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: langbar.rb 223 2005-03-16 14:10:57Z thomas $
+# $Id: langbar.rb 256 2005-04-14 01:13:57Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -39,7 +39,7 @@ module Tags
     end
 
     def process_tag( tag, node, refNode )
-      output = node.parent.children.sort do |a, b| a['lang'] <=> b['lang'] end.collect do |n|
+      output = node.parent.find_all {|a| a['page:name'] == node['page:name']}.sort {|a, b| a['lang'] <=> b['lang']}.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 : "" )

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: menu.rb 223 2005-03-16 14:10:57Z thomas $
+# $Id: menu.rb 256 2005-04-14 01:13:57Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -67,7 +67,7 @@ module Tags
 
         # 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 )
+        node = node.parent.find {|child| child['page:name'] == node['page:name'] && child['menuOrder'].to_s.to_i != 0} if !node.nil? && node['page:name']
         value ||= node['menuOrder'].to_s.to_i unless node.nil?
 
         # fallback value
@@ -151,7 +151,7 @@ module Tags
 
 
     def menu_entry( srcNode, node )
-      langNode = node['processor'].get_lang_node( node, srcNode['lang'] )
+      langNode = node['processor'].get_page_node_for_lang( node, srcNode['lang'] )
       isDir = node.kind_of?( FileHandlers::DirHandler::DirNode )
 
       styles = []
@@ -173,20 +173,12 @@ module Tags
       menuNode = MenuNode.new( parent, node )
 
       node.each do |child|
+        next if menuNode.find {|n| n['page:name'] == child['page:name'] && !n['page:name'].nil? }
         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
+      return menuNode.has_children? ? menuNode : ( node['inMenu'] && !node['virtual'] ? node : nil )
     end
 
   end

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: relocatable.rb 224 2005-03-16 15:26:33Z thomas $
+# $Id: relocatable.rb 256 2005-04-14 01:13:57Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -47,7 +47,7 @@ module Tags
     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['node:isLangNode'] ? destNode : destNode['processor'].get_lang_node( destNode, node['lang'] ) ) )
+        return ( destNode.nil? ? '' :  node.relpath_to_node( destNode['page:name'] ? destNode['processor'].get_page_node_for_lang( destNode, node['lang'] ) : destNode ) )
       else
         return ''
       end

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: sitemap.rb 211 2005-02-26 17:23:20Z thomas $
+# $Id: sitemap.rb 256 2005-04-14 01:13:57Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -56,7 +56,7 @@ module Tags
         isDir = child.kind_of?( FileHandlers::DirHandler::DirNode )
         subout = output_node( child, srcNode )
         if subout != '' || !isDir
-          langNode = child['processor'].get_lang_node( child, srcNode['lang'] )
+          langNode = child['processor'].get_page_node_for_lang( child, srcNode['lang'] )
           link = langNode['processor'].get_html_link( langNode, srcNode, ( isDir ? langNode['directoryName'] || child['directoryName'] : langNode['title'] ) )
         end
 

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

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: wikilink.rb 203 2005-02-21 18:42:04Z thomas $
+# $Id: wikilink.rb 252 2005-04-13 20:21:12Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -32,7 +32,8 @@ module Tags
     add_param 'rootURL', '/wiki/wiki.pl?', 'The root URL for the wiki link, ie. the path to the wiki CGI.'
     add_param 'relURL', nil, 'The relativ URL for the wiki link (the varying part that is appended to rootURL). ' \
     'If it is not specified, the title of the current page is used.'
-    add_param 'convertSpaces', true, 'True if spaces in the relative URL should be converted to underscores.'
+    add_param 'invalidChars', ' &;', 'The characters which are invalid as wiki URLs.'
+    add_param 'replacementChar', '_', 'The character(s) which should be used instead of the invalid characters.'
 
     def initialize
       super
@@ -50,7 +51,7 @@ module Tags
     def get_link( node )
       link = get_param( 'rootURL' )
       relURL = get_param( 'relURL' ) || node['title']
-      link + (get_param( 'convertSpaces' ) ? relURL.tr( ' ', '_' ) : relURL )
+      link + relURL.tr( get_param( 'invalidChars' ), get_param( 'replacementChar' ) )
     end
 
   end

data/lib/webgen/webgen.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: webgen.rb 230 2005-03-17 09:29:43Z thomas $
+# $Id: webgen.rb 259 2005-04-21 10:37:47Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -21,7 +21,9 @@
 #
 
 require 'optparse'
-require 'webgen/configuration'
+require 'rbconfig'
+require 'cmdparse'
+require 'webgen/plugin'
 
 module Webgen
 
@@ -45,62 +47,16 @@ module Webgen
 
   end
 
-  class WebgenMain
-
-    def main( cmdOptions )
-      Color.colorify if $stdout.isatty
-      main, data = parse_options( cmdOptions )
-
-      Plugin['Configuration'].init_all( data )
-      main.call
-    end
-
-
-    def parse_options( cmdOptions )
-      config = Plugin['Configuration']
-      data = {}
-      main = method( :runMain )
-
-      opts = OptionParser.new do |opts|
-        opts.summary_width = 25
-        opts.summary_indent = '  '
 
-        opts.banner = "Usage: webgen [options]\n#{Webgen::SUMMARY}"
+  class RunWebgenCommand < CommandParser::Command
 
-        opts.separator ""
-        opts.separator "Configuration options:"
-
-        opts.on( "--config-file FILE", "-C", String, "The configuration file which should be used" ) { |data['configfile']| }
-        opts.on( "--source-dir DIR", "-S", String, "The directory from where the files are read" ) { |data['srcDirectory']| }
-        opts.on( "--output-dir DIR", "-O", String, "The directory where the output should go" ) { |data['outDirectory']| }
-        opts.on( "--verbosity LEVEL", "-V", Integer, "The verbosity level" ) { |data['verbosityLevel']| }
-        opts.on( "--[no-]logfile", "-L", "Log to file webgen.log" ) { |logfile| config.set_log_dev_to_logfile if logfile }
-
-        opts.separator ""
-        opts.separator "Other options:"
-
-        opts.on( "--list-plugins", "-p", "List all the plugins and information about them" ) { main = method( :runListPlugins ) }
-        opts.on( "--list-configuration", "-c", "List all plugin configuration parameters" ) { main = method( :runListConfiguration ) }
-        opts.on_tail( "--help", "Display this help screen" ) { puts opts; exit }
-        opts.on_tail( "--version", "-v", "Show version" ) do
-          puts "Webgen #{Webgen::VERSION.join('.')}"
-          exit
-        end
-      end
+    def initialize; super( 'run' ); end
 
-      begin
-        opts.parse!( cmdOptions )
-      rescue RuntimeError => e
-        print "Error:\n" << e.reason << ": " << e.args.join(", ") << "\n\n"
-        puts opts
-        exit
-      end
-
-      [main, data]
-    end
+    def description; "Runs webgen. This command is used as default command when no command was issued."; end
 
+    def usage; "Usage: #{@options.program_name} [global options] run"; end
 
-    def runMain
+    def execute( commandParser, args )
       logger.info "Starting Webgen..."
 
       # load all the files in src dir and build tree
@@ -114,12 +70,32 @@ module Webgen
 
       logger.info "Webgen finished"
     end
+  end
+
+
+  class ShowCommand < CommandParser::Command
+
+    def initialize; super( 'show' ); end
+
+    def description; "Shows all available plugins or their configuration items."; end
 
+    def usage; "Usage: #{@options.program_name} [global options] show plugins|config"; end
 
-    def runListPlugins
+    def execute( commandParser, args )
+      case args[0]
+      when 'plugins' then showPlugins
+      when 'config' then showConfiguration
+      else puts "You have to specify either 'plugins' or 'config'"
+      end
+      exit
+    end
+
+    private
+
+    def showPlugins
       print "List of loaded plugins:\n"
 
-      headers = Hash.new {|h,k| h[k] = k.gsub(/([A-Z])/, ' \1').strip}
+      headers = Hash.new {|h,k| h[k] = (k.nil? ? "Other Plugins" : k.gsub(/([A-Z][a-z])/, ' \1').strip) }
 
       ljustlength = 30 + Color.green.length + Color.reset.length
       header = ''
@@ -133,8 +109,7 @@ module Webgen
       end
     end
 
-
-    def runListConfiguration
+    def showConfiguration
       print "List of configuration parameters:\n\n"
       ljustlength = 20 + Color.green.length + Color.reset.length
       Plugin.config.sort { |a, b| a[0].name <=> b[0].name }.each do |klass, data|
@@ -152,4 +127,234 @@ module Webgen
 
   end
 
+
+  class CreateCommand < CommandParser::Command
+
+    def initialize; super( 'create' ); end
+
+    def description;
+      "Creates the basic directories and files for webgen. This includes the source and output directories, " \
+      "the log and the plugin directory. Also, a basic template plus a CSS and an index file are created."
+    end
+
+    def usage; "Usage: #{@options.program_name} [global options] create DIR"; end
+
+    def execute( commandParser, args )
+      if args.length == 0
+        raise OptionParser::MissingArgument.new( 'DIR' )
+      else
+        create_dir( args[0] )
+        create_dir( File.join( args[0], 'src' ) )
+        create_dir( File.join( args[0], 'output' ) )
+        create_dir( File.join( args[0], 'log' ) )
+        create_dir( File.join( args[0], 'plugin' ) )
+        create_file( File.join( args[0], 'config.yaml' ), content_config_yaml )
+        create_file( File.join( args[0], 'src', 'default.template' ), content_default_template )
+        create_file( File.join( args[0], 'src', 'default.css' ), content_default_css )
+        create_file( File.join( args[0], 'src', 'index.page' ), content_index_page )
+      end
+    end
+
+    def create_dir( dir )
+      Dir.mkdir( dir ) unless File.exists?( dir )
+    end
+
+    def create_file( file, content )
+      File.open( file, 'w') do |f|
+        f.puts( content )
+      end unless File.exists?( file )
+    end
+
+    def content_config_yaml
+      "# Configuration file for webgen\n# Used to set the parameters of the plugins"
+    end
+
+    def content_default_template
+      "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\" \"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd\">
+<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"{lang:}\">
+  <head>
+    <title>{title: }</title>
+    <link href=\"{relocatable: default.css}\" rel=\"stylesheet\" />
+    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />
+  </head>
+  <body>
+    <div id=\"header\">
+      <h1>{title: }</h1>
+    </div>
+
+    <div id=\"headerbar\" class=\"bar\">
+      <span class=\"left\">Navbar: {navbar: }</span>
+      <span class=\"right\">Language: {langbar: }</span>
+      <div style=\"clear:both\"></div>
+    </div>
+
+    <div id=\"menu\">
+      {menu: {subtreeLevel: 4}}
+    </div>
+
+    <div id=\"body\">
+      {content: }
+    </div>
+
+    <div id=\"footer\" class=\"bar\">
+      generated with <a href=\"http://webgen.rubyforge.org\"><em><b>webgen</b></em></a> on <b>{date: }</b>
+    </div>
+  </body>
+</html>
+"
+    end
+
+    def content_default_css
+      "
+  #all { background-color: #CCCCCC; }
+
+  #header {
+    border-bottom: 1px solid black;
+    padding: 1ex;
+    background-color: #888888;
+  }
+  #header h1 {
+    margin: 0ex;
+	font-size: 300%;
+	font-style: italic;
+	font-weight: normal;
+  }
+
+, #headerbar { border-bottom: 1px solid black; }
+  #footer { border-top: 1px solid black; }
+
+  #body {
+    margin-left: 250px;
+    margin-right: 20px;
+    padding: 10px;
+  }
+
+  #menu {
+	float: left;
+	width: 230px;
+    padding: 20px 0px 0px 2px;
+  }
+
+  .bar {
+	clear: both;
+	padding: 3px;
+	text-align: center;
+	font-size: 90%;
+    background-color: #AAAAAA;
+  }
+
+  .left, .right {
+    padding: 0px 1em;
+  }
+
+  .left {
+	float: left;
+	text-align: left;
+  }
+
+  .right {
+	float: right;
+	text-align: right;
+  }
+
+  /* styling the menu */
+
+  #menu a {
+	text-decoration: none;
+	font-weight: bold;
+	font-size: 130%;
+  }
+
+  #menu a:hover {
+	text-decoration: underline;
+  }
+
+  #menu .webgen-menuitem-selected {
+	border-left: 3px solid black;
+  }
+
+  #menu ul {
+	list-style-type: none;
+	padding: 0px;
+	margin-left: 10px;
+  }
+
+  #menu li > ul {
+	font-size: 95%;
+  }
+
+  #menu li {
+    margin: 0.0em 0px;
+    padding: 2px 0px;
+    padding-left: 5px;
+    border-left: 3px solid #CCCCCC;
+  }
+"
+    end
+
+    def content_index_page
+      "---
+title: Empty index page
+inMenu: true
+directoryName: New Website
+---
+h2. Empty index file
+
+Fill this file with your own data!!!
+"
+    end
+
+  end
+
+
+  class WebgenCommandParser < CommandParser
+
+    def initialize
+      super
+      self.options do |opts|
+        opts.program_name = "webgen"
+        opts.version = Webgen::VERSION
+        opts.summary_width = 25
+        opts.summary_indent = '  '
+
+        opts.banner = "Usage: webgen [global options] COMMAND [command options]\n#{Webgen::SUMMARY}"
+
+        opts.separator ""
+        opts.separator "Global options:"
+
+        opts.on( "--verbosity LEVEL", "-V", Integer, "The verbosity level" ) { |verbosity| Plugin.set_param( 'Logging', 'verbosityLevel', verbosity ) }
+        opts.on( "--[no-]logfile", "-L", "Log to file" ) { |logfile| Plugin.set_param( 'Logging', 'logToFile', logfile ) }
+
+        opts.separator ""
+      end
+
+      self.add_command( RunWebgenCommand.new, true )
+      self.add_command( ShowCommand.new )
+      self.add_command( CreateCommand.new )
+      self.add_command( CommandParser::HelpCommand.new )
+      self.add_command( CommandParser::VersionCommand.new )
+    end
+
+  end
+
+
+  class WebgenMain
+
+    def main( cmdOptions )
+      Color.colorify if $stdout.isatty && !Config::CONFIG['arch'].include?( 'mswin32' )
+      begin
+        wcp = WebgenCommandParser.new
+        wcp.parse!( ARGV, false )
+        Plugin['Configuration'].init_all
+        wcp.execute
+      rescue CommandParser::InvalidCommandError => e
+        puts "Error: invalid command given"
+        puts
+        wcp.commands['help'].execute( wcp, {} )
+      end
+    end
+
+  end
+
 end