From b9132d87ddf62fb3b589115c2cd3e5d11132b28f Mon Sep 17 00:00:00 2001 From: Holger Schurig Date: Thu, 13 Jan 2011 10:21:33 +0100 Subject: [PATCH] Remove lots of documentation typos. --- in/commandline.md | 2 +- in/configuration.md | 2 +- in/functions.md | 4 ++-- in/hooks.md | 8 ++++---- in/index.md | 2 +- in/inheritance.md | 2 +- in/pageformat.md | 4 ++-- in/plugins/google_sitemap.md | 4 ++-- in/plugins/hierarchy.md | 2 +- in/plugins/index.md | 2 +- in/plugins/link.md | 2 +- in/plugins/read_copyonly.md | 2 +- in/plugins/read_html.md | 4 ++-- in/plugins/read_markdown.md | 2 +- in/plugins/template_mako.md | 4 ++-- in/plugins/toc.md | 2 +- 16 files changed, 24 insertions(+), 24 deletions(-) diff --git a/in/commandline.md b/in/commandline.md index 2774b99..6a35634 100644 --- a/in/commandline.md +++ b/in/commandline.md @@ -9,7 +9,7 @@ Note that command line options can also be specified via [[configuration]]. = 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] diff --git a/in/configuration.md b/in/configuration.md index 1c6969d..25f6454 100644 --- a/in/configuration.md +++ b/in/configuration.md @@ -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 -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. diff --git a/in/functions.md b/in/functions.md index ea291eb..a87bce8 100644 --- a/in/functions.md +++ b/in/functions.md @@ -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. -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`. @@ -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. -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`. diff --git a/in/hooks.md b/in/hooks.md index d1cfdb8..4e01224 100644 --- a/in/hooks.md +++ b/in/hooks.md @@ -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 -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. @@ -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 -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. @@ -220,7 +220,7 @@ 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 == diff --git a/in/index.md b/in/index.md index 20fcb3a..026ad61 100644 --- a/in/index.md +++ b/in/index.md @@ -14,7 +14,7 @@ It works by ... * 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/]] diff --git a/in/inheritance.md b/in/inheritance.md index 89c7502..c889a59 100644 --- a/in/inheritance.md +++ b/in/inheritance.md @@ -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. -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. diff --git a/in/pageformat.md b/in/pageformat.md index 01568fb..ad07d35 100644 --- a/in/pageformat.md +++ b/in/pageformat.md @@ -119,7 +119,7 @@ For an example, look at ctime above. == 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 @@ -169,7 +169,7 @@ Here's a [[template_mako]] excerpt that uses this: 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. diff --git a/in/plugins/google_sitemap.md b/in/plugins/google_sitemap.md index 2eb9202..f30662c 100644 --- a/in/plugins/google_sitemap.md +++ b/in/plugins/google_sitemap.md @@ -6,7 +6,7 @@ lang: en 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]]. @@ -49,7 +49,7 @@ e.g.: 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: [ ... diff --git a/in/plugins/hierarchy.md b/in/plugins/hierarchy.md index 8f33146..f2b42ec 100644 --- a/in/plugins/hierarchy.md +++ b/in/plugins/hierarchy.md @@ -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. -* "`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. diff --git a/in/plugins/index.md b/in/plugins/index.md index 5f992c3..5b94af0 100644 --- a/in/plugins/index.md +++ b/in/plugins/index.md @@ -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 -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 diff --git a/in/plugins/link.md b/in/plugins/link.md index 4e183fe..9d7f6e3 100644 --- a/in/plugins/link.md +++ b/in/plugins/link.md @@ -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) -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: diff --git a/in/plugins/read_copyonly.md b/in/plugins/read_copyonly.md index 75307fa..d4e7114 100644 --- a/in/plugins/read_copyonly.md +++ b/in/plugins/read_copyonly.md @@ -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 -[[webber.conf|configuration]]. An example snippet migth be: +[[webber.conf|configuration]]. An example snippet might be: copy_files: [ "*.png", diff --git a/in/plugins/read_html.md b/in/plugins/read_html.md index d2e6345..936c93b 100644 --- a/in/plugins/read_html.md +++ b/in/plugins/read_html.md @@ -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. -That means: the snippes should only contain what is inside "``" and -"``", but without those tags themselfes. +That means: the snippets should only contain what is inside "``" and +"``", but without those tags themselves. A sample "`test.html`" document looks like this: diff --git a/in/plugins/read_markdown.md b/in/plugins/read_markdown.md index cc4206b..ecc1331 100644 --- a/in/plugins/read_markdown.md +++ b/in/plugins/read_markdown.md @@ -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 -[[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: diff --git a/in/plugins/template_mako.md b/in/plugins/template_mako.md index b7ae137..7e0957d 100644 --- a/in/plugins/template_mako.md +++ b/in/plugins/template_mako.md @@ -15,7 +15,7 @@ during the "`pagetemplate`" [[hook|hooks]]. == 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" @@ -76,7 +76,7 @@ and replace "`${body}`" with: ${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"/> diff --git a/in/plugins/toc.md b/in/plugins/toc.md index 803399b..34f37cb 100644 --- a/in/plugins/toc.md +++ b/in/plugins/toc.md @@ -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. -* "`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 ..) * "`slug`" is the -- 2.39.2