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

some doc about pagination

Browse source
This commit is contained in:
Laureline Guerin 2011-02-18 11:21:33 +01:00
commit 3f9319d55f
2 changed files with 64 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/settings.rst
View file

@ -76,6 +76,12 @@ Setting name what it does ?
`TRANSLATION_FEED` Where to put the RSS feed for translations. Default
is feeds/all-%s.atom.xml where %s is the name of the
lang.
`WITH_PAGINATION` Activate pagination. Default is True.
`DEFAULT_PAGINATION` The maximum number of articles to include on a page,
not including orphans. Default is 5.
`DEFAULT_ORPHANS` The minimum number of articles allowed on the last
page, defaults to zero. Use this when you don't want
to have a last page with very few articles.
======================== =======================================================
Themes

70
docs/themes.rst
View file

@ -66,18 +66,50 @@ categories A dict containing each category (keys), and the
pages The list of pages
============= ===================================================
index.html
----------
Home page of your blog, will finally remain at output/index.html.
If pagination is active, next pages will remain at output/index`n`.html.
=================== ===================================================
Variable Description
=================== ===================================================
articles_paginator A paginator object of article list
articles_page The current page of articles
dates_paginator A paginator object of article list, ordered by date,
ascending
dates_page The current page of articles, ordered by date,
ascending
page_name 'index'. Usefull for pagination links.
=================== ===================================================
category.html
-------------
This template will be processed for each of the existing categories, and will
finally remain at output/category/`category_name`.html.
============= ===================================================
Variable Description
============= ===================================================
articles The articles of this category
category The name of the category being processed
============= ===================================================
If pagination is active, next pages will remain at
output/category/`category_name``n`.html.
=================== ===================================================
Variable Description
=================== ===================================================
category The name of the category being processed
articles Articles of this category
dates Articles of this category, but ordered by date,
ascending
articles_paginator A paginator object of article list
articles_page The current page of articles
dates_paginator A paginator object of article list, ordered by date,
ascending
dates_page The current page of articles, ordered by date,
ascending
page_name 'category/`category_name`'. Usefull for pagination
links.
=================== ===================================================
article.html
-------------
@ -96,11 +128,23 @@ tag.html
--------
For each tag, this template will be processed. It will create .html files in
/output/tag/`tag_name`.html
/output/tag/`tag_name`.html.
============= ===================================================
Variable Description
============= ===================================================
tag The name of the tag being processed
articles Articles related to this tag
============= ===================================================
If pagination is active, next pages will remain at
output/tag/`tag_name``n`.html.
=================== ===================================================
Variable Description
=================== ===================================================
tag The name of the tag being processed
articles Articles related to this tag
dates Articles related to this tag, but ordered by date,
ascending
articles_paginator A paginator object of article list
articles_page The current page of articles
dates_paginator A paginator object of article list, ordered by date,
ascending
dates_page The current page of articles, ordered by date,
ascending
page_name 'tag/`tag_name`'. Usefull for pagination links.
=================== ===================================================