webgen 0.5.17 → 1.0.0.beta1

data/doc/upgrading.page

@@ -1,138 +0,0 @@
----
-title: Upgrading from 0.4.x
----
-# Upgrading
-
-Here are step-by-step instructions on how to update your webgen website from 0.4.x to 0.5.x:
-
-* **Update the configuration file `config.yaml`**
-
-  The configuration file syntax as well as the names of the configuration options and some defaults
-  changed. For example, the default processing pipeline now uses kramdown (a Markdown converter) as
-  markup language processor instead of Textile. You can find an overview over all available
-  configuration options in the [configuration option reference](reference_configuration.html). Also
-  have a look at the [configuration file documentation](manual.html#website-configfile) for more
-  information on the syntax of this file and the available helpers.
-
-  * Name changes: All configuration options now use underscores to separate word parts instead of
-    camelCase.
-  * Syntax changes: The configuration options are not specific to a certain extension anymore. You
-    now need the full configuration option name to specify it. So instead of
-
-        Tag/Menu:
-          maxLevels: 4
-
-    you now use
-
-        tag.menu.max_levels: 4
-
-* **Convert your `metainfo.yaml`**
-
-  This file is not supported anymore since webgen 0.5.x uses a more flexible way for specifying meta
-  information and virtual paths. You need to migrate its data to `metainfo` and `virtual` files in
-  the source directory. Have a look at the documentation of the [metainfo source
-  handler](sourcehandler/metainfo.html) and the [virtual source
-  handler](sourcehandler/virtual.html).
-
-* **Update meta information names and values**
-
-  The names of some meta information keys have been changed. Meta information names are not
-  specified in camelCase anymore but with under_scores. You can find a complete list of supported
-  meta information names in the [meta information reference](reference_metainfo.html). The most
-  notable changes are:
-
-  * directoryName → routed_title
-  * inMenu → in_menu
-  * indexFile → index_path
-  * omitIndexPath → omit_index_path
-  * outputNameStyle → output_path_style
-  * orderInfo → sort_info
-
-  Also be aware that the syntax of some meta information keys has changed. For example, all meta
-  information keys that took a source path name, e.g. `index_path`, now take an localized canonical
-  name.
-
-  You need to change the names/value in all places where meta information can be specified:
-
-  * `metainfo` files
-  * `virtual` files
-  * page and template files
-
-* **Files in [Webgen Page Format](webgen_page_format.html)**
-
-  Since the format of these files changed a little bit you may need to adapt all your files that use
-  it, that are primarily page and template files. The main change in the format was a different use
-  of the block start line. Whereas before you would write
-
-      --- content, textile
-
-  for specifying the name of the block and its processor, you now can specify any number of
-  options. Two options are currently used by webgen: `name` and `pipeline`. So you could change the
-  name and the processing pipeline of a block by using a block start line like:
-
-      --- name:other pipeline:tags,kramdown,blocks
-
-* **Block inclusion in template/page files**
-
-  The way how named blocks are included has changed. This feature is now provided by the content
-  processor [blocks](contentprocessor/blocks.html) instead of the tag `block`. This allows you to
-  specify the point in the processing pipeline when a block should be included. So you definitely
-  need to update your `default.template` file as well as any other page/template file where you used
-  the `block` tag.
-
-  So you need to look for `\{block: content}` tags (where `content` is just a place holder for the
-  name of the block that should be included) and replace them with `<webgen:block name='content'
-  />`.
-
-* **Update tag names and parameters**
-
-  Since the names of the configuration options changed (from using camelCase to using under_scores)
-  and some tags have different options, you need to change all tag parameters. You may also need to
-  convert old tag names to new ones (same reason: camelCase to under_score), for example,
-  `includeFile` is now `include_file`.
-
-* **Update your ERB code**
-
-  If you have any ERB code in your template or page files you will most certainly have to adapt them
-  to the new [API](api.html). One thing that has been used often is the check if a page file has a
-  certain block:
-
-      <%% if node.node_info[:page_data].blocks.has_key?('NAME') %>
-      ...
-      <%% end %>
-
-  This needs to be changed into the following:
-
-      <%% if context.content_node.node_info[:page].blocks.has_key?('NAME') %>
-      ...
-      <%% end %>
-
-* **Extensions development**
-
-  Since the complete core of webgen has changed you need to rewrite all your plugins for the 0.5.x
-  series. Howver, webgen has complete [API documentation](api.html) now which provides you with all
-  needed information as well as examples on how to implement source handlers, tags, content
-  processors, ... If you still have any questions, don't hesitate to contact me or write a mail to
-  the mailing list!
-
-* **Running webgen on the converted website**
-
-  You now can run webgen 0.5.x on the converted website. This helps in ironing out the remaining
-  errors, for example:
-
-  * If you have forgotten to change a block start line, you will get an application error and the
-    name of the file where the error occured.
-
-  * If you have overlooked changing a tag parameter, you will find `ERROR` and `WARN` lines in the
-    log output showing you what still needs to be changed.
-
-* **Not Implement Yet**: There are several features of the 0.4.x series which are currently not
-  implemented in the 0.5.x series:
-
-  * source handlers: gallery, sipttra
-  * tags: customvar (won't be ported), download, htmlmetainfo, news (won't be ported, superceded
-    by blogging support), resource, wikilink
-  * misc: smiley replacer, html validators
-  * CLI commands: check, show, use
-
-  If you need any of those you have to wait till they are implemented or port them on your on.

data/doc/webgen_page_format.page

@@ -1,129 +0,0 @@
----
-title: Webgen Page Format
----
-## Webgen Page Format
-
-The Webgen Page Format is a custom format designed primarily for page and template files. It
-consists of an optional meta information block and one or more blocks of data; it is very simple and
-easy to use.
-
-## Structure
-
-A file using the Webgen Page Format consists of one or more blocks which are the smallest units
-recognized. Blocks are separated from each other through a line containing three dashes. This is
-illustrated in the following examples which are all valid files in WebPage Format:
-
-Example 1:
-
-    Here is a block!
-
-Example 2:
-
-    This is one block of the file
-    ---
-    This is another block.
-
-Example 3:
-
-    Block 1
-    --- name:block2
-    Block 2
-    --- name:block3
-    Block 3...
-
-If you want to use three dashes in a block but you don't want to end the block, you have to escape
-them with a backslash character, like this:
-
-    Block 1
-    \---
-    still Block 1
-    --- name:block2
-    Block 2
-
-All of the above examples show one kind of block, the content block. However, there may also be
-another type of block: the meta information block. Following is a short description of both kinds,
-starting with the meta information block.
-
-
-### Meta Information Block
-
-Each file in Webgen Page Format can have zero or one meta information blocks. This block is
-specified at the beginning of the file. To tell the parser that the first block is the meta
-information block and not a content block, you have to start the file with three dashes:
-
-    ---
-    title: The title set by Meta info
-    ---
-    This is the content of the file
-
-The above defines a meta information block and a content block. The meta information block has to be
-in YAML format and should contain key-value pairs of meta information. [YAML](http://www.yaml.org)
-is a simple markup language designed for ease of use and although you define structured data with
-it, it feels like just writing a plain text document.
-
-
-### Content Blocks
-
-A content block is used to provide content in a specific format. Each file in Webgen Page Format
-needs to have at least one content block which may be empty. However, it can have as many content
-blocks as necessary. This functionality can be used, for example, to provide the main content of an
-HTML page in one block and sidebar content in another one.
-
-Each content block needs to have a unique name and additional options can also be set. The name
-uniquely identifies a content block and is used to access it. The only option used by webgen is the
-`pipeline` option which specifies the processing pipeline for the block. The processing pipeline is
-used for rendering the block by using the specified content processors in the specified order. There
-are many different content processors available - have a look at the [extensions
-page](extensions.html) for an overview.
-
-webgen extensions that use files in Webgen Page Format may specify defaults for the name and the
-options of a block but these defaults can be overwritten. You can use one of two ways to do this:
-
-* you either specify the name and additional options of the block on the starting line with the
-  three dashes
-
-* or you use the special meta information `block` to define the names and options of one or all
-  blocks.
-
-The following example uses the first technique to override the name and/or the `pipeline` option:
-
-    1. content block of the file
-    --- name:sidebar pipeline:kramdown,tags
-    2. content block of the file
-    --- name:other
-    3. content block of the file
-
-The first block has no identifieres set (there is no line with three dashes and the identifieres).
-Therefore the default value for the name is used: `content`. The second block is named `sidebar` and
-uses the processing pipeline `kramdown,tags`. As you can see, the name of a block as well as
-additional options are specified by stating the key (e.g. `name` or `pipeline`) followed by a colon
-and the value. Multiple options are separated via one or more spaces. The value of a block option is
-parsed with YAML. For example, when specifying `use_something:true` the value `true` is
-automatically converted from the string `true` to the boolean `true`.
-
-> Only the first block gets the default name of `content`. The second and following blocks have
-> numbered names like `block2`, `block3` and so on.
-{:.information}
-
-You can also set the name and additional options of the content blocks by using the special `blocks`
-meta information. It is a hash using the index of a block (or the special value `default`) as key
-and the options as values. The above example can therefore also be written like this:
-
-    ---
-    blocks: \{2: {name: sidebar, pipeline: kramdown,tags}, 3: {name: other}}
-    ---
-    1. content block of the file
-    ---
-    2. content block of the file
-    ---
-    3. content block of the file
-
-When selecting a value for the name of a block or an option, the following precedence is used (from
-low to high):
-
-* global defaults set via the `default` key of the meta information `blocks`
-* block defaults set via the meta information `blocks`
-* the `--- line` options
-
-As stated above, the "option" `name` is special insofar that when it is not set, an automatic name
-gets generated.

data/doc/website_styles.metainfo

@@ -1,8 +0,0 @@
-website_styles/*/default.template:
-  template: ~
-
-website_styles/*/:
-  index_path: style.html
-
-website_styles/:
-  index_path: ~

data/lib/webgen/cli/apply_command.rb

@@ -1,66 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-require 'webgen/cli'
-require 'webgen/websitemanager'
-
-module Webgen::CLI
-
-  # The CLI command for applying a bundle to a webgen website.
-  class ApplyCommand < CmdParse::Command
-
-    def initialize #:nodoc:
-      super('apply', false)
-      @force = false
-
-      self.short_desc = 'Apply a website bundle to an existing webgen website'
-      self.options = CmdParse::OptionParserWrapper.new do |opts|
-        opts.separator "Options:"
-        opts.on('-f', '--[no-]force', 'Specifies whether files should be overwritten (default: no)') do |val|
-          @force = val
-        end
-        opts.separator ""
-        opts.separator "Arguments:"
-        opts.separator opts.summary_indent + "BUNDLE_NAME: The name of a bundle shipped with webgen. The name is "
-        opts.separator opts.summary_indent + "    matched against all possible bundle names and if there is only "
-        opts.separator opts.summary_indent + "    match the bundle is applied."
-        opts.separator opts.summary_indent + "BUNDLE_URL:  The URL of a bundle (needs to be a tar archive"
-      end
-    end
-
-    def usage # :nodoc:
-      "Usage: #{commandparser.program_name} [global options] apply [options] (BUNDLE_NAME|BUNDLE_URL)"
-    end
-
-    def show_help # :nodoc:
-      super
-      wm = Webgen::WebsiteManager.new(commandparser.directory)
-
-      puts
-      puts "Available bundles:"
-      puts Utils.headline('Bundles')
-      wm.bundles.sort.each {|name, entry| Utils.hash_output(name, entry.instance_eval { @table }) }
-    end
-
-    # Apply the style specified in <tt>args[0]</tt> to the webgen website.
-    def execute(args)
-      wm = Webgen::WebsiteManager.new(commandparser.directory)
-      if !File.directory?(wm.website.directory)
-        raise "You need to specify a valid webgen website directory!"
-      elsif args.length == 0
-        raise OptionParser::MissingArgument.new('STYLE')
-      else
-        name = Utils.match_bundle_name(wm, args[0])
-        puts "The following files in the website directory will be created or overwritten:"
-        puts wm.bundles[name].paths.sort.join("\n")
-        continue = @force
-        if !continue
-          print "Procede? (yes/no): "
-          continue = ($stdin.readline =~ /y(es)?/)
-        end
-        wm.apply_bundle(name) if continue
-      end
-    end
-
-  end
-
-end

data/lib/webgen/cli/run_command.rb

@@ -1,22 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-require 'webgen/cli'
-
-module Webgen::CLI
-
-  # The CLI command for rendering a webgen website.
-  class RunCommand < CmdParse::Command
-
-    def initialize # :nodoc:
-      super('render', false)
-      self.short_desc = 'Render the webgen website'
-    end
-
-    # Render the website.
-    def execute(args)
-      commandparser.create_website.render
-    end
-
-  end
-
-end

data/lib/webgen/cli/webgui_command.rb

@@ -1,68 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-require 'webgen/cli'
-
-module Webgen::CLI
-
-  # The CLI command for starting the webgen webgui.
-  class WebguiCommand < CmdParse::Command
-
-    def initialize # :nodoc:
-      super('webgui', false)
-      self.short_desc = 'Starts the webgen webgui'
-    end
-
-    # Render the website.
-    def execute(args)
-      # some fixes for ramaze-2009.04
-      # - fix for Windows when win32console is not installed
-      # - fix for message displayed on shutdown
-      # - fix for warning message
-      $:.unshift File.join(Webgen.data_dir, 'webgui', 'overrides')
-      require 'win32console'
-      $:.shift
-      begin
-        oldv, $VERBOSE = $VERBOSE, nil
-        begin
-          require 'ramaze/snippets/object/__dir__'
-          Object.__send__(:include, Ramaze::CoreExtensions::Object)
-          require 'ramaze'
-        rescue LoadError
-          puts "The Ramaze web framework which is needed for the webgui was not found."
-          puts "You can install it via 'gem install ramaze --version 2009.04'"
-          return
-        end
-      ensure
-        $VERBOSE = oldv
-      end
-      def Ramaze.shutdown; # :nodoc:
-      end
-
-      require File.join(Webgen.data_dir, 'webgui', 'app.rb')
-      Ramaze::Log.loggers = []
-      Ramaze.options[:middleware_compiler]::COMPILED[:dev].middlewares.delete_if do |app, args, block|
-        app == Rack::CommonLogger
-      end
-
-      puts 'Starting webgui on http://localhost:7000, press Control-C to stop'
-
-      Thread.new do
-        begin
-          require 'launchy'
-          sleep 1
-          puts 'Launching web browser'
-          Launchy.open('http://localhost:7000')
-        rescue LoadError
-          puts "Can't open browser because the launchy library was not found."
-          puts "You can install it via 'gem install launchy'"
-          puts "Please open a browser window and enter 'http://localhost:7000' into the address bar!"
-        end
-      end
-
-      Ramaze.start(:adapter => :webrick, :port => 7000, :file => File.join(Webgen.data_dir, 'webgui', 'app.rb'))
-      puts 'webgui finished'
-    end
-
-  end
-
-end

data/lib/webgen/common.rb

@@ -1,27 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-module Webgen
-
-  # Namespace for classes and methods that provide common functionality.
-  module Common
-
-    autoload :Sitemap, 'webgen/common/sitemap'
-
-    # Return the constant object for the given absolute constant +name+.
-    def self.const_for_name(name)
-      name.split('::').inject(Object) {|b,n| b.const_get(n)}
-    end
-
-    # Return the error line by inspecting the backtrace of the given +error+ instance.
-    def self.error_line(error)
-      (error.is_a?(::SyntaxError) ? error.message : error.backtrace[0]).scan(/:(\d+)/).first.first.to_i rescue nil
-    end
-
-    # Return the file name where the error occured.
-    def self.error_file(error)
-      (error.is_a?(::SyntaxError) ? error.message : error.backtrace[0]).scan(/(?:^|\s)(.*?):(\d+)/).first.first
-    end
-
-  end
-
-end