]> oss.titaniummirror.com Git - webber.git/commitdiff
Remove lots of documentation typos.
authorHolger Schurig <holgerschurig@gmail.com>
Thu, 13 Jan 2011 09:21:33 +0000 (10:21 +0100)
committerHolger Schurig <holgerschurig@gmail.com>
Thu, 13 Jan 2011 09:21:33 +0000 (10:21 +0100)
16 files changed:
in/commandline.md
in/configuration.md
in/functions.md
in/hooks.md
in/index.md
in/inheritance.md
in/pageformat.md
in/plugins/google_sitemap.md
in/plugins/hierarchy.md
in/plugins/index.md
in/plugins/link.md
in/plugins/read_copyonly.md
in/plugins/read_html.md
in/plugins/read_markdown.md
in/plugins/template_mako.md
in/plugins/toc.md

index 2774b9951003315063ec1f90d97906d0c2a0ae9d..6a3563414feacb34f5f25df70d5c1b84d4a9b9a2 100644 (file)
@@ -9,7 +9,7 @@ Note that command line options can also be specified via [[configuration]].
 
 = Invoke help =
 
 
 = 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]
 
        $ webber/webber --help
        usage: webber [options]
index 1c6969dbe87ad3047c812894bc51e114c48ee4e0..25f64545a82935a92e8ee716538696e1a57a1c7d 100644 (file)
@@ -7,7 +7,7 @@ change: enhanced, fixed and clarified
 
 Configuration happens either via [[commandline]] or with the
 configuration file (described below). All configurations are subject
 
 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.
 
 
 per-directory and/or per-file basis.
 
 
index ea291ebd629e5c1d464780eeae8d2192b524967c..a87bce87bc8638f59ec47b6360b294bdf0e3fa13 100644 (file)
@@ -23,7 +23,7 @@ Takes a timestamp (seconds since 1st January 1970) and converts it into
 a string.
 
 "`format`" is optional. If not used, "`cfg.date_format`" will be used.
 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`.
 example, "`%Y-%m-%d`" stands for year-month-date.
 
 Defined in `webber.py`.
@@ -34,7 +34,7 @@ Defined in `webber.py`.
 Returns the current date/time as a string.
 
 "`format`" is optional. If not used, "`cfg.date_format`" will be used.
 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`.
 example, "`%Y-%m-%d`" stands for year-month-date.
 
 Defined in `webber.py`.
index d1cfdb83b42e30b7c7177afe1b11fb69e8503598..4e0122484a0a2924be4f5d473e7d1bc3584b7266 100644 (file)
@@ -11,7 +11,7 @@ will exist. So a flexible way to share data between "`webber.py`" and
 the plugins was needed.
 
 Borrowed from IkiWiki came the idea of "Hooks". At various points
 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.
 
 to any hook and has a chance to get the current page or configuration
 attributes.
 
@@ -88,10 +88,10 @@ anything from "`cfg.exclude_dirs`" and "`cfg.exclude_files"`. For each of the
 remaining files this hook is called.
 
 Usually the the "`read_*`" plugins implement this hook. And usually they look
 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
 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.
 
 The first hook that returns contents wins, no further hook-functions
 will be called.
@@ -220,7 +220,7 @@ will be called.
 
 = At the end =
 
 
 = 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 ==
 one hook away from finishing program execution:
 
 == finish ==
index 20fcb3ab8e5983143b72a7821375ba6cd91f9925..026ad61a809081e7a73a2420f451bfd9d36fdeca 100644 (file)
@@ -14,7 +14,7 @@ It works by ...
  * considering any number of [[plugins|Plugins]]
  * execution of [[macros|macros]]
  * execution of [[hooks|hooks]]
  * 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/]]
 
 Finally webber creates static HTML files that you can upload to your
 web-site. I recommend [[sitecopy|http://www.manyfish.co.uk/sitecopy/]]
index 89c7502f6e02a6455481f4ffaee6c4de6d204b2e..c889a599f9e03c82cc162000c043dd213a4a28f2 100644 (file)
@@ -32,7 +32,7 @@ This is like the inheritance works:
 Due to parsing the [[commandline]] the attribute "`style_dir`" have
 some value. If you don't specify one, it will be "default" by default.
 
 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.
 
 set "`style`" to "twoframe", if you want a two-frame template for your
 web-site.
 
index 01568fba593e1b77b39a619a58d952777bd08c0b..ad07d35d27ccc2a17b9b759a519048b9aa8b78f7 100644 (file)
@@ -119,7 +119,7 @@ For an example, look at <a href="#ctime">ctime</a> above.
 == template ==
 
 Allows you to override the default template. Just specify the pure file
 == 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
 
        title: Blog
        template: history
@@ -169,7 +169,7 @@ Here's a [[template_mako]] excerpt that uses this:
 
 Used by [[google_sitemap]]:
 
 
 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.
 
 about URL of the final website. However, the [[google_sitemap]] plugin
 needs absolute URLs, complete with host name.
 
index 2eb92021574b893e8fb79440898bc2788ee26b9f..f30662cedfdd029cf88562e1a207ce69c1a10c36 100644 (file)
@@ -6,7 +6,7 @@ lang: en
 ctime: 2009-06-26
 mtime: 2009-06-26
 
 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]].
 
 
 format is documented at [[http://www.sitemaps.org]].
 
 
@@ -49,7 +49,7 @@ e.g.:
        Disallow: /logs/
        Sitemap: http://www.holgerschurig.de/sitemap.xml
 
        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: [
                ...
 
        copy_files: [
                ...
index 8f331469849c47ab89833249d386af0c6c257999..f2b42ec3dfd1844e36a89ed1609bfab48ce21d57 100644 (file)
@@ -99,7 +99,7 @@ template uses the function "`get_sidemenu()`" which returns (level,
 part_of_path, is_current, title, link) tuples. Again all links are relative
 to the calling page.
 
 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.
   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.
index 5f992c34f18f8cce7d81e9dba3ce4c62caad7a6a..5b94af0777e72c410b449857040eee3e7e8fd63c 100644 (file)
@@ -20,7 +20,7 @@ There's another plugin there ([[skeleton.py|skeleton]]), which is
 is just a demo for plugin-programmers.
 
 Plugins simply reside in the "`plugins/`" directory from webber itself. If your
 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
 "`plugin_dirs`" in [[webber.conf|configuration]].
 
 Note that webber doesn't load all of them automatically. Instead you specify
index 4e183fecb30e9c4f900b67f05996a2e961868cc1..9d7f6e3cf679ca705c62ca0ca8ca2f3c166451a7 100644 (file)
@@ -23,7 +23,7 @@ Instead of an URL you can also specify the following things:
 * the short link title
 * the basename of the file (filename without extension and directory name)
 
 * 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:
 first match.
 
 Example:
index 75307fa46b87a58f162f3b325f8f3e1c56587865..d4e7114cfd4b9d06b07255041cafd14e5a25aef1 100644 (file)
@@ -9,7 +9,7 @@ This plugin copies files (e.g. graphics files) into the destination
 folder.
 
 To configure which files should be copied you modify
 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",
 
        copy_files: [
                "*.png",
index d2e634563500d09ce4f1d10d119e0d5a061fe5a8..936c93b72d8b4f571e0625c037315bd455ef0a97 100644 (file)
@@ -8,8 +8,8 @@ mtime: 2009-06-26
 This plugin reads HTML snippets from "`*.html`" files.
 
 Please note that currently the plugin assumes that this is a HTML snippet.
 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:
 
 
 A sample "`test.html`" document looks like this:
 
index cc4206bfa8488a7bcf680f97045b2ad3d77b11c8..ecc13315a39cd04a8cf2cd4c08ced85f6be36d33 100644 (file)
@@ -10,7 +10,7 @@ This plugin reads "`*.md`" files and converts them to HTML.
 "[[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
 "[[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:
 
 
 A sample "`test.md`" document looks like this:
 
index b7ae137b5786bd07cf71450abf1b14e392ecd017..7e0957d03f09377e9e4558bd402bb3ed0e07a927 100644 (file)
@@ -15,7 +15,7 @@ during the "`pagetemplate`" [[hook|hooks]].
 == template ==
 
 Name of the template file. Must be specified in "`webber.conf`", but
 == 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"
 
 
        template: "default"
 
@@ -76,7 +76,7 @@ and replace "`${body}`" with:
        ${self.contents()}
 
 Now you can create a new template file, e.g. "`history.tmpl`" that
        ${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"/>
 files:
 
        <%inherit file="default.tmpl"/>
index 803399b7eda8c5655fcbb3c1d2515be5bd70e8ec..34f37cb5661700a513327a1c0646bea3d746a25b 100644 (file)
@@ -50,7 +50,7 @@ local anchors.
 This again is done via a suitable [[template_mako]]. The template uses
 the function "`get_toc()`" and returns (level, headline, slug) tuples.
 
 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
   this for CSS "`id=`" or "`class`" attributes
 * "`headline`" is the headline (the text inside <hX>..</hX>)
 * "`slug`" is the