The template tags

The template tags provide the rendering of placeholder content. Load the tags using:

{% load fluent_contents_tags %}

To render a placeholder for a given object, use:

{% render_placeholder myobject.placeholder_field %}

CMS Page placeholders

To define the placeholders for a cms page, use:

{% page_placeholder currentpage "slotname" %}

If the currentpage variable is named page, it can be left out.

Using a custom template

To customize the placeholder contents, a template can be specified:

{% page_placeholder currentpage "slotname" template="mysite/parts/slot_placeholder.html" %}

That template should loop over the content items, and include additional HTML. For example:

{% for contentitem, html in contentitems %}
  {% if not forloop.first %}<div class="splitter"></div>{% endif %}
  {{ html }}
{% endfor %}

The following variables are available:

  • contentitems - a list with:
  • the ContentItem model. You can access contentitem.plugin.name to read the actual plugin name. The model itself is generally not downcasted to the actual model.
  • the rendered HTML code
  • parent_object - the parent object, this may be None if render_items() was used instead of render_placeholder().

Note

When a template is used, the system assumes that the output can change per request. Hence, even though FLUENT_CONTENTS_CACHE_PLACEHOLDER_OUTPUT may be set, but the final merged output will no longer be cached. Add cachable=1 to enable output caching for templates too.

The output of individual items will always be cached, as that is subject to the FLUENT_CONTENTS_CACHE_OUTPUT setting.

Admin Meta information

Extra meta information can be provided for the admin interface:

{% page_placeholder currentpage "slotname" title="Tab title" role="main %}

The metadata can be extracted with the PagePlaceholderNode class, and fluent_contents.analyzer module.

Fallback languages

New in version 1.0: For multilingual sites, the contents of the active translation will be displayed only. To render the fallback language for empty placeholders, use the fallback parameter:

{% page_placeholder currentpage "slotname" fallback=1 %}

This can be used to display the “english” content everywhere by default for example, until a translator fills the contents of the page. The fallback language is defined in the FLUENT_CONTENTS_DEFAULT_LANGUAGE_CODE setting.

Frontend media

To render the CSS/JS includes of content items, use:

{% render_content_items_media %}

This tag should be placed at the bottom of the page, after all plugins are rendered.

Optionally, specify to render only the CSS or JavaScript content:

{% render_content_items_media css %}
{% render_content_items_media js %}
{% render_content_items_media js internal %}
{% render_content_items_media js external %}

By adding the local or external flag, the media files will be split into:

  • externally hosted files which should not be compressed (e.g. a plugin that includes the Google Maps API).
  • locally hosted files which can be compressed.

This way, the contents can be minified too, using django-compressor for example:

{% load compress fluent_contents_tags %}

{% render_content_items_media css external %}
{% compress css %}
    {% render_content_items_media css internal %}
{% endcompress %}

{% render_content_items_media js external %}
{% compress js %}
    {% render_content_items_media js local %}
    {% block extra_scripts %}{% endblock %}
{% endcompress %}

Note for existing projects

Deprecated since version 1.0: Previously, the template tag library was called placeholder_tags. Using the old style import still works. It’s recommended to change it:

{% load placeholder_tags %}