django-dbtemplates 0.5.0

Setup

1. Get the source from the subversion repository

2. Follow the instructions in the INSTALL file

3. Edit the settings.py of your Django site:

   • Add dbtemplates to the INSTALLED_APPS setting

     Check if django.contrib.sites and django.contrib.admin are in INSTALLED_APPS and add if necessary.

     It should look something like this:

     INSTALLED_APPS = (
         'django.contrib.auth',
         'django.contrib.contenttypes',
         'django.contrib.sessions',
         'django.contrib.sites',
         'django.contrib.admin',
         'django.contrib.flatpages',
         # ..
         'dbtemplates',
     )

   • Add dbtemplates.loader.load_template_source to the TEMPLATE_LOADERS list in the settings.py of your Django project

     It should look something like this:

     TEMPLATE_LOADERS = (
         'django.template.loaders.filesystem.load_template_source',
         'django.template.loaders.app_directories.load_template_source',
         'dbtemplates.loader.load_template_source',
     )

4. Sync your database python manage.py syncdb

5. Restart your Django server

Usage

Creating database templates is pretty simple: Just open the admin interface of your Django-based site in your browser and click on “Templates” in the “Dbtemplates” section.

There you only need to fill in the name field with the identifier, Django is supposed to use while searching for templates, e.g. blog/entry_list.html. The content field should be filled with the content of your template.

Optionally, by leaving the content field empty you are able to tell dbtemplates to look for a template with the name by using Django’s other template loaders. For example, if you have a template called blog/entry_list.html on your file system and want to save the templates contents in the database, you just need to leave the content field empty to automatically populate it. That’s especially useful if you don’t want to copy and paste its content manually to the textarea.

Caching

Versionizing your templates

dbtemplates comes prepared to use the third party Django app django-reversion, that once installed besides dbtemplates allows you to jump back to old versions of your templates. It automatically saves every state when you save the template in your database and provides an easy to use interface.

Please refer to django-reversion’s documentation for more information about how it works. dbtemplates automatically recognizes if django-reversion is installed and works out of the box. Just visit the “History” section of each template instance and browse its history.

Support

Please leave your questions and messages on the designated Google Code site:

http://code.google.com/p/django-dbtemplates/