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

Address code review comments from PR getpelican/pelican#1348

Browse source 
The text about the sort-by-key function comes from:
https://docs.python.org/2/library/stdtypes.html#sequence-types-str-unicode-list-tuple-bytearray-buffer-xrange

Minor style cleanup as well.
This commit is contained in:
Mark Lee 2014-05-20 13:53:02 -07:00
commit 144cddaf39
2 changed files with 26 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

36
docs/settings.rst
View file

@ -260,16 +260,19 @@ posts for the month at ``posts/2011/Aug/index.html``.
arrive at an appropriate archive of posts, without having to specify
a page name.
====================================================== ========================================================
====================================================== ==============================================================
Setting name (followed by default value, if any) What does it do?
====================================================== ========================================================
====================================================== ==============================================================
``ARTICLE_URL = '{slug}.html'`` The URL to refer to an article.
``ARTICLE_SAVE_AS = '{slug}.html'`` The place where we will save an article.
``ARTICLE_ORDER_BY = 'slug'`` The metadata attribute used to sort articles. By default
the articles_page.object_list template variable is
ordered by slug. If you modify this, make sure all
articles contain the attribute you specify. You can
also specify a sorting function.
``ARTICLE_ORDER_BY = 'slug'`` The metadata attribute used to sort articles. By default,
the ``articles_page.object_list`` template variable is
ordered by slug. If you modify this, make sure all
articles contain the attribute you specify. You can also
specify a "sorting" function of one argument that is used
to extract a comparison key from each article. For example,
sorting by title without using the built-in functionality
would use the function ``operator.attrgetter('title')``.
``ARTICLE_LANG_URL = '{slug}-{lang}.html'`` The URL to refer to an article which doesn't use the
default language.
``ARTICLE_LANG_SAVE_AS = '{slug}-{lang}.html'`` The place where we will save an article which
@ -285,13 +288,16 @@ Setting name (followed by default value, if any) What does it do?
the same as PAGE_URL or you need to use a rewrite in
your server config.
``PAGE_ORDER_BY = 'filename'`` The metadata attribute used to sort pages. By default
the PAGES template variable is ordered by filename
(path not included). Note that the option 'filename'
is a special option supported in the source code. If
you modify this settings, make sure all pages contain
the attribute you specify. You can also specify a
sorting function.
``PAGE_ORDER_BY = 'basename'`` The metadata attribute used to sort pages. By default
the ``PAGES`` template variable is ordered by basename
(i.e., path not included). Note that the option ``'basename'``
is a special option supported in the source code. If
you modify this setting, make sure all pages contain
the attribute you specify. You can also specify a "sorting"
function of one argument that is used to extract a comparison
key from each page. For example, the basename function looks
similar to
``lambda x: os.path.basename(getattr(x, 'source_path', ''))``.
``PAGE_LANG_URL = 'pages/{slug}-{lang}.html'`` The URL we will use to link to a page which doesn't
use the default language.
``PAGE_LANG_SAVE_AS = 'pages/{slug}-{lang}.html'`` The location we will save the page which doesn't
@ -309,7 +315,7 @@ Setting name (followed by default value, if any) What does it do?
non-alphanumerics when generating slugs. Specified
as a list of 2-tuples of ``(from, to)`` which are
applied in order.
====================================================== ========================================================
====================================================== ==============================================================
.. note::