= Invoke help =
-As usualy, you can get command line help with "`-h`" or "`--help`":
+As usual, you can get command line help with "`-h`" or "`--help`":
$ webber/webber --help
usage: webber [options]
Configuration happens either via [[commandline]] or with the
configuration file (described below). All configurations are subject
-to [[inheritance]]. You can also overwritable any of them on a
+to [[inheritance]]. You can also overwrite any of them on a
per-directory and/or per-file basis.
a string.
"`format`" is optional. If not used, "`cfg.date_format`" will be used.
-Otherwise it should be a format-string as documted by "`man strftime`". For
+Otherwise it should be a format-string as documented by "`man strftime`". For
example, "`%Y-%m-%d`" stands for year-month-date.
Defined in `webber.py`.
Returns the current date/time as a string.
"`format`" is optional. If not used, "`cfg.date_format`" will be used.
-Otherwise it should be a format-string as documted by "`man strftime`". For
+Otherwise it should be a format-string as documented by "`man strftime`". For
example, "`%Y-%m-%d`" stands for year-month-date.
Defined in `webber.py`.
the plugins was needed.
Borrowed from IkiWiki came the idea of "Hooks". At various points
-during the exection "`webber.py`" fires some hooks. Any plugin can act
+during the execution "`webber.py`" fires some hooks. Any plugin can act
to any hook and has a chance to get the current page or configuration
attributes.
remaining files this hook is called.
Usually the the "`read_*`" plugins implement this hook. And usually they look
-at the file-extension and decide if they the can procecess this file or not.
+at the file-extension and decide if they the can proprocecess this file or not.
If they do, the plugin should also set "`file.render`" is normally "`html"`.
However, it can be something else. In this case "`file.render`" specifies a
-hook that get's called for this file.
+hook that gets called for this file.
The first hook that returns contents wins, no further hook-functions
will be called.
= At the end =
-Now everythings has been converted to HTML and written out. And we're just
+Now everything has been converted to HTML and written out. And we're just
one hook away from finishing program execution:
== finish ==
* considering any number of [[plugins|Plugins]]
* execution of [[macros|macros]]
* execution of [[hooks|hooks]]
- * rendering throught a [[template|template_mako]], using [[functions|functions]]
+ * rendering through a [[template|template_mako]], using [[functions|functions]]
Finally webber creates static HTML files that you can upload to your
web-site. I recommend [[sitecopy|http://www.manyfish.co.uk/sitecopy/]]
Due to parsing the [[commandline]] the attribute "`style_dir`" have
some value. If you don't specify one, it will be "default" by default.
-Now the [[configuration]] file "`webber.conf`" get's processed. It may
+Now the [[configuration]] file "`webber.conf`" gets processed. It may
set "`style`" to "twoframe", if you want a two-frame template for your
web-site.
== template ==
Allows you to override the default template. Just specify the pure file
-name. For convenience, you can ommit "`.tmpl`".
+name. For convenience, you can omit "`.tmpl`".
title: Blog
template: history
Used by [[google_sitemap]]:
-Internally, [[Webber]] works with relative URLs and is quite agonistic
+Internally, [[Webber]] works with relative URLs and is quite agnostic
about URL of the final website. However, the [[google_sitemap]] plugin
needs absolute URLs, complete with host name.
ctime: 2009-06-26
mtime: 2009-06-26
-This plugins writes an XML file "`sitemap.xml`" into the out-directory. The
+This plugin writes an XML file "`sitemap.xml`" into the out-directory. The
format is documented at [[http://www.sitemaps.org]].
Disallow: /logs/
Sitemap: http://www.holgerschurig.de/sitemap.xml
-Also make sure that your "`robots.txt`" file get's copied, by adding
+Also make sure that your "`robots.txt`" file gets copied, by adding
copy_files: [
...
part_of_path, is_current, title, link) tuples. Again all links are relative
to the calling page.
-* "`level`" is the indendation level, starting with 0. You can use this for
+* "`level`" is the indentation level, starting with 0. You can use this for
CSS "`id=`" or "`class`" attributes
* "`part_of_path`" is a flag telling you if the mentioned page is part
of your path, i.e. if the specified page is in the breadcrumbs.
is just a demo for plugin-programmers.
Plugins simply reside in the "`plugins/`" directory from webber itself. If your
-web project needs local plugins, you can specifiy additional plugins with
+web project needs local plugins, you can specify additional plugins with
"`plugin_dirs`" in [[webber.conf|configuration]].
Note that webber doesn't load all of them automatically. Instead you specify
* the short link title
* the basename of the file (filename without extension and directory name)
-In this case the link plugin will search throught all pages and take the
+In this case the link plugin will search through all pages and take the
first match.
Example:
folder.
To configure which files should be copied you modify
-[[webber.conf|configuration]]. An example snippet migth be:
+[[webber.conf|configuration]]. An example snippet might be:
copy_files: [
"*.png",
This plugin reads HTML snippets from "`*.html`" files.
Please note that currently the plugin assumes that this is a HTML snippet.
-That means: the snippes should only contain what is inside "`<body>`" and
-"`</body>`", but without those tags themselfes.
+That means: the snippets should only contain what is inside "`<body>`" and
+"`</body>`", but without those tags themselves.
A sample "`test.html`" document looks like this:
"[[Markdown|http://daringfireball.net/projects/markdown/]]" is a wiki-like
text format. The plugin "`read_markdown.py`" doesn't use the
standard Python module "`markdown`", but instead the faster and simpler
-[[markdown2|http://code.google.com/p/python-markdown2/]] modoule.
+[[markdown2|http://code.google.com/p/python-markdown2/]] module.
A sample "`test.md`" document looks like this:
== template ==
Name of the template file. Must be specified in "`webber.conf`", but
-can be overriden, see "[[inheritance]]" and "[[pageformat]]".
+can be overridden, see "[[inheritance]]" and "[[pageformat]]".
template: "default"
${self.contents()}
Now you can create a new template file, e.g. "`history.tmpl`" that
-inherits from "`default.tmpl`" and add's a list of recently changed
+inherits from "`default.tmpl`" and adds a list of recently changed
files:
<%inherit file="default.tmpl"/>
This again is done via a suitable [[template_mako]]. The template uses
the function "`get_toc()`" and returns (level, headline, slug) tuples.
-* "`level`" is the indendation level, starting with 0. You can use
+* "`level`" is the indentation level, starting with 0. You can use
this for CSS "`id=`" or "`class`" attributes
* "`headline`" is the headline (the text inside <hX>..</hX>)
* "`slug`" is the
projects / webber.git / commitdiff