Quick start guide

Installing django-fluent-pages

Make sure you have the base packages installed:

pip install Django
pip install django-fluent-pages

This command installs the base dependencies. As you add more of the Bundled Page Type Plugins, additional packages may be required. This is explained in the documentation for each plugin.


For optional dependency management, it is strongly recommended that you run the application inside a virtualenv.

Starting a project

For a quick way to have everything configured at once, use our template:

mkdir example.com
django-admin.py startproject "myexample" "example.com" -e "py,rst,example,gitignore" --template="https://github.com/edoburu/django-project-template/archive/django-fluent.zip"

And install it’s packages:

mkvirtualenv example.com
pip install -r example.com/requirements.txt

Otherwise, continue with the instructions below:

Basic Settings

In your existing Django project, the following settings need to be added to settings.py:


    # And optionally add the desired page types with their dependencies:

    # - flat pages

    # - redirect nodes
    'any_urlfield',  # optional but recommended

The following applications are used here:

  • The main fluent_pages package that you always need.
  • The main dependencies.
  • A selection of page type plugins, and their dependencies.

Since some extra page types are used here, make sure their dependencies are installed:

pip install django-fluent-pages[flatpage,redirectnode]

Afterwards, you can setup the database:

./manage.py migrate  # use 'syncdb' for Django 1.6 and below


Each page type is optional. Only the fluent_pages application is required, allowing to write custom models and plugins. Since a layout with the flatpage and redirectnode page types provides a good introduction, these are added here.

Each plugin is easily swappable for other implementations, exactly because everything is optional! You can use a different page type, or invert new page types with custom fields. It makes the CMS configurable in the way that you see fit.

URL configuration

The following needs to be added to urls.py:

urlpatterns += patterns('',
    url(r'', include('fluent_pages.urls'))

See also

Template structure

The page output is handled by templates. When creating large websites, you’ll typically have multiple page templates. That’s why it’s recommended to have a single base template for all pages. This can expose the SEO fields that are part of every HTML page. As starting point, the following structure is recommended:


Now, create a pages/base.html template:

{% extends "base.html" %}

{% block full-title %}{% if page.meta_title %}{{ page.meta_title }}{% else %}{{ block.super }}{% endif %}{% endblock %}
{% block meta-keywords %}{{ page.meta_keywords }}{% endblock %}
{% block meta-description %}{{ page.meta_description }}{% endblock %}

{% block extrahead %}{{ block.super }}{% if page.meta_robots %}
    <meta name="robots" content="{{ page.meta_robots }}" />
{% endif %}{% endblock %}

These blocks should appear in your base.html template off course.

Your site base.html template could look something like this:

{% load fluent_pages_tags %}
<!DOCTYPE html>
  <meta charset="utf-8" />
  <meta name="keywords" content="{% block meta-keywords %}{% endblock %}" />
  <meta name="description" content="{% block meta-description %}{% endblock %}" />
  <title>{% block full-head-title %}{% block head-title %}Untitled{% endblock %} | My site{% endblock %}</title>
  {% block extrahead %}{% endblock %}
        {% render_menu %}

    <section id="contents">
        <div id="main">
            <h1>{{ page.title }}</h1>

            {% render_breadcrumb %}

            {% block main %}{% endblock %}

This base template does the following:

  • Expose the placeholders for SEO fields.
  • Add a main menu using {% render_menu %}
  • Add a breadcrumb using {% render_breadcrumb %}


Whether page.title should be included is your own decision. You can also let clients enter the <h1> in the WYSIWYG page content, and reserve page.title for menu titles alone. This works really well in practise.

Adding page content

This package is very flexible when it comes to choosing page content. There are several page type plugins available:

  • fluent_pages.pagetypes.flatpage - a simple page with WYSIWYG text box.
  • fluent_pages.pagetypes.fluentpage - a page with flexible content blocks.
  • Other known page types, such as a FAQ index or Blog index page.

The tree can also contain other node types, e.g.:

  • fluent_pages.pagetypes.redirectnode - a redirect.
  • fluent_pages.pagetypes.text - a plain text file, e.g. to add a humans.txt file.
  • or any custom page type you create.

See also

In this quick-start manual, we’ll discuss the most important options briefly below. See the Bundled Page Type Plugins for the full documentation about each page type.

Using the flatpage plugin

The Flat page page type displays a simple WYSIWYG text box. To use it, install the packages and desired plugins:

pip install django-fluent-pages[flatpage]
pip install django-tinymce


You can also use CKEditor, Redactor or an other WYSIWYG editor, but for convenience TinyMCE is used as example. See the documentation of the The flatpage page type for details.

Add the following settings:


DJANGO_WYSIWYG_FLAVOR = "tinymce"    # or "tinymce_advanced"

Make sure the database tables are created:

./manage.py migrate

To render the output properly, create a fluent_pages/base.html file so the Flat page pages can map the block names to the ones you use in base.html:

{% extends "pages/base.html" %}

{% block head-title %}{% block title %}{% endblock %}{% endblock %}

{% block main %}{% block content %}{% endblock %}{% endblock %}

Using the fluentpage plugin

The Fluent page page type can fill parts of the page with flexible content blocks. To use it, install the packages and desired plugins:

pip install django-fluent-pages[fluentpage]
pip install django-fluent-contents[text,code,markup]

Configure the settings:


    # Page types

    # Several content plugins
    'fluent_contents.plugins.text',                # requires django-wysiwyg
    'fluent_contents.plugins.code',                # requires pygments

FLUENT_MARKUP_LANGUAGE = 'reStructuredText'        # can also be markdown or textile

Make sure the database tables are created:

./manage.py migrate

The template can be filled with the “placeholder” tags from django-fluent-contents:

{% extends "mysite/base.html" %}
{% load placeholder_tags %}

{% block main %}
    <section id="main">
            {% block pagetitle %}<h1 class="pagetitle">{{ page.title }}</h1>{% endblock %}
            {% page_placeholder "main" role='m' %}

            {% page_placeholder "sidebar" role='s' %}
{% endblock %}

Testing your new shiny project

Congrats! At this point you should have a working installation. Now you can just login to your admin site and see what changed.