From bee3140fc69cc56cf0e49e4a3c5123e68968ad2e Mon Sep 17 00:00:00 2001 From: Alexis Metaireau Date: Thu, 18 Aug 2011 13:35:53 +0200 Subject: [PATCH] doc: reorder settings --- docs/settings.rst | 58 +++++++++++++++++++++++------------------------ 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/settings.rst b/docs/settings.rst index d08e24da..42ccf2be 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -24,8 +24,35 @@ Basic settings ================================================ ===================================================== Setting name (default value) what does it do? ================================================ ===================================================== +`ARTICLE_PERMALINK_STRUCTURE` (``''``) Empty by default. Allows to render URLs for + articles sorted by date, in case you specify a + format as specified in the example. + It follows the python datetime directives: + * %Y: Year with century as a decimal number. + * %m: Month as a decimal number [01,12]. + * %d: Day of the month as a decimal number [01,31]. + + Note: if you specify a datetime directive, it will + be substituted using the date metadata field into + the rest file. if the date is not specified, pelican + will rely on the mtime of your file. + + Check the python datetime documentation + at http://bit.ly/cNcJUC for more information. + + Also, you can use any metadata in the + restructured text files: + * category: '%(category)s' + * author: '%(author)s' + * tags: '%(tags)s' + * date: '%(date)s' + + Example usage: + * '/%Y/%m/' it will be something like + '/2011/07/sample-post.html'. + * '/%Y/%(category)s/' it will be something like + '/2011/life/sample-post.html'. `AUTHOR` Default author (put your name) -`SITENAME` (``'A Pelican Blog'``) Your site name `DATE_FORMATS` (``{}``) If you do manage multiple languages, you can set the date formatting here. `DEFAULT_CATEGORY` (``'misc'``) The default category to fallback on. @@ -57,6 +84,7 @@ Setting name (default value) what does it do? `rst2pdf`. `RELATIVE_URLS` (``True``) Defines if pelican should use relative urls or not. +`SITENAME` (``'A Pelican Blog'``) Your site name `SITEURL` base URL of your website. Note that this is not a way to tell pelican to use relative urls or static ones. You should rather use the @@ -65,34 +93,6 @@ Setting name (default value) what does it do? on the output path "static". By default, pelican will copy the 'images' folder to the output folder. -`ARTICLE_PERMALINK_STRUCTURE` (``''``) Empty by default. Allows to render URLs for - articles sorted by date, in case you specify a - format as specified in the example. - It follows the python datetime directives: - * %Y: Year with century as a decimal number. - * %m: Month as a decimal number [01,12]. - * %d: Day of the month as a decimal number [01,31]. - - Note: if you specify a datetime directive, it will - be substituted using the date metadata field into - the rest file. if the date is not specified, pelican - will rely on the mtime of your file. - - Check the python datetime documentation - at http://bit.ly/cNcJUC for more information. - - Also, you can use any metadata in the - restructured text files: - * category: '%(category)s' - * author: '%(author)s' - * tags: '%(tags)s' - * date: '%(date)s' - - Example usage: - * '/%Y/%m/' it will be something like - '/2011/07/sample-post.html'. - * '/%Y/%(category)s/' it will be something like - '/2011/life/sample-post.html'. ================================================ =====================================================