django-pagelets 0.6.2

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

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

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

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

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

{% 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 %}