Advanced Configuration

Sitemaps

One of the cool features of Django is the sitemap application, so if you want to fill your Web site’s sitemap with the entries of your blog, follow these steps.

  • Register django.contrib.sitemaps in the INSTALLED_APPS section.

  • Edit your project’s URLs and add this code:

    from zinnia.sitemaps import TagSitemap
    from zinnia.sitemaps import EntrySitemap
    from zinnia.sitemaps import CategorySitemap
    from zinnia.sitemaps import AuthorSitemap
    
    sitemaps = {'tags': TagSitemap,
                'blog': EntrySitemap,
                'authors': AuthorSitemap,
                'categories': CategorySitemap,}
    
    urlpatterns += patterns(
        'django.contrib.sitemaps.views',
        url(r'^sitemap.xml$', 'index',
            {'sitemaps': sitemaps}),
        url(r'^sitemap-(?P<section>.+)\.xml$', 'sitemap',
            {'sitemaps': sitemaps}),)
    

Templates for entries

In your Weblog you will always publish entries, but sometimes you want to have a different look and feel for special entries.

You may want to publish an entry with a short content like a quote, in which case it would be better not to provide a continue reading link when rendering this entry.

To solve this problem, Zinnia allows the user to select a template to render the entry’s content and the entry’s detail page.

In order to use a template without the continue reading link, we need to register it under this setting in the project’s configuration:

ZINNIA_ENTRY_CONTENT_TEMPLATES = [
  ('zinnia/_short_entry_detail.html', 'Short entry template'),
]

Now we will create the zinnia/_short_entry_detail.html template with this sample of code:

{% extends "zinnia/_entry_detail.html" %}

{% block continue-reading %}{% endblock %}

A new template is now available in the admin interface to display the entry without the continue reading link when displayed in a list.

Then if you want to have custom rendering of the detail page of the entry, by displaying the entry fullwidth without the sidebar for example, the same process applies. We will add this setting in the project’s configuration:

ZINNIA_ENTRY_DETAIL_TEMPLATES = [
    ('zinnia/fullwidth_entry_detail.html', 'Fullwidth template'),
]

And now we finally create the zinnia/fullwidth_entry_detail.html template with this sample of code:

{% extends "zinnia/entry_detail.html" %}

{% block sidebar-class %}no-sidebar{% endblock %}

{% block sidebar %}{% endblock %}

Akismet Anti-Spam

If you want to benefit of the Akismet spam protection on your comments, it’s possible to do it by installing the akismet Python module, and add this setting:

ZINNIA_SPAM_CHECKER_BACKENDS = ('zinnia.spam_checker.backends.automattic',)

Important

You need an API key. If you don’t have any, get one for free at http://akismet.com/signup/ then set it in your project’s settings like this:

AKISMET_SECRET_API_KEY = 'your key'

TypePad Anti-Spam

It’s also possible to benefit of the TypePad AntiSpam service to fight the spam. Like the Akismet protection you need to install the akismet Python module.

Then register the TypePad AntiSpam protection with this setting:

ZINNIA_SPAM_CHECKER_BACKENDS = ('zinnia.spam_checker.backends.typepad',)

Important

You need an API key. If you don’t have any, get one for free at http://antispam.typepad.com/info/get-api-key.html then set it in your project’s settings like this:

TYPEPAD_SECRET_API_KEY = 'your key'

Mollom Anti-Spam

Another approach to fight the spam is provided by Mollom, Zinnia implement a backend to use this spam filtering service. Before configuring the service, you need to install the PyMollom Python library and then register the Mollom spam checking protection with this setting:

ZINNIA_SPAM_CHECKER_BACKENDS = ('zinnia.spam_checker.backends.mollom',)

Important

You need a private and public keys to use this service. Get a free account at http://mollom.com/pricing then set your keys in your project’s settings like this:

MOLLOM_PUBLIC_KEY = 'your public key'
MOLLOM_PRIVATE_KEY = 'your private key'

Pinging

By default Zinnia is configured to ping the directories and the external urls embedded in your entries when a new entry is published.

If you want to completly remove these features, simply set these settings in your project’s configuration:

ZINNIA_PING_EXTERNAL_URLS = False
ZINNIA_SAVE_PING_DIRECTORIES = False

You can also edit the list of the directories to be pinged by using this setting:

ZINNIA_PING_DIRECTORIES = ('http://ping.directory.com/',
                           'http://pong.directory.com/')

Twitter

When you post a new entry on your blog you might want to tweet it as well.

In order to do that, you first need to install tweepy and add these settings.

TWITTER_CONSUMER_KEY = 'Your Consumer Key'
TWITTER_CONSUMER_SECRET = 'Your Consumer Secret'
TWITTER_ACCESS_KEY = 'Your Access Key'
TWITTER_ACCESS_SECRET = 'Your Access Secret'

Note that the authentification for Twitter has changed since September 2010. The actual authentification system is based on oAuth. That’s why now you need to set these 4 settings. If you don’t know how to get these information, follow this excellent tutorial at:

http://jmillerinc.com/2010/05/31/twitter-from-the-command-line-in-python-using-oauth/

Now in the admin, you can post an update containing your entry’s title and the shortened URL of your entry.

Django-CMS

If you use django-CMS, Zinnia can be integrated into your pages, thanks to the plugin system.

Warning

Changed in version 0.10.1.

zinnia.plugins has been removed in favor of cmsplugin_zinnia.

Simply refer to cmsplugin_zinnia‘s documentation for more information about the install instructions and possibilities.

TinyMCE

If you want to replace WYMEditor by TinyMCE just install django-tinymce as described in the the installation instructions.

TinyMCE can be customized by overriding the admin/zinnia/entry/tinymce_textareas.js template.

Markup languages

If you doesn’t want to write your entries in HTML, because you are an über coder knowing more than 42 programming languages, you have the possibility to use a custom markup language for editing the entries.

Currently MarkDown, Textile and reStructuredText are supported, so if you want to use one of these languages, first set this setting as appropriate in your project’s settings.

ZINNIA_MARKUP_LANGUAGE = 'restructuredtext'

Note that the name of the language must be in lowercase.

Then install the corresponding library to your needs:

  • textile – requires Textile >= 2.1.5
  • markdown – requires Markdown >= 2.3.1
  • restructuredtext – requires Docutils >= 0.10

XML-RPC

Zinnia provides few Webservices via XML-RPC, but before using it, you need to install django-xmlrpc.

Then register django_xmlrpc in your INSTALLED_APPS section of your project’s settings.

Now add these lines in your project’s settings.

from zinnia.xmlrpc import ZINNIA_XMLRPC_METHODS
XMLRPC_METHODS = ZINNIA_XMLRPC_METHODS

ZINNIA_XMLRPC_METHODS is a simple list of tuples containing all the Webservices embedded in Zinnia.

If you only want to use the Pingback service import ZINNIA_XMLRPC_PINGBACK, or if you want you just want to enable the MetaWeblog API import ZINNIA_XMLRPC_METAWEBLOG.

You can also use your own mixins.

Finally we need to register the URL of the XML-RPC server. Insert something like this in your project’s urls.py:

url(r'^xmlrpc/$', 'django_xmlrpc.views.handle_xmlrpc'),

Note

For the Pingback service check if your site is enabled for pingback detection. More information at http://hixie.ch/specs/pingback/pingback-1.0#TOC2

Table Of Contents

Previous topic

Installation

Next topic

Upgrading Zinnia

This Page