mirror of
https://github.com/getpelican/pelican.git
synced 2025-10-15 20:28:56 +02:00
119 lines
3.6 KiB
ReStructuredText
119 lines
3.6 KiB
ReStructuredText
.. _plugins:
|
|
|
|
Plugins
|
|
#######
|
|
|
|
Since version 2.8, pelican manages plugins. Plugins are a way to add feature to
|
|
pelican without having to directly hack pelican code.
|
|
|
|
Pelican is shipped with a set of core plugins, but you can easily implement
|
|
your own (and this page describes how)
|
|
|
|
How to use plugins?
|
|
====================
|
|
|
|
To load plugins, you have to specify a them in your settings file. You have two
|
|
ways to do so: by specifying strings with the path to the callables: ::
|
|
|
|
PLUGINS = ['pelican.plugins.gravatar',]
|
|
|
|
Or by importing them and adding them to the list::
|
|
|
|
from pelican.plugins import gravatar
|
|
PLUGINS = [gravatar, ]
|
|
|
|
If your plugins are not in an importable path, you can specify a `PLUGIN_PATH`
|
|
in the settings::
|
|
|
|
PLUGIN_PATH = "plugins"
|
|
PLUGINS = ["list", "of", "plugins"]
|
|
|
|
How to create plugins?
|
|
======================
|
|
|
|
Plugins are based on the concept of signals. Pelican sends signals and plugins
|
|
subscribe to those signals. The list of signals are defined in a following
|
|
section.
|
|
|
|
The only rule to follow for plugins is to define a `register` callable, in
|
|
which you map the signals to your plugin logic. Let's take a simple exemple::
|
|
|
|
from pelican import signals
|
|
|
|
def test(sender):
|
|
print "%s initialized !!" % sender
|
|
|
|
def register():
|
|
signals.initialized.connect(test)
|
|
|
|
|
|
List of signals
|
|
===============
|
|
|
|
Here is the list of currently implemented signals:
|
|
|
|
========================= ============================ =========================================
|
|
Signal Arguments Description
|
|
========================= ============================ =========================================
|
|
initialized pelican object
|
|
article_generate_context article_generator, metadata
|
|
article_generator_init article_generator invoked in the ArticlesGenerator.__init__
|
|
========================= ============================ =========================================
|
|
|
|
The list is currently small, don't hesitate to add signals and make a pull
|
|
request if you need them!
|
|
|
|
List of plugins
|
|
===============
|
|
|
|
Not all the list are described here, but a few of them have been extracted from
|
|
pelican core and provided in pelican.plugins. They are described here:
|
|
|
|
Tag cloud
|
|
---------
|
|
|
|
Translation
|
|
-----------
|
|
|
|
Github Activity
|
|
_______________
|
|
|
|
This plugins introduces a new depencency, you have to install feedparser
|
|
if you want to use it, these are some ways to do it::
|
|
|
|
apt-get install python-feedparser # on debian based distributions like ubuntu
|
|
sudo easy_install feedparser
|
|
sudo pip install feedparser
|
|
|
|
To enable it set in your pelican config file the GITHUB_ACTIVITY_FEED
|
|
parameter pointing to your github activity feed.
|
|
|
|
for example my personal activity feed is::
|
|
|
|
https://github.com/kpanic.atom
|
|
|
|
and the config line could be::
|
|
|
|
GITHUB_ACTIVITY_FEED = 'https://github.com/kpanic.atom'
|
|
|
|
in your template just write a for in jinja2 syntax against the
|
|
github_activity variable, like for example::
|
|
|
|
{% if GITHUB_ACTIVITY_FEED %}
|
|
<div class="social">
|
|
<h2>Github Activity</h2>
|
|
<ul>
|
|
|
|
{% for entry in github_activity %}
|
|
<li><b>{{ entry[0] }}</b><br /> {{ entry[1] }}</li>
|
|
{% endfor %}
|
|
</ul>
|
|
</div><!-- /.github_activity -->
|
|
{% endif %}
|
|
|
|
|
|
|
|
github_activity is a list containing a list. The first element is the title and
|
|
the second element is the raw html from github so you can include it directly
|
|
in your (for example base.html) template and style it in a way that your prefer
|
|
using your css skills
|