diff --git a/docs/settings.rst b/docs/settings.rst index 42ccf2be..d2d1ebbc 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -24,34 +24,8 @@ 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'. +`ARTICLE_PERMALINK_STRUCTURE` (``''``) Empty by default. Allows to render URLs in a + particular way, see below. `AUTHOR` Default author (put your name) `DATE_FORMATS` (``{}``) If you do manage multiple languages, you can set the date formatting here. @@ -93,11 +67,43 @@ 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. +`TIMEZONE` (Optional) The timezone used in the date information, to + generate atom and rss feeds. + Have a look at `the wikipedia page`_ for more + information ================================================ ===================================================== - +.. _the wikipedia page: http://en.wikipedia.org/wiki/List_of_tz_database_time_zones .. [1] Default is the system locale. Default is to delete the output directory. +Article permalink structure +--------------------------- +Allow to render 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'. + Feed settings =============