django-pagelets 0.6.1

Simple, flexible app for integrating static, unstructured content in a Django site

django-pagelets

Simple, flexible app for integrating static, unstructured content in a Django site

Features

• “Pagelets” for adding small pieces of content to otherwise static templates

• CMS “pages” which include any number of pagelets and, if needed, attachments

• Different pagelet content types including HTML and Markdown

• An integrated WYSIWYG editor (WYMeditor) which can be selectively enabled/disabled

Dependencies

Required

• Django admin site - The django.core.context_processors.request context processor

Optional

• jQuery 1.3

• WYMeditor (included in pagelets media)

Example

django-pagelets includes a sample project to use as an example setup. You can run the sample project like so:

~$ mkvirtualenv --distribute pagelet-test
(pagelet-test)~$ pip install -U django
(pagelet-test)~$ git clone git://github.com/caktus/django-pagelets.git
(pagelet-test)~$ cd django-pagelets/
(pagelet-test)~/django-pagelets$ python setup.py develop
(pagelet-test)~/django-pagelets$ cd sample_project/
(pagelet-test)~/django-pagelets/sample_project$ ./manage.py syncdb
(pagelet-test)~/django-pagelets/sample_project$ ./manage.py runserver

Installation and Setup

1. django-pagelets is available on PyPI, so the easiest way to install it is to use pip:

   pip install django-pagelets

2. Add pagelets to INSTALLED_APPS in settings.py and run syncdb:

   INSTALLED_APPS = (
       ...,
       'pagelets',
       ...
   )

3. Add django.core.context_processors.request to TEMPLATE_CONTEXT_PROCESSORS:

   TEMPLATE_CONTEXT_PROCESSORS = (
       "django.contrib.auth.context_processors.auth",
       "django.core.context_processors.debug",
       "django.core.context_processors.i18n",
       "django.core.context_processors.media",
       "django.contrib.messages.context_processors.messages",
       "django.core.context_processors.request", # <----
   )

4. Add the pagelets URLs to urls.py, e.g.:

   urlpatterns += patterns('',
       (r'^pagelets-management/', include('pagelets.urls.management')),
       (r'^', include('pagelets.urls.content')),
   )

5. In development, you can serve pagelet’s static media in urls.py:

   import pagelets
   path = os.path.join(os.path.dirname(pagelets.__file__), 'media')
   
   urlpatterns += patterns('',
       (
           r'^%spagelets/(?P<path>.*)' % settings.MEDIA_URL.lstrip('/'),
           'django.views.static.serve',
           {'document_root': path, 'show_indexes': True}
       ),
   )

6. Visit the admin site, add and save a new page, and click the View on site link. If everything is setup correctly, you should be able to see and edit the content you just added.

Optional Additional Setup

If you are using the contrib.sitemaps application to generate your sitemap you can make use of the PageSiteMap, e.g.:

from django.conf.urls.defaults import *
from pagelets.sitemaps import PageSiteMap

sitemaps = {
    'pagelets': PageSiteMap(priority=0.6),
    # Your other sitemaps
    # ...
}

# Site url patterns would go here
# ...

urlpatterns += patterns('',

    # the sitemap
    (r'^sitemap\.xml$', 'django.contrib.sitemaps.views.sitemap', {'sitemaps': sitemaps}),
)

Extending and Customizing Pagelets

Auto template tag loading

To automatically load a custom template tag on every pagelet, add a PAGELET_TEMPLATE_TAGS list to settings.py:

PAGELET_TEMPLATE_TAGS = (
    'myapp_tags',
    'myotherapp_tags',
)

Custom base templates and content areas

By default, django-pagelets uses a simplified setup for rendering pages in a uniform way. However, pages can be modified to extend from different base templates for greater customization. Pagelets can also specify custom content areas to allow for special grouping and positioning within pages.

Base templates and content areas can be customized via 2 settings: PAGELET_BASE_TEMPLATES and PAGELET_CONTENT_AREAS. For example, if you’d like to add an alternative 2-column layout, you could define the settings like so:

PAGELET_BASE_TEMPLATES = (
    ('pagelets/two_column_page.html', 'Two Column'),
)

PAGELET_CONTENT_AREAS = (
    ('main', 'Main'),
    ('sidebar', 'Sidebar'),
)

The page admin will now include an additional form field to select a base template and pagelets will allow the specification of content areas. The Two Column template could look something like this:

{% extends "base.html" %}

{% load pagelet_tags %}

{% block title %}{{ page.title }}{% endblock %}

{% block content %}
    <div id="main-panel">
        {% render_content_area page 'main' %}
    </div>
    <div id="sidebar-panel">
        {% render_content_area page 'sidebar' %}
    </div>
{% endblock %}

Note the render_content_area template tags with main and sidebar specified.

Development sponsored by Caktus Consulting Group, LLC..