RubyGems - webgen - Versions diffs - 0.3.8 → 0.4.0 - Mend

webgen 0.3.8 → 0.4.0

Files changed (618) hide show

data/doc/examples/website_templates/personal_hp/src/projects.page ADDED

@@ -0,0 +1,20 @@
+---
+title: Projects
+inMenu: true
+orderInfo: 20
+---
+h2. My Projects
+Here comes a list of your software projects if you have any! Another way to do this would be to
+create a subdirectory for your projects and use one page file for each project!
+h3. DoItYourself V4.5
+Description of project
+Current version
+Where to download?
+Dependencies
+h3. My other Project V 3.0
+The same information as before

data/doc/examples/website_templates/project/README ADDED

@@ -0,0 +1,9 @@
+description:
+  This template provides the basic files for a website for a software project.
+  You just need to fill in the correct data in the provided files and there
+  you go!
+author:
+  Thomas Leitner
+---
+note: This file can be deleted!

data/doc/examples/website_templates/project/config.yaml ADDED

	@@ -0,0 +1,2 @@
1	+ Core/Configuration:
2	+ outDir: ../../../output/examples/website_templates/project

data/doc/examples/website_templates/project/src/about.page ADDED

@@ -0,0 +1,12 @@
+---
+title: About
+inMenu: true
+orderInfo: 10
+---
+h2. About Project XXX
+Description of project!
+h2. About the Author
+bla bla bla

data/doc/examples/website_templates/project/src/default.css ADDED

@@ -0,0 +1,84 @@
+  #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-menu-item-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;
+  }

data/doc/examples/website_templates/project/src/default.template ADDED

@@ -0,0 +1,38 @@
+--- content, html
+<?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>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta name="description" content="Your description goes here..." />
+    <meta name="keywords" content="your,keywords,goes,here" />
+    <meta name="author" content="Your Name" />
+    <meta name="generator" content="webgen - http://webgen.rubyforge.com/" />
+    <link href="{relocatable: default.css}" rel="stylesheet" type="text/css" />
+    <link href="{resource: webgen-css}" rel="stylesheet" type="text/css" />
+  </head>
+  <body>
+    <div id="header">
+      <h1>{title: }</h1>
+    </div>
+    <div id="headerbar" class="bar">
+      <span class="left">Location: {breadcrumbTrail: }</span>
+      <span class="right">Language: {langbar: }</span>
+      <div style="clear:both"></div>
+    </div>
+    <div id="menu">
+      {menu: vertical}
+    </div>
+    <div id="body">
+      {block: }
+    </div>
+    <div id="footer" class="bar">
+      <a href="http://webgen.rubyforge.org"><img src="{resource: webgen-generated}" alt="Generated by webgen"/></a> on <b>{date: }</b>
+    </div>
+  </body>
+</html>

data/doc/examples/website_templates/project/src/download.page ADDED

@@ -0,0 +1,15 @@
+---
+title: Download
+inMenu: true
+orderInfo: 30
+---
+h2. Download
+Download link will be here!
+List of dependencies:
+* Dep One v. 3.3.3
+* Dep Two v. 2.5.1 (optional)

data/doc/examples/website_templates/project/src/features.page ADDED

@@ -0,0 +1,8 @@
+---
+title: Features
+inMenu: true
+orderInfo: 20
+---
+h2. Features
+Here is the place where the feature list for your project should go.

data/doc/examples/website_templates/project/src/index.page ADDED

@@ -0,0 +1,9 @@
+---
+title: Homepage
+inMenu: true
+orderInfo: 0
+directoryName: Project XXX
+---
+h2. Project XXX
+This is the first page your viewers will see!

data/doc/examples/website_templates/project/src/screenshots.page ADDED

@@ -0,0 +1,18 @@
+---
+title: Screenshots
+inMenu: true
+orderInfo: 40
+---
+h2. Screenshots
+h3. Main View
+Image of Main View
+Description of image
+h3. Next image
+Image
+bla bla bla

data/doc/metainfo.yaml ADDED

@@ -0,0 +1,85 @@
+index.page:
+  orderInfo: 1
+news.page:
+  orderInfo: 2
+features.page:
+  orderInfo: 5
+download.page:
+  orderInfo: 8
+documentation/:
+  orderInfo: 9
+examples/:
+  orderInfo: 10
+  inMenu: true
+images:
+  indexFile: ~
+documentation/gettingstarted.page:
+  orderInfo: 3
+documentation/extending_webgen.page:
+  orderInfo: 5
+documentation/references/:
+  orderInfo: 7
+documentation/plugins/:
+  orderInfo: 9
+documentation/references/webpage_format.page:
+  orderInfo: 5
+documentation/references/parameter_reference.page:
+  orderInfo: 15
+documentation/references/meta_info_reference.page:
+  orderInfo: 10
+documentation/plugins/file:
+  indexFile: defaulthandler.page
+documentation/plugins/file/defaulthandler.page:
+  orderInfo: -1
+documentation/plugins/htmlvalidator:
+  indexFile: default.page
+documentation/plugins/contentconverter:
+  indexFile: default.page
+documentation/plugins/menustyle:
+  indexFile: default.page
+documentation/plugins/tag:
+  indexFile: default.page
+documentation/plugins/tag/default.page:
+  orderInfo: -1
+---
+api.html:
+  url: rdoc/index.html
+  title: API Reference
+documentation/references/api.html:
+  url: ../../rdoc/index.html
+  title: API Reference
+  inMenu: true
+  orderInfo: 60
+wiki.html:
+  url: http://webgen.rubyforge.org/wiki/wiki.pl
+  title: WikiWiki Web
+  inMenu: true
+  orderInfo: 11

data/doc/plugin/emoticon.rb CHANGED

@@ -1,29 +1,27 @@
-module WebgenDocuPlugins
+class ShowEmoticonsTag < Tags::DefaultTag
-  class ShowEmoticonsTag < Tags::DefaultTag
+  infos( :name => 'WebgenDocu/EmoticonTag',
+         :summary => "Creates a table of the existing emoticon packs"
+         )
-    summary "Creates a table of the existing emoticon packs"
+  register_tag 'showEmoticonPacks'
-    tag 'showEmoticonPacks'
+  def process_tag( tag, chain )
+    res = @plugin_manager['Core/ResourceManager'].resources
+    packs = Dir[File.join( Webgen.data_dir, 'resources', 'emoticons', '*/')].collect {|p| File.basename( p )}.sort
-    def process_tag( tag, node, refNode )
-      res = Webgen::Plugin.config[CorePlugins::ResourceManager].resources
-      packs = Dir[File.join( CorePlugins::Configuration.data_dir, 'resources', 'emoticons', '*/')].collect {|p| File.basename( p )}.sort
-      map = MiscPlugins::SmileyReplacer::SMILEY_MAP
-      output = '<table style="width: 100%; border: 1px solid black" summary="List of emoticon packs" rules="groups" frame="border">'
-      header = map.sort {|a,b| a[1] <=> b[1]}.collect {|s, name| "<th><code>#{s}</code><br />(#{name})</th>" }.join('')
-      output << "<thead><tr><th>Smiley/Pack</th>#{header}</tr></thead><tbody>"
-      packs.each do |pack|
-        output << "<tr><th>#{pack}</th>"
-        output << map.values.sort.collect do |v|
-          "<td align=\"center\"><img src=\"{resource: webgen-emoticons-#{pack}-#{v}}\" alt=\"smiley\"/></td>"
-        end.join('')
-        output << "</tr>"
-      end
-      output << "</tbody></table>"
+    map = @plugin_manager['Misc/SmileyReplacer'].class::SMILEY_MAP
+    output = '<table class="examples" summary="List of emoticon packs">'
+    header = map.sort {|a,b| a[1] <=> b[1]}.collect {|s, name| "<th><code>#{s}</code><br />(#{name})</th>" }.join('')
+    output << "<thead><tr><th>Smiley/Pack</th>#{header}</tr></thead><tbody>"
+    packs.each do |pack|
+      output << "<tr><th>#{pack}</th>"
+      output << map.values.sort.collect do |v|
+        "<td align=\"center\"><img src=\"{resource: webgen-emoticons-#{pack}-#{v}}\" alt=\"smiley\"/></td>"
+      end.join('')
+      output << "</tr>"
     end
+    output << "</tbody></table>"
   end
 end

data/doc/plugin/extension.rb CHANGED

@@ -1,84 +1,163 @@
-module WebgenDocuPlugins
+class SvgToPngConverter < FileHandlers::DefaultHandler
+  infos( :name => 'File/SvgToPng',
+         :summary => "Converts an svg image to png using inkscape"
+         )
+  register_extension 'svg'
+  def create_node( path, parent, meta_info )
+    name = File.basename( path, '.svg' ) + '.png'
+    node = parent.find {|c| c =~ name }
+    if node.nil?
+      node = Node.new( parent, name )
+      node['title'] = name
+      node.meta_info.update( meta_info )
+      node.node_info[:src] = path
+      node.node_info[:processor] = self
+    else
+      log(:warn) { "Can't create node <#{node.full_path}> as it already exists (node handled by #{node.node_info[:processor].class.plugin_name})!" }
+    end
+    node
+  end
+  def write_node( node )
+    if @plugin_manager['Core/FileHandler'].file_modified?( node.node_info[:src], node.full_path )
+      `inkscape -e #{node.full_path} #{node.node_info[:src]}`
+    end
+  end
+end
-  class VersionTag < Tags::DefaultTag
-    summary "Shows the version number of webgen"
+class VersionTag < Tags::DefaultTag
-    tag 'version'
+  infos( :name => 'WebgenDocu/VersionTag',
+         :summary => "Shows the version number of webgen"
+         )
-    def process_tag( tag, node, refNode )
-      Webgen::VERSION.join( '.' )
-    end
+  register_tag 'version'
+  def process_tag( tag, chain )
+    Webgen::VERSION.join( '.' )
   end
-  class DescribeTag < Tags::DefaultTag
+end
+class PluginRefTag < Tags::DefaultTag
+  infos( :name => 'WebgenDocu/PluginRefTag',
+         :summary => "Outputs a link to the given plugin name"
+         )
-    summary "Shows options for the specified file handler"
-    add_param 'plugin', nil, 'The plugin which should be described'
-    set_mandatory 'plugin', true
+  param 'plugin', nil, 'The plugin which should be referenced'
+  set_mandatory 'plugin', true
-    tag 'describe'
+  register_tag 'plugin'
-    def initialize
-      super
-      @processOutput = false
+  def process_tag( tag, chain )
+    plugin = param('plugin')
+    anchor = plugin.slice!( /#.*$/ )
+    if @plugin_manager.plugin_class_for_name( plugin ).nil? && plugin.index('/')
+      log(:error) { "Invalid link to plugin: #{plugin} in <#{chain.first.node_info[:src]}>" }
+      "INVALID PLUGIN"
+    else
+      pluginfile = (plugin.index('/') ? plugin.downcase + '.page' : plugin.downcase + '/') + anchor.to_s
+      "<span class='plugin-ref'><a href=\"{relocatable: /documentation/plugins/#{pluginfile}}\">#{plugin}</a></span>"
     end
+  end
+end
+class ParamRefTag < Tags::DefaultTag
+  infos( :name => 'WebgenDocu/ParamRefTag',
+         :summary => "Outputs a link to the plugin responsible for the given param name"
+         )
+  param 'param', nil, 'The param which should be referenced'
+  set_mandatory 'param', true
-    def process_tag( tag, node, refNode )
-      filehandler = get_param( 'plugin' )
-      self.logger.debug { "Describing tag #{filehandler}" }
-      plugin = Webgen::Plugin.config.find {|k,v| v.plugin == filehandler }
-      self.logger.warn { "Could not describe plugin '#{filehandler}' as it does not exist" } if plugin.nil?
-      ( plugin.nil? ? '' : format_data( plugin[1] ) )
+  register_tag 'param'
+  def process_tag( tag, chain )
+    plugin, param = param('param').split(':')
+    if @plugin_manager.plugin_class_for_name( plugin ).nil? || !@plugin_manager.plugin_class_for_name( plugin ).config.params.has_key?( param )
+      log(:error) { "Invalid link to parameter: #{plugin}:#{param} in <#{chain.first.node_info[:src]}>" }
+      "INVALID PARAM"
+    else
+      pluginfile = plugin.downcase + '.page'
+      link_text = ( chain.last.node_info[:pagename] == File.basename( pluginfile ) ? param : plugin + ':' + param )
+      "<span class='param-ref'><a href=\"{relocatable: /documentation/plugins/#{pluginfile}}\">#{link_text}</a></span>"
     end
+  end
-    def format_data( data )
-      s = "<table>"
-      row = lambda {|desc, value| "<tr style='vertical-align: top'><td style='font-weight:bold'>#{CGI::escapeHTML( desc )}:</td><td>#{value}</td></tr>" }
+end
-      # Plugin and ancestors
-      ancestors = data.klass.ancestor_classes[1..-1].collect {|k| Webgen::Plugin.config[k].plugin}.join(', ')
-      s += row['Plugin name', CGI::escapeHTML( data.plugin + (ancestors.empty? ? '' : " (#{ancestors})" ) )]
+class DescribeTag < Tags::DefaultTag
-      # summary, description
-      [['Summary', 'summary'], ['Description', 'description']].each do |desc, name|
-        s += row[desc, CGI::escapeHTML( data.send( name ) )] if eval( "data.#{name}" )
-      end
+  infos( :name => 'WebgenDocu/DescribeTag',
+         :summary => "Shows options for the specified plugin"
+         )
-      # dependencies
-      s += row['Dependencies', CGI::escapeHTML( data.dependencies.join( ', ') )] if data.dependencies
+  param 'plugin', nil, 'The plugin which should be described'
+  set_mandatory 'plugin', true
-      # parameters
-      unless data.params.nil?
-        s += row['Parameters', format_params( data.params )]
-      end
+  register_tag 'describe'
-      # used meta info
-      s += row['Used meta information', CGI::escapeHTML( data.used_meta_info.join( ', ') )] if data.used_meta_info
+  def initialize( pm )
+    super
+  end
-      # tag name, file ext
-      s += row['Name of tag', (data.tag == :default ? "Default tag" : data.tag)] if data.tag
-      s += row['Handled paths', data.path.collect {|p| CGI::escapeHTML( p )}.join('<br />')] if data.path
+  def process_tag( tag, chain )
+    plugin_name = param( 'plugin' )
+    log(:debug) { "Describing tag #{plugin_name}" }
+    plugin = @plugin_manager.plugin_class_for_name( plugin_name )
+    log(:warn) { "Could not describe plugin '#{plugin_name}' as it does not exist" } if plugin.nil?
+    ( plugin.nil? ? '' : format_data( plugin.config ) )
+  end
+  def format_data( data )
+    s = "<table class='plugin-info'>"
+    row = lambda {|desc, value| "<tr style='vertical-align: top'><th>#{CGI::escapeHTML( desc )}:</th><td>#{value}</td></tr>" }
-      # Show all registered handlers
-      data.table.keys.find_all {|k| /^registered_/ =~ k.to_s }.each do |k|
-        s += row[k.to_s.sub( /^registered_/, '' ).tr('_', ' ').capitalize + " name", data.send( k )]
-      end
+    # Plugin and ancestors
+    ancestors = data.plugin_klass.ancestor_classes[1..-1].collect {|k| "{plugin: #{k.plugin_name}}"}.join(', ')
+    s += row['Plugin name', CGI::escapeHTML( data.plugin_klass.plugin_name + (ancestors.empty? ? '' : " (#{ancestors})" ) )]
-      s += "</table>"
+    # summary, description
+    [['Author', :author], ['Summary', :summary], ['Description', :description]].each do |desc, name|
+      s += row[desc, CGI::escapeHTML( data.infos[name] )] if data.infos[name]
     end
-    def format_params( params )
-      params.sort.collect do |k,v|
-        "<span style='color: red'>#{v.name}</span>" + \
-        ( v.mandatory.nil? \
-          ? "&nbsp;=&nbsp;<span style='color: blue'>#{CGI::escapeHTML( v.default.inspect )}</span>" \
-          : " (=" + ( v.mandatoryDefault ? "default " : "" ) + "mandatory parameter)" ) + \
-        ": #{CGI::escapeHTML( v.description )}"
-      end.join( "<br />\n" )
+    # dependencies
+    s += row['Dependencies', CGI::escapeHTML( data.dependencies.collect {|k| "{plugin: #{k}}"}.join( ', ') )] unless data.dependencies.empty?
+    # parameters
+    unless data.params.empty?
+      s += row['Parameters', format_params( data.params )]
     end
+    # tag names, file ext, default meta info
+    s += row['Handled tags', (data.infos[:tags].collect {|t| t == :default ? "Default tag" : t}.join(', '))] if data.infos[:tags]
+    s += row['Handled paths', data.infos[:path_patterns].collect {|rank, path| CGI::escapeHTML( path )}.join('<br />')] if data.infos[:path_patterns]
+    s += row['Default Meta Information', "<pre>" + CGI::escapeHTML( data.infos[:default_meta_info].to_yaml.sub( /\A---\s*\n/m, '') ) + "</pre>"] if !data.infos[:default_meta_info].nil? && !data.infos[:default_meta_info].empty?
+    s += row['Handler name', data.infos[:handler_for]] if data.infos[:handler_for]
+    s += "</table>"
+  end
+  def format_params( params )
+    params.sort.collect do |k,v|
+      "<p class='param'><span class='param-name'>#{v.name}</span>" + \
+      ( v.mandatory.nil? ? "" : " (=" + ( v.mandatory_default ? "default ": "" ) + "mandatory parameter)" ) + \
+      ":&nbsp;<span class='param-default-value'>#{CGI::escapeHTML( v.default.inspect )}</span>" + \
+      "<br /><span class='param-description'>#{CGI::escapeHTML( v.description )}</span></p>"
+    end.join( "\n" )
   end
 end