Skip to content
This repository has been archived by the owner on Jan 25, 2019. It is now read-only.

Commit

Permalink
Merge remote-tracking branch 'cvan/fix-a-few-typos-in-docs'
Browse files Browse the repository at this point in the history
  • Loading branch information
mythmon committed Aug 15, 2015
2 parents 0ad3706 + 4582fe7 commit 93322f0
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion README.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Pulled from a directory named `content` by default. Content is written
in lightweight markup or in plain text, with an optional YAML header
section. The directory structure of the file mean nothing to wok. It
builds the structure of the site based on the titles and the category
meta data.
metadata.

Since wok uses lightweight mark up languages like [Markdown][mkd] and
[reStructuredText][rst], it is easy to do nice formatting in the pages
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/content/categories.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ any pages with no category.

This site tree is built from the `page.slug` and `page.category` fields.
The page that has a slug of `blog` is the top of the blog category, and
it's children are any pages that define `category: blog`
its children are any pages that define `category: blog`

[tree]: http://en.wikipedia.org/wiki/Tree_(data_structure)

Expand Down
18 changes: 9 additions & 9 deletions docs/content/docs/hooks.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ category: docs
Since version 0.9, wok provides a hook interface to add custom python code to
the site generation pipeline.

Before starting to programm, check the [wok_hooks project][wok_hooks] for already available plugins.
Before starting to programm, check the [wok_hooks project][wok_hooks] for already available plugins.

To use hooks, make a new directory in your site root named `hooks`. In this
To use hooks, make a new directory in your site root named `hooks`. In this
directory, make the file `__hooks__.py`. For example:

::text
Expand All @@ -23,9 +23,9 @@ directory, make the file `__hooks__.py`. For example:
`-- templates/


From the `__hooks__.py` file, wok will import the variable `hooks`.
This should be a dictionary; The keys are the hook names below, and the values
are lists of functions (or other callables) to run for the hooks. Simply give
From the `__hooks__.py` file, wok will import the variable `hooks`.
This should be a dictionary; The keys are the hook names below, and the values
are lists of functions (or other callables) to run for the hooks. Simply give
the names of the functions, but do not invoke them. For example:

::python
Expand Down Expand Up @@ -146,7 +146,7 @@ will pass to the hooked functions (if any.)
: Dictionary containing site configuration
: `page`
: The current page object that is being processed.
: This hook will be called for each page before the page has it's meta data
: This hook will be called for each page before the page has its metadata
filled in. Some metadata will exist, but it will be in an unnormalized
state.

Expand All @@ -155,8 +155,8 @@ will pass to the hooked functions (if any.)
: Dictionary containing site configuration
: `page`
: The current page object that is being processed.
: This hook will be called for each page right after the page has it's meta
data filled in and normalized.
: This hook will be called for each page right after the page has its
metadata filled in and normalized.

`page.template.pre(config, page, templ_vars)` <a name="page.template.pre"> </a>
: `config`
Expand Down Expand Up @@ -193,4 +193,4 @@ will pass to the hooked functions (if any.)
site for distribution. If the `--server` option has been specified, this
will happen before the server is run.

[wok_hooks]: https://github.com/abbgrade/wok_hooks
[wok_hooks]: https://github.com/abbgrade/wok_hooks
2 changes: 1 addition & 1 deletion docs/content/docs/pagination.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ This will show pagination controls, and then a list of links to subpages.

URLs
----
To get this to work, each page is it's own file, which means each file has to
To get this to work, each page is its own file, which means each file has to
have a new name. To provide for this, there is a variable available to url
generation, `page`, which contains the the current page number, except on the
first page. On page 1, the `page` variable is an empty string. This way you
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/templates.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ file, unless otherwise stated.
not specified.
- `page.author` - The first author of the page, as an `Author` object. If
unspecified in the YAML header, the site default will be used, if that is
unspecified, the object will still exist, but will have `None` for it's
unspecified, the object will still exist, but will have `None` for its
attributes. If multiple authors are specified, this will be the first one.
- `page.authors` - Like `page.author`, except as a list of all specifed
authors.
Expand Down
4 changes: 2 additions & 2 deletions docs/content/docs/urls.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ arrange to your liking:
these, they will default to `None`.

If you don't include `{page}` in your `url_pattern`, then pagination won't
work. Instead it will overwrite each page with it's sequel, resulting in only
work. Instead it will overwrite each page with its sequel, resulting in only
the last page remaining. If you aren't using any pagination, then you don't
need the variable.

Expand All @@ -41,7 +41,7 @@ any time the url ends with `index.*`, that will also be removed from the url
patterns. The files will still be named `index.*`, however. So for example if
your url pattern is `/{category}/{slug}/index.html`, the a blog post about
balloons would create a file named `/blog/balloons/index.html`, but anytime you
reference it in a template it's `url` field will be `/blog/balloons/`. This
reference it in a template its `url` field will be `/blog/balloons/`. This
makes URLs look a lot cleaner. This option off set to `true` by default (ie:
keep index in urls).

Expand Down
2 changes: 1 addition & 1 deletion docs/content/tutorial.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ also support reStructuredText, Textile, plain text, and raw text.

## Home

The home page will be the main landing page for our website. As such it's URL
The home page will be the main landing page for our website. As such its URL
should be `/index.html`. Sounds pretty simple, and it is. Make a file named
`home.mkd` in your content directory, and give it these contents.

Expand Down
6 changes: 3 additions & 3 deletions wok/page.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@

class Page(object):
"""
A single page on the website in all it's form (raw, rendered, templated) ,
as well as it's associated metadata.
A single page on the website in all its form (raw, rendered, templated),
as well as its associated metadata.
"""

tmpl_env = None
Expand Down Expand Up @@ -93,7 +93,7 @@ def from_file(cls, path, options, engine, renderer=renderers.Plain):
'than expected. Squashing the extra together.'
.format(page.path))

# Handle the case where no meta data was provided
# Handle the case where no metadata was provided.
if len(splits) == 1:
page.original = splits[0]
page.meta = {}
Expand Down

0 comments on commit 93322f0

Please sign in to comment.