Rake::TaskLib
Task library to manage a webgen website.
It is assumed that you have already used the 'webgen' command to create the website directory for the site.
require 'webgen/webgentask' Webgen::WebgenTask.new
The attributes available in the new block are:
the root directory of the webgen site (default Dir.pwd)
the config block for setting additional configuration options
remove webgens output directory on clobber (default false)
The tasks provided are :
render the webgen website
remove all the files created during generation
To integrate webgen tasks in another project you can use rake namespaces. For example assuming webgen's site directory is webgen under the main project directory use the following code fragment in project Rakefile:
require 'webgen/webgentask' namespace :dev do Webgen::WebgenTask.new do |site| site.directory = File.join(Dir.pwd, "webgen") site.clobber_outdir = true site.config_block = lambda |config| config['website.lang'] = 'de' end end end task :clobber => ['dev:clobber_webgen']
This will create the following tasks:
dev:webgen
dev:clobber_webgen
and add dev:clobber_webgen to the main clobber task.
During the clobber, should webgen's output directory be clobbered. The default is false.
The configuration block that is invoked when the Webgen::Website object is initialized. This can be used to set configuration parameters and to avoid having a config.yaml file lying around.
Create webgen tasks. You can override the task name with the parameter name.
# File lib/webgen/webgentask.rb, line 113 def initialize(name = 'webgen') @name = name @directory = Dir.pwd @clobber_outdir = false @config_block = nil yield self if block_given? define end
Generated with the Darkfish Rdoc Generator 2.