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

Add configuration settings for custom tests and globals in jinja2 environment

Browse source
This commit is contained in:
Kale Franz 2013-12-25 15:13:26 -06:00
commit df71ee21e4
3 changed files with 21 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/settings.rst
View file

@ -76,10 +76,16 @@ Setting name (default value) What doe
output directory. One use case would be the preservation of version
control data. For example: ``(".hg", ".git", ".bzr")``
`JINJA_EXTENSIONS` (``[]``) A list of any Jinja2 extensions you want to use.
`JINJA_FILTERS` (``{}``) A list of custom Jinja2 filters you want to use.
`JINJA_FILTERS` (``{}``) A dictionary of custom Jinja2 filters you want to use.
The dictionary should map the filtername to the filter function.
For example: ``{'urlencode': urlencode_filter}``
See `Jinja custom filters documentation`_.
`JINJA_GLOBALS` (``{}``) A dictionary of custom objects to map into the Jinja2 global environment
namespace. The dictionary should map the global name to the global
attribute. See `Jinja global namespace documentation`_.
`JINJA_TESTS` (``{}``) A dictionary of custom Jinja2 tests you want to use.
The dictionary should map the testname to the test function.
See `Jinja custom tests documentation`_.
`LOCALE` (''[#]_) Change the locale. A list of locales can be provided
here or a single string representing one locale.
When providing a list, all the locales will be tried
@ -166,6 +172,10 @@ Setting name (default value) What doe
.. [#] Default is the system locale.
.. _Jinja custom filters documentation: http://jinja.pocoo.org/docs/api/#custom-filters
.. _Jinja global namespace documentation: http://jinja.pocoo.org/docs/api/#the-global-namespace
.. _Jinja custom tests documentation: http://jinja.pocoo.org/docs/api/#custom-tests
URL settings
------------
@ -680,6 +690,3 @@ Example settings
.. literalinclude:: ../samples/pelican.conf.py
:language: python
.. _Jinja custom filters documentation: http://jinja.pocoo.org/docs/api/#custom-filters

8
pelican/generators.py
View file

@ -72,6 +72,14 @@ class Generator(object):
custom_filters = self.settings['JINJA_FILTERS']
self.env.filters.update(custom_filters)
# get custom Jinja globals from user settings
custom_globals = self.settings['JINJA_GLOBALS']
self.env.globals.update(custom_globals)
# get custom Jinja tests from user settings
custom_tests = self.settings['JINJA_TESTS']
self.env.tests.update(custom_tests)
signals.generator_init.send(self)
def get_template(self, name):

2
pelican/settings.py
View file

@ -94,6 +94,8 @@ DEFAULT_CONFIG = {
'MD_EXTENSIONS': ['codehilite(css_class=highlight)', 'extra'],
'JINJA_EXTENSIONS': [],
'JINJA_FILTERS': {},
'JINJA_GLOBALS': {},
'JINJA_TESTS': {},
'LOCALE': [''], # defaults to user locale
'DEFAULT_PAGINATION': False,
'DEFAULT_ORPHANS': 0,