From 2f38fab3e02eb5c2c088db98449c16ffaa4b74ae Mon Sep 17 00:00:00 2001 From: Alexis Metaireau Date: Wed, 15 Dec 2010 18:08:25 +0000 Subject: [PATCH] Add some explanations about the theme templates. --- docs/themes.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/themes.rst b/docs/themes.rst index 7b7c0de5..340c3d44 100644 --- a/docs/themes.rst +++ b/docs/themes.rst @@ -43,6 +43,8 @@ are in caps. You can access them directly. Common variables ---------------- +All of those settings will be given to all templates. + ============= =================================================== Variable Description ============= =================================================== @@ -62,6 +64,9 @@ pages The list of pages 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 ============= =================================================== @@ -72,6 +77,9 @@ category The name of the category being processed article.html ------------- +This template will be processed for each article. .html files will be outputed +in output/`article_name`.html. Here are the specific variables it gets. + ============= =================================================== Variable Description ============= =================================================== @@ -82,6 +90,9 @@ category The name of the category of the current article tag.html -------- +For each tag, this template will be processed. It will create .html files in +/output/tag/`tag_name`.html + ============= =================================================== Variable Description ============= ===================================================