webgen 0.5.17 → 1.0.0.beta1

data/doc/reference_metainfo.page

@@ -1,265 +0,0 @@
----
-title: Meta Information Reference
----
-# Meta Information Reference
-
-Following is a list of all the meta information items that are used in one way or another by an
-extension, be it a source handler, a tag or any other extension. Each meta information description
-follows the same pattern:
-
-* First the type of the value and an example value are listed.
-* Then the paths for which this item is useful are listed.
-* And at last follows a detailed description.
-
-
-{:miref: .meta-information-ref}
-
-### author
-
-* String: `Thomas Leitner`
-* Any
-{:miref}
-
-Sets the author of the path. This information is used, for example, by Webgen::SourceHandler::Feed.
-
-### author_url
-
-* String: `http://webgen.rubyforge.org`
-* Any where `author` is also set
-{:miref}
-
-Sets the homepage of the author of the path. This information is used, for example, by
-Webgen::SourceHandler::Feed and normally only when `author` is also set.
-
-### blocks
-
-* Hash of Hashes: `\{default: {pipeline:textile}, 1: {name: content, pipeline:maruku,erb,tags}}`
-* Files in Webgen Page Format
-{:miref}
-
-Specifies the default names and additional options for the blocks. The special key `default` is used
-to set default options for all blocks. Specific options for (or the name of) a block can be set by
-using the block index as key (numbering starts from one).
-
-### change_freq
-
-* String: `hourly`
-* Any
-{:miref}
-
-Sets the change frequency of the page. This information is used, for example, by the sitemap source
-handler. You can use the following values for this key: `hourly, daily, weekly, monthly, yearly,
-never`.
-
-### created_at
-
-* Time: `2008-08-14 10:25:34 +02:00`
-* Any
-{:miref}
-
-Sets the time when the path was created. This information cannot automatically be derived for paths
-provided by Webgen::Source::FileSystem, so this has to be set manually.
-
-> Note that the value needs to be a valid [YAML timestamp](http://yaml.org/type/timestamp.html) and
-> needs to include the time part.
-{:.information}
-
-### draft
-
-* Boolean: `true`
-* Any
-{:miref}
-
-If this meta information is set on a path, no node will be created from it. This is useful to add
-content to a website which should only be used later on.
-
-### fragments_in_menu
-
-* Boolean: `false`
-* Page files
-{:miref}
-
-Specifies if the fragment nodes of the page file should be in the menu.
-
-### index_path
-
-* String: `myindex.html`
-* Directories
-{:miref}
-
-Sets the directory index path for the directory overriding the default value.
-
-### in_menu
-
-* Boolean: `true`
-* Any
-{:miref}
-
-Specifies if the path should appear in menus.
-
-### kind
-
-* String: `page`
-* Any
-{:miref}
-
-Specifies the kind of the path. Some source handlers define a default value for this meta
-information for nodes created by them.
-
-### lang
-
-* String: `de`
-* Any
-{:miref}
-
-Sets the language for the path. Has to be a valid ISO-639-1/2 character code for the language. This
-meta information needs to be set before a node gets created.
-
-### link
-
-* Hash: `\{next: next_doc.html, prev: prev_doc.html}`
-* Page files
-
-Specifies additional information, for example, about the position of the page file regarding other
-files. A sample usage would be to express that the page file is logically followed or preceded by
-certain page file.
-
-The value needs to be hash and its keys need to be [link types] except for the special `javascript`
-and `css` keys (which will be discussed below). The link type is used to specify the relation of the
-page to the linked file. The value can either be a string which is interpreted as a path to the
-internal or external file; or a hash with arbitrary key-value pairs (use lower case key names) but
-it should include at least a `href` key to specify the path to the internal or external file; or an
-array containing strings or hashes to specify more than one linked file for a given link type.
-
-The special keys `javascript` and `css` may have an array of strings or a string as value which are
-interpreted as path to javascript/CSS files that should be included.
-
-This information is used by [`ContentProcessor::Head`](contentprocessor/head.html) to insert the
-approriate tags in the head section of an HTML document.
-
-[link types]: http://www.w3.org/TR/html401/types.html#type-links
-
-### link_attrs
-
-* Hash: `\{title: Hallo, class: extra}`
-* Any
-{:miref}
-
-Specifies additional attribute-value pairs (in form of a Hash) that should be added to a link to the
-path.
-
-### meta
-
-* Hash: `\{author: Thomas Leitner, generator: My program}`
-* Page files
-{:miref}
-
-Specifies names and values for `<meta>` HTML tags. These key-value pairs are then properly escaped
-and inserted into the output file by [`ContentProcessor::Head`](contentprocessor/head.html).
-
-### modified_at
-
-* Time: `2008-08-14 10:25:34 +02:00`
-* Any
-{:miref}
-
-Sets the time when the path was last modified. This information is automatically set for paths
-provided by Webgen::Source::FileSystem (the file modification is used) but can be overridden by
-setting it manually. If not set to a valid time, the time when webgen is executed is used for this
-meta information.
-
-> Note that the value needs to be a valid [YAML timestamp](http://yaml.org/type/timestamp.html) and
-> needs to include the time part.
-{:.information}
-
-### no_output
-
-* Boolean: `true`
-* Any
-{:miref}
-
-Specifies whether an output path for the node should be written or not. This differs from `draft`
-that a node for the path gets created nonetheless.
-
-### omit_index_path
-
-* Boolean: `false`
-* Index paths
-{:miref}
-
-Controls whether the index path should appear in a breadcrumb trail despite the setting of the
-`tag.breadcrumbtrail.omit_index_path` option.
-
-### output_path_style
-
-* Array: `[:parent, :basename, [., :lang], .html]`
-* Any
-{:miref}
-
-Sets a custom output path style for the specified path. The basename is substituted for the value
-`:basename` and the language for the value `:lang`. Strings are used verbatim. If `:lang` is
-specified in a sub-array, the whole sub-array is omitted, if the configuration option
-`sourcehandler.default_lang_in_output_path` is false. For more and detailed information, have look
-at the [output path creation section](manual.html#source-output) of the manual!
-
-> This meta information has to be set BEFORE a node gets created. Setting this value is therefore
-> only useful, for example, in the `paths` block of a meta information backing file.
-{:.important}
-
-### priority
-
-* Float: `0.5`
-* Any
-{:miref}
-
-Specifies the priority of this file in respect to all the other files of the website. This
-information is used, for example, by the sitemap source handler.
-
-### routed_title
-
-* String: `Image Directory`
-* Any
-{:miref}
-
-Only used if set on a directory index path; specifies the title of the directory for which it is the
-index path. If this meta information is not specified, the title of the directory will be used
-instead.
-
-### sort_info
-
-* Integer or String: `15`
-* Any
-{:miref}
-
-Sets the sort information for the path. Any String or Integer value can be used here. When two nodes
-are compared using this information and both have Integers, then an Integer comparision is
-done. Otherwise a String comparision is done.
-
-Setting a String value is useful, for example, for specifying dates as sort information.
-
-### template
-
-* String or null: `my.template` or `~`
-* Page/Template files
-{:miref}
-
-Sets the template for the page/template file overriding the default value. If set to null
-(i.e. `~`), no template is used for the page/template file!
-
-### title
-
-* String: `New Title`
-* Any
-{:miref}
-
-Sets the title for the path.
-
-### used_nodes
-
-* Array: `[*.en.html, test.de.html]`
-* Any
-{:miref}
-
-The value of this meta information needs to be an array of alcn patterns. All nodes that match at
-least one of the patterns are considered to be dependencies of the node. Therefore if any of these
-nodes change, the node will be regenerated, too.

data/doc/reference_website_styles.page

@@ -1,32 +0,0 @@
----
-title: Website Styles Reference
----
-# Website Styles Reference
-
-Following is a list of all website styles that are included in the webgen distribution. Each style
-can be used when creating a website by using the command
-
-    webgen create -b default -b STYLE_NAME SITE_DIR
-
-or applied later using the command
-
-    webgen apply STYLE_NAME
-
-When you click on the link provided for each website style, you will get a full browser preview of
-the respective website style. You can then return to this list by using the *back button* of your
-browser.
-
-If you want to create such a style yourself, you may want to read
-[this](manual.html#create-website-style)!
-
-<%
-context.content_node.tree.node_access[:alcn].select do |name, node|
-  node.is_directory? && node.parent == context.content_node.tree[File.join(context.content_node.parent.alcn, '/website_styles/')]
-end.sort.each do |name, node|
-%>
-<h2 id="<%= node.cn.chomp('/') %>"><%= node.cn %></h2>
-<div class="website-styles">
-<%= context.dest_node.link_to(node, :link_text => "Full window version") %>
-<object type="text/html" data="<%= context.dest_node.route_to(node) %>">Nothing</object>
-</div>
-<% end %>

data/doc/source/filesystem.page

@@ -1,41 +0,0 @@
----
-title: Webgen::Source::FileSystem
----
-## Description
-
-This is the default source extension used when creating a new webgen website. It uses files that
-match a certain path pattern (default value for the path pattern is to match all files) under a
-specific directory.
-
-> The default configuration for a new website uses all files under the `src` directory.
-{:.information}
-
-The first parameter for the file system source is the directory under which the to-be-used files are
-and the second, optional, parameter specifies a path pattern (see [Path
-Patterns](../manual.html#source-pathpattern) and [Dir.glob]).
-
-[Dir.glob]: http://ruby-doc.org/core/classes/Dir.html#M002375
-
-## Examples
-
-The used sources can be specified via the [`sources` configuration
-option](../reference_configuration.html#sources), so each of the examples below can be specified in
-the `config.yaml` file.
-
-1.  The default configuration: all files under the `src` folder of the website directory
-
-        sources: [[/, Webgen::Source::FileSystem, src]]
-
-2.  The default configuration and additionally all files under a `misc` directory:
-
-        sources:
-          - [/, Webgen::Source::FileSystem, src]
-          - [/, Webgen::Source::FileSystem, misc]
-
-3.  The default configuration and mounting all image files from an external directory under the
-    `/images/` directory:
-
-        sources:
-          - [/, Webgen::Source::FileSystem, src]
-          - [/images/, Webgen::Source::FileSystem, /media/storage/pictures, **/*.jpg]
-

data/doc/source/tararchive.page

@@ -1,40 +0,0 @@
----
-title: Webgen::Source::TarArchive
----
-## Description
-
-The tar archive source can be used to include the files from a (possibly gzipped) tar archive. The
-used archive can be stored locally on the file system but it is also possible to use archives
-accessible via the http(s) and ftp protcols.
-
-> This extension is only available if you have installed the [archive-tar-minitar][1] library. The
-> preferred way to do this is via Rubygems:
->
->     gem install archive-tar-minitar
-{:.warning}
-
-The first parameter for the tar archive source is the URL of the archive and the second, optional,
-parameter specifies a path pattern (see [File.fnmatch]) for selecting the to-be-used
-files/directories in the tar archive.
-
-[File.fnmatch]: http://ruby-doc.org/core/classes/File.html#M002603
-[1]: http://raa.ruby-lang.org/project/minitar/
-
-## Examples
-
-The used sources can be specified via the [`sources` configuration
-option](../reference_configuration.html#sources), so each of the examples below can be specified in
-the `config.yaml` file.
-
-1.  Using all files/directories from a local tar archive in addition the default configuration:
-
-        sources:
-          - [/, Webgen::Source::FileSystem, src]
-          - [/, Webgen::Source::TarArchive, archive.tar]
-
-2.  Using images stored in a remote gzipped tar archive in addition to the default configuration:
-
-        sources:
-          - [/, Webgen::Source::FileSystem, src]
-          - [/, Webgen::Source::TarArchive, http://www.example.com/archive/data.tgz, **/*.jpg]
-

data/doc/sourcehandler.template

@@ -1,23 +0,0 @@
----
-template: extensions.template
---- name:summary pipeline:erb,tags,kramdown,blocks
-<%
-patterns = context.website.config['sourcehandler.patterns'][context.content_node['title']]
-if patterns
-%>
-This source handler operates on paths that match one of the following path patterns (see the [path pattern documentation](manual.html#source-pathpattern) for more information): `<%= patterns.join(', ') %>`
-<% end %>
-
-<%
-meta_info = context.website.config['sourcehandler.default_meta_info'][context.content_node['title']]
-if meta_info
-%>
-Following is the default meta information set on any node created by this source handler:
-
-<pre>
-<%= meta_info.to_yaml.gsub(/^---/, '').strip %>
-</pre>
-<% end %>
-
---- name:content
-<webgen:block name='content' />

data/doc/sourcehandler/copy.page

@@ -1,19 +0,0 @@
----
-title: Webgen::SourceHandler::Copy
----
-## Description
-
-This source handler copies files from the source to the output directory, optionally running a
-content processor over the content. It is useful, for example, for CSS stylesheets, javascript files
-and images.
-
-It decides using the file extension if a content processor should be used and which one. If the
-short name of a content processor is the first part of the file extension, the file is processed by
-this content processor and the first part is removed from the file extension. Otherwise no
-processing is done at all. For example, a file named `hello.jpg` just gets copied verbatimly but a
-file named `usage.erb.html` gets preprocessed by the `erb` content processor and written to a file
-named `usage.html`. As you can see in this example, the processor name gets stripped from the file
-extension.
-
-If you want to use a specific content processor for processing a file, have a look at its
-documentation page which shows the unique short name that needs to be used in the file extension.

data/doc/sourcehandler/directory.page

@@ -1,27 +0,0 @@
----
-title: Webgen::SourceHandler::Directory
----
-## Description
-
-The directory handler is used for handling directories, ie. it creates the target directories.
-Additionally an index path for each directory can be specified which is used instead of the plain
-directory index for displaying purposes. This means that when the directory path is specified
-(e.g. by Webgen::Tag::Relocatable) the index path is returned.
-
-The name of the index path is specified with the meta information `index_path` which is set to
-`index.html` by default. This meta information needs to be set directly on the directory node (for
-example, via a meta information backing file).
-
-The title for a directory can be set via the `title` meta information on the directory itself.
-However, if the directory has an index path, the meta information `routed_title` of the index path
-is used for the directory title. This enables webgen to provide correctly localized directory names.
-
-Normally, webgen shows a warning if it could not find the directory index path for a directory.
-However, there are most certainly directories which should not have an index path, for example, a
-directory containing only images. To prevent webgen from displaying warnings for such directories,
-you can set a null index path using a meta information backing file:
-
-    dirWithOnlyImages:
-      index_path: ~
-
-This will prevent webgen from showing warnings because you explicitly define a null index path.