webgen 0.4.7 → 0.5.0

data/lib/webgen/websiteaccess.rb

@@ -0,0 +1,29 @@
+module Webgen
+
+  # Mixed into modules/classes that need access to the current website object.
+  module WebsiteAccess
+
+    # The methods of this module are available on classes that include WebsiteAccess.
+    module ClassMethods
+
+      # See WebsiteAccess.website
+      def website
+        WebsiteAccess.website
+      end
+
+    end
+
+    def self.included(klass) #:nodoc:
+      super
+      klass.extend(ClassMethods)
+    end
+
+    # Return the current website object or +nil+.
+    def website
+      Thread.current[:webgen_website]
+    end
+    module_function :website
+
+  end
+
+end

data/lib/webgen/websitemanager.rb

@@ -0,0 +1,124 @@
+require 'ostruct'
+require 'webgen/website'
+
+module Webgen
+
+  # This class is used for managing webgen websites. It provides access to website templates and
+  # styles defined as resources and makes it easy to apply them to a webgen website.
+  #
+  # = General information
+  #
+  # Currently, the following actions are supported:
+  #
+  # * creating a website based on a website template (#create_website)
+  # * applying a template to an existing website (#apply_template)
+  # * applying a style to an existing website (#apply_style)
+  #
+  # A website template defines some initial pages which should be filled with real data. For
+  # example, the @project@ template defines several pages which are useful for software projects
+  # including a features and about page.
+  #
+  # A style defines, for example, the basic page layout (in the case of website styles) or how image
+  # galleries should look like (in the case of gallery styles). So styles are basically used to
+  # change the appearance of parts (or the whole) website. This makes them a powerful tool as this
+  # plugin makes it easy to change a style later!
+  #
+  # = website template and style resource naming convention
+  #
+  # Styles and website templates are defined using resources. Each such resource has to be a
+  # directory containing an optional README file in YAML format in which key-value pairs provide
+  # additional information about the style or website template. All other files/directories in the
+  # directory are copied to the root of the destination webgen website when the style or website
+  # template is used.
+  #
+  # This class uses a special naming convention to recognize website templates and styles:
+  #
+  # * A resource named <tt>webgen-website-template-TEMPLATE_NAME</tt> is considered to be a website
+  #   template called TEMPLATE_NAME and can be later accessed using this name.
+  #
+  # * A resource named <tt>webgen-website-style-CATEGORY-STYLE_NAME</tt> is considered to be a style
+  #   in the category CATEGORY called STYLE_NAME. There are no fixed categories, one can use
+  #   anything here!  Again, the style can later be accessed by providing the category and style
+  #   name.
+  #
+  # Website template names have to be unique and style names have to be unique in respect to their
+  # categories!
+  #
+  # Note: All styles without a category or which are in the category 'website' are website styles.
+  class WebsiteManager
+
+    # A hash with the available website templates (mapping name to infos).
+    attr_reader :templates
+
+    # A hash with the available website styles (mapping name to infos).
+    attr_reader :styles
+
+    # The used Website object.
+    attr_reader :website
+
+    # Create a new WebsiteManager for the website +dir+.
+    def initialize(dir)
+      @website = Webgen::Website.new(dir)
+      @website.init
+      @styles = {}
+      @templates = {}
+
+      @website.execute_in_env do
+        [['webgen-website-style-', @styles], ['webgen-website-template-', @templates]].each do |prefix, var|
+          @website.config['resources'].select {|name, data| name =~ /^#{prefix}/}.each do |name, data|
+            paths = Webgen::Source::Resource.new(name).paths
+            readme = paths.select {|path| path == '/README' }.first
+            paths.delete(readme) if readme
+            infos = OpenStruct.new(readme.nil? ? {} : YAML::load(readme.io.data))
+            infos.paths = paths
+            var[name.sub(prefix, '')] = infos
+          end
+        end
+      end
+    end
+
+    # Create the basic website skeleton (without any template or style applied).
+    def create_website
+      raise "Directory <#{@website.directory}> does already exist!" if File.exists?(@website.directory)
+      @website.execute_in_env { write_paths(Webgen::Source::Resource.new('webgen-website-skeleton').paths) }
+    end
+
+    # Apply the given +template+ to the website by copying the template files.
+    def apply_template(name)
+      write_paths_to_website(@templates[name], 'template')
+    end
+
+    # Apply the given website style +name+ to the website by copying the styles files.
+    def apply_style(name)
+      write_paths_to_website(@styles[name], 'style')
+    end
+
+    #######
+    private
+    #######
+
+    # Do some sanity checks and write the +paths+ from +infos+ to the website directory.
+    def write_paths_to_website(infos, infos_type)
+      raise ArgumentError.new("Invalid #{infos_type} name") if infos.nil?
+      raise "Directory <#{@website.directory}> does not exist!" unless File.exists?(@website.directory)
+      write_paths(infos.paths)
+    end
+
+    # Write the paths to the website directory.
+    def write_paths(paths)
+      paths.each do |path|
+        output_path = File.join(@website.directory, path.path)
+        if path.path =~ /\/$/
+          FileUtils.mkdir_p(output_path)
+        else
+          FileUtils.mkdir_p(File.dirname(output_path))
+          path.io.stream do |source|
+            File.open(output_path, 'wb') {|f| FileUtils.copy_stream(source, f) }
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/man/man1/webgen.1

@@ -1,63 +1,54 @@
-.TH "WEBGEN" 1 "February 2007"
+.TH "WEBGEN" 1 "July 2008"
 .SH NAME
-webgen \- a template based static website generator
+webgen \- a fast, powerful and extensible static website generator
 .SH SYNOPSIS
 .B webgen
 [\fIglobal options\fR]
 \fIcommand\fR
 [\fIcommand arguments\fR] [command [command arguments] ...] [args]
 .SH DESCRIPTION
-webgen is used to generate web pages from page and template files.
-You create one template file in which you define the layout of your pages and
-where the content should go. After that you create page files in which you only
-define the content. webgen merges the page's content into the template and
-generates the final HTML output.
+webgen is used to generate static websites from content files written in a markup language and
+template files. You create one template file in which you define the layout of your pages and where
+the content should go. After that you create content files called page files in which you only
+define the content. webgen merges the page's content into the template and generates the final HTML
+output. During the last step so called webgen tags are substituted so that, for example, menus can
+automatically be generated.
 .SH GLOBAL OPTIONS
 .TP
 .B \-d, \-\-directory DIR
 Set the website directectory. if none specified, the current directory is used.
 .TP
-.B \-V, \-\-verbosity level
-Set verbosity to the given \fIlevel\fR.
+.B \-v, \-\-verbose
+Show more output by default.
+.TP
+.B \-q, \-\-quiet
+Show less output by default. If this option is specified, then no output is shown during rendering
+of a website.
+.TP
+.B \-l, \-\-log-level LEVEL
+Set the logging level to LEVEL which can be a number between 0 (debug output) and 3 (only error
+output).
 .TP
 .B \-h, \-\-help
 Show generic help.
 .TP
-.B \-v, \-\-version
+.B \-\-version
 Show the version of the program and exit.
 .SH COMMANDS
 .TP
-\fBcheck\fR
-Executes \fBcheck command\fR by default.
-.TP
-\fBcheck config\fR
-Checks validity of configuration file.
-.TP
-\fBcheck libs\fR
-Checks presence of optional libraries.
-.TP
 \fBcreate\fR
-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.
-Takes the \fIdirectory\fR to create the webgen structure in as an argument.
+Creates the basic directories and files for webgen.  This includes the source and
+output directories as well as an empty extensions directory.  Also, a basic template plus a CSS and
+an index file are created.  Takes the \fIdirectory\fR to create the webgen structure in as an
+argument.
 .TP
 \fBhelp\fR
 Provides help for the individual commands.
 .TP
-\fBrun\fR
-Runs webgen which will result in the generation of the HTML data
-in the output directory from the files in the source directory.
-This command is used as the default command when no command was issued.
-.TP
-\fBshow\fR
-Shows all available plugins or their configuration items.
-Takes either \fIconfig\fR or \fIplugins\fR as an argument.
-.TP
-\fBuse\fR
-Changes configured gallery style, sipttra or website style. Takes either
-\fIgallery_style\fR, \fIsipttra_style\fR or \fIwebsite_style\fR as an argument
-plus the gallery, sipttra or website style name you want to configure.
+\fBrender\fR
+Runs webgen which will result in the generation of the HTML data in the output
+directory from the files in the source directory.  This command is used as the default command when
+no command was issued.
 .TP
 \fBversion\fR
 Shows the version of the program and exit.
@@ -66,10 +57,8 @@ The webgen website, http://webgen.rubyforge.org/ for more information.
 .SH AUTHOR
 webgen was written by Thomas Leitner <t_leitner@gmx.at>
 .PP
-This manual page was written by Paul van Tilburg <paulvt@debian.org>
-for the Debian project (but may be used by others).
-This manual page was update to reflect webgen 0.4 change by Arnaud Cornet
-<arnaud.cornet@gmail.com>.
-This manual page was updated to reflect webgen 0.4.2 changes by
-Thomas Leitner <t_leitner@gmx.at>.
+This manual page was written by Paul van Tilburg <paulvt@debian.org> for the Debian project (but may
+be used by others).  This manual page was update to reflect webgen 0.4 change by Arnaud Cornet
+<arnaud.cornet@gmail.com>.  This manual page was updated to reflect webgen 0.5.x changes by Thomas
+Leitner <t_leitner@gmx.at>.
 

data/misc/default.css

@@ -0,0 +1,337 @@
+/********************************************
+   AUTHOR:  			Erwin Aligam
+   WEBSITE:   			http://www.styleshout.com/
+   TEMPLATE NAME: 	ablaze
+   TEMPLATE CODE: 	S-0009
+   VERSION:          2.1
+   *******************************************/
+
+/********************************************
+   HTML ELEMENTS
+
+ ********************************************/
+
+/* top elements */
+* {
+  padding: 0;
+  margin: 0;
+}
+
+body {
+  margin: 0;
+  padding: 0;
+  font: normal .80em/1.5em Tahoma, 'Trebuchet MS', sans-serif;
+  color: #000;
+  text-align: center;
+  background-color: #FCFFF5;
+}
+
+/* links */
+a {
+  color: #3E606F;
+  background-color: inherit;
+  text-decoration: underline;
+}
+
+a:hover {
+  color: #193441;
+  background-color: #D1DBBD;
+}
+
+/* headers */
+h1, h2, h3, h4, h5, h6 {
+  font: bold 1.3em 'Trebuchet MS', Arial, Sans-serif;
+  color: #CE900A;
+}
+h1 { font-size: 1.6em; }
+h2 { font-size: 1.4em; color: #A0080D }
+h3 { font-size: 1.3em; }
+
+#main h1 {
+  color: #193441;
+  padding-top: 15px;
+}
+
+#sidebar h1 {
+  font: bold 1.4em 'Trebuchet MS', Arial, Sans-serif;
+  background: url(images/arrow.gif) no-repeat 5px .6em;
+  padding: 7px 0 7px 30px;
+  color: #193441;
+}
+
+p, h1, h2, h3 {
+  margin: 0;
+  padding: 5px 0px;
+}
+
+ul, ol {
+  margin: 10px 0px;
+  padding: 0 15px;
+  color: #000; /* #3E606F; */
+}
+
+/* images */
+img {
+  border: none;
+}
+
+pre {
+  margin: 5px 0px;
+  padding: 5px;
+  text-align: left;
+  overflow: auto;
+  font: 'Lucida Console', 'courier new', monospace;
+  color: #193441;
+  background: #D1DBBD;
+  border-bottom: 1px solid #91AA9D;
+  border-top: 1px solid #91AA9D;
+}
+
+code {
+  font: 'Lucida Console', 'courier new', monospace;
+  color: #193441;
+  font-size: 115%;
+}
+
+acronym {
+  cursor: help;
+  border-bottom: 1px solid #777;
+}
+
+blockquote.exclamation, blockquote.error, blockquote.information {
+  margin: 10px 0px;
+  padding: 0 0 0 40px;
+  min-height: 40px;
+  border: 1px solid #91AA9D;
+  font: 'Trebuchet MS', Sans-serif;
+  background-color: #D1DBBD;
+  background-image: url(images/quote.gif);
+  background-repeat: no-repeat;
+  background-position: 5px 5px;
+}
+
+blockquote.exclamation {
+  background-image: url(images/exclamation.gif);
+}
+
+blockquote.error {
+  background-image: url(images/error.gif);
+}
+
+blockquote.information {
+  background-image: url(images/information.gif);
+}
+
+blockquote pre {
+  border: none;
+}
+
+/***********************
+   LAYOUT
+   ************************/
+
+#header-content, #content {
+  width: 100%;
+}
+
+/* header */
+#header {
+  background: #444 url(images/headerbg.jpg) repeat-x 0 0;
+  height: 120px;
+  text-align: left;
+}
+
+#header-content {
+  position: relative;
+  margin: 0 auto;
+  padding: 0;
+}
+
+#header-content #logo {
+  position: absolute;
+  font: bold 50px Verdana, 'Trebuchet Ms', Sans-serif;
+  letter-spacing: -2px;
+  color: #FCFFF5;
+  margin: 0; padding: 0;
+
+  top: 5px; left: 20px;
+}
+
+#header-content #slogan {
+  position: absolute;
+  font: bold 16px 'Trebuchet Ms', Sans-serif;
+  text-transform: none;
+  color: #CCC;
+  margin: 0; padding: 0;
+
+  top: 65px; left: 35px;
+}
+
+/* header menu */
+#header-content ul {
+  position: absolute;
+  right: 20px; top: 75px;
+  font: bolder 1.3em 'Trebuchet MS', sans-serif;
+  color: #FCFFF5;
+  list-style: none;
+  margin: 0; padding: 0;
+}
+#header-content li {
+  float: left;
+  display: block;
+  color: #FCFFF5;
+  text-decoration: none;
+}
+#header-content li a, #header-content li span {
+  display: block;
+  color: #3E606F;
+  text-decoration: none;
+  padding: 3px 12px;
+}
+#header-content li a:hover {
+  background: #FCFFF5;
+  color: #A0080D;
+}
+#header-content li.webgen-menu-item-selected, #header-content li.webgen-menu-submenu-inhierarchy {
+  background: #FCFFF5;
+  color: #A0080D;
+}
+
+/* content */
+#content-wrap {
+  clear: both;
+  float: left;
+  width: 100%;
+}
+
+#content {
+  text-align: left;
+  padding: 0; margin: 0 auto;
+  background: #91AA9D;
+}
+
+/* sidebar */
+#sidebar {
+  float: right;
+  width: 340px;
+  margin: 0; padding: 10px;
+  background-color: #91AA9D;
+}
+#sidebar ul {
+  list-style: inside square;
+  margin: 0px;
+  padding: 0px;
+}
+#sidebar ul li {
+  padding: 0px;
+  margin: 0px;
+  padding-left: 1em;
+  padding-top: 0.3em;
+}
+#sidebar ul a {
+  color: #FCFFF5;
+  text-decoration: none;
+  padding: .3em 0 .3em 3px;
+  line-height: 1.5ex;
+}
+#sidebar ul a:hover {
+  border-left: 5px solid  #193441;
+  color: #193441;
+}
+
+/* main */
+#main {
+  margin: 0 360px 0 0;
+  padding: 20px;
+  background-color: #FCFFF5;
+}
+
+/* footer */
+#footer {
+  clear: both;
+  color: #FCFFF5;
+  margin: 0;
+  padding: 0;
+  border-top: 1px solid #3E60F6;
+  font-size: 95%;
+  text-align: left;
+}
+#footer h2, #footer p {
+  padding-left: 0;
+}
+#footer-content {
+  width: 100%;
+  margin: 0 auto;
+  position: absolute;
+  background-color: #193441;
+}
+#footer-content a {
+  text-decoration: none;
+  color: #CCC;
+}
+#footer-content a:hover {
+  text-decoration: underline;
+  background-color: inherit;
+}
+#footer-content ul {
+  list-style: none;
+  margin: 0;
+  padding: 0;
+}
+#footer-content .col {
+  width: 32%;
+  padding: 0 5px 30px 15px;
+}
+#footer-content .col2 {
+  width: 30%;
+  padding: 0 0 30px 0;
+}
+
+/* alignment classes */
+.float-left  { float: left; }
+.float-right { float: right; }
+.align-left  {	text-align: left; }
+.align-right {	text-align: right; }
+
+/* additional classes */
+.clear { clear: both; }
+.comments {
+  text-align: right;
+  border: 1px dashed #151515;
+  padding: 5px 10px;
+  margin: 20px 15px 10px 15px;
+}
+.small {
+  font-size: 90%;
+  color: #666;
+  padding: 2px;
+}
+
+
+/* plugin documentation classes */
+.plugin-info .param-name {
+  color: #193441;
+}
+
+.plugin-info .param-default-value {
+  color: #A0080D;
+}
+
+.plugin-info p.param {
+  padding: 0px 0px 5px;
+}
+
+
+/* blog related classes */
+div.blog-entry {
+  margin-bottom: 15px;
+}
+
+blockquote.blog-entry-details {
+  font-size: 80%;
+  margin-bottom: 5px;
+}
+
+.blog-entry-date, .blog-entry-author {
+  font-weight: bold;
+}