Plugins doc + minor design changes.

docs/index.rst

@@ -55,6 +55,8 @@ A french version of the documentation is available at :doc:`fr/index`.
    getting_started
    settings
    themes
+   pelican-themes
+   plugins
    internals
    faq
    contribute

docs/plugins.rst

@@ -0,0 +1,75 @@
+.. _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
+=========================   ============================   =====================
+
+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
+-----------

docs/settings.rst

@@ -51,6 +51,7 @@ Setting name (default value)                        what does it do?
 `PDF_GENERATOR` (``False``)                         Set to True if you want to have PDF versions
                                                     of your documents. You will need to install
                                                     `rst2pdf`.
+`PLUGINS` (``[]``)                                  The list of plugins to load. See :ref:`plugins`.
 `RELATIVE_URL` (``True``)                           Defines if pelican should use relative urls or
                                                     not.
 `SITEURL`                                           base URL of your website. Note that this is
@@ -208,14 +209,14 @@ Setting name              what does it do ?
 `GITHUB_URL`              Your github URL (if you have one), it will then
                           use it to create a github ribbon.
 `GOOGLE_ANALYTICS`        'UA-XXXX-YYYY' to activate google analytics.
+`LINKS`                   A list of tuples (Title, Url) for links to appear on
+                          the header.
 `PIWIK_URL`               URL to your Piwik server - without 'http://' at the
                           beginning.
 `PIWIK_SSL_URL`           If the SSL-URL differs from the normal Piwik-URL
                           you have to include this setting too. (optional)
 `PIWIK_SITE_ID`           ID for the monitored website. You can find the ID
                           in the Piwik admin interface > settings > websites.
-`LINKS`                   A list of tuples (Title, Url) for links to appear on
-                          the header.
 `SOCIAL`                  A list of tuples (Title, Url) to appear in the "social"
                           section.
 `TWITTER_USERNAME`        Allows to add a button on the articles to tweet about