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

Add documentation for DIRECT_TEMPLATES and PAGINATED_DIRECT_TEMPLATES

Browse source
This commit is contained in:
Stuart Colville 2012-05-09 23:24:31 +01:00
commit df7b2c968e
1 changed files with 71 additions and 68 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/settings.rst
View file

@ -21,9 +21,9 @@ Here is a list of settings for Pelican:
Basic settings Basic settings
============== ==============
================================================ ===================================================== ===================================================================== =====================================================================
Setting name (default value) What does it do? Setting name (default value) What does it do?
================================================ ===================================================== ===================================================================== =====================================================================
`AUTHOR` Default author (put your name) `AUTHOR` Default author (put your name)
`DATE_FORMATS` (``{}``) If you do manage multiple languages, you can `DATE_FORMATS` (``{}``) If you do manage multiple languages, you can
set the date formatting here. See "Date format and locales" set the date formatting here. See "Date format and locales"
@ -82,7 +82,12 @@ Setting name (default value) What does it do?
generated HTML, using the `Typogrify generated HTML, using the `Typogrify
<http://static.mintchaos.com/projects/typogrify/>`_ <http://static.mintchaos.com/projects/typogrify/>`_
library library
================================================ ===================================================== `DIRECT_TEMPLATES` (``('index', 'tags', 'categories', 'archives')``) List of templates that are used directly to render
content. Typically direct templates are used to generate
index pages for collections of content e.g. tags and
category index pages.
`PAGINATED_DIRECT_TEMPLATES` (``('index',)``) Provides the direct templates that should be paginated.
===================================================================== =====================================================================
.. [#] Default is the system locale. .. [#] Default is the system locale.
@ -141,17 +146,15 @@ Setting name (default value) what does it do?
`CATEGORY_SAVE_AS` ('category/{name}.html') The location to save 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_URL` ('tag/{name}.html') The URL to use for a tag.
`TAG_SAVE_AS` ('tag/{name}.html') The location to save the tag page. `TAG_SAVE_AS` ('tag/{name}.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.
================================================ ===================================================== ================================================ =====================================================
.. note:: .. note::
When any of `*_SAVE_AS` is set to False, files will not be created. When any of `*_SAVE_AS` is set to False, files will not be created.
You can change the file output location of any pages listed in DIRECT_TEMPLATES
by providing a setting <TEMPLATE_NAME>_SAVE_AS, where <TEMPLATE_NAME> is the template
name in uppercase; e.g. CATEGORIES. If False it will not be created.
Timezone Timezone
-------- --------