github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fixed page_name call to adapt to the link structure provided by the

Browse source 
Settings file. Also updated the documentation accordingly.

Update documentation to cover new page_name behavior

Fixed page_name to adapt to the links provided by the Settings file. Includes documentation updates as well.

Updated terms to maintain better syntax and consistancy

Added docstring to _from_settings() to clarify the get_page_name argument that was added. Explains why/when this argument is used.

Revert contents.py back to commit 2f29c51

Re-added docstring to _get_settings method, but this time not deleting things I shouldn't

Corrected readability change that was altered during revert.
This commit is contained in:
Trae Blain 2012-06-23 16:39:02 -05:00
commit 41fdfa63b1
4 changed files with 31 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/settings.rst
View file

@ -152,12 +152,12 @@ Setting name (default value) what does it do?
use the default language.
`PAGE_LANG_SAVE_AS` ('pages/{slug}-{lang}.html') The location we will save the page which doesn't
use the default language.
`AUTHOR_URL` ('author/{name}.html') The URL to use for an author.
`AUTHOR_SAVE_AS` ('author/{name}.html') The location to save an author.
`CATEGORY_URL` ('category/{name}.html') The URL to use for a category.
`CATEGORY_SAVE_AS` ('category/{name}.html') The location to save a category.
`TAG_URL` ('tag/{name}.html') The URL to use for a tag.
`TAG_SAVE_AS` ('tag/{name}.html') The location to save the tag page.
`AUTHOR_URL` ('author/{slug}.html') The URL to use for an author.
`AUTHOR_SAVE_AS` ('author/{slug}.html') The location to save an author.
`CATEGORY_URL` ('category/{slug}.html') The URL to use for a category.
`CATEGORY_SAVE_AS` ('category/{slug}.html') The location to save a category.
`TAG_URL` ('tag/{slug}.html') The URL to use for a tag.
`TAG_SAVE_AS` ('tag/{slug}.html') The location to save the tag page.
`<DIRECT_TEMPLATE_NAME>_SAVE_AS` The location to save content generated from direct
templates. Where <DIRECT_TEMPLATE_NAME> is the
upper case template name.

23
docs/themes.rst
View file

@ -93,8 +93,8 @@ author.html
This template will be processed for each of the existing authors, with
output generated at output/author/`author_name`.html.
If pagination is active, subsequent pages will reside at
output/author/`author_name``n`.html.
If pagination is active, subsequent pages will reside as defined by setting
AUTHOR_SAVE_AS (`Default:` output/author/`author_name'n'`.html).
=================== ===================================================
Variable Description
@ -109,8 +109,8 @@ dates_paginator A paginator object for the article list, ordered by
date, ascending.
dates_page The current page of articles, ordered by date,
ascending.
page_name 'author/`author_name`' -- useful for pagination
links
page_name AUTHOR_URL where everything after `{slug}` is
removed -- useful for pagination links
=================== ===================================================
category.html
@ -119,8 +119,8 @@ category.html
This template will be processed for each of the existing categories, with
output generated at output/category/`category_name`.html.
If pagination is active, subsequent pages will reside at
output/category/`category_name``n`.html.
If pagination is active, subsequent pages will reside as defined by setting
CATEGORY_SAVE_AS (`Default:` output/category/`category_name'n'`.html).
=================== ===================================================
Variable Description
@ -135,8 +135,8 @@ dates_paginator A paginator object for the list of articles,
ordered by date, ascending
dates_page The current page of articles, ordered by date,
ascending
page_name 'category/`category_name`' -- useful for pagination
links
page_name CATEGORY_URL where everything after `{slug}` is
removed -- useful for pagination links
=================== ===================================================
article.html
@ -171,8 +171,8 @@ tag.html
This template will be processed for each tag, with corresponding .html files
saved as output/tag/`tag_name`.html.
If pagination is active, subsequent pages will reside at
output/tag/`tag_name``n`.html.
If pagination is active, subsequent pages will reside as defined in setting
TAG_SAVE_AS (`Default:` output/tag/`tag_name'n'`.html).
=================== ===================================================
Variable Description
@ -187,7 +187,8 @@ dates_paginator A paginator object for the list of articles,
ordered by date, ascending
dates_page The current page of articles, ordered by date,
ascending
page_name 'tag/`tag_name`' -- useful for pagination links
page_name TAG_URL where everything after `{slug}` is removed
-- useful for pagination links
=================== ===================================================
Inheritance