3. Templatetags

To use any of the following templatetags you need to load them first at the top of your template:

  1. {% load cms_tags menu_tags %}

3.1. placeholder

The placeholder templatetag defines a placeholder on a page. All placeholders in a template will be auto-detected and can be filled with plugins when editing a page that is using said template. When rendering, the content of these plugins will appear where the placeholder tag was.

Example:

  1. {% placeholder "content" %}

If you want additional content to be displayed in case the placeholder is empty, use the or argument and an additional {% endplaceholder %} closing tag. Everything between {% placeholder "..." or %} and {% endplaceholder %} is rendered instead if the placeholder has no plugins or the plugins do not generate any output.

Example:

  1. {% placeholder "content" or %}There is no content.{% endplaceholder %}

If you want to add extra variables to the context of the placeholder, you should use Django’s with tag. For instance, if you want to resize images from your templates according to a context variable called width, you can pass it as follows:

  1. {% with 320 as width %}{% placeholder "content" %}{% endwith %}

If you want the placeholder to inherit the content of a placeholder with the same name on parent pages, simply pass the inherit argument:

  1. {% placeholder "content" inherit %}

This will walk the page tree up till the root page and will show the first placeholde it can find with content.

It’s also possible to combine this with the or argument to show an ultimate fallback if the placeholder and non of the placeholders on parent pages have plugins that generate content:

  1. {% placeholder "content" inherit or %}There is no spoon.{% endplaceholder %}

See also the PLACEHOLDER_CONF setting where you can also add extra context variables and change some other placeholder behavior.

3.2. show_placeholder

Displays a specific placeholder from a given page. This is useful if you want to have some more or less static content that is shared among many pages, such as a footer.

Arguments:

  • placeholder_name
  • page_lookup (see Page Lookup for more information)
  • language (optional)
  • site (optional)

Examples:

  1. {% show_placeholder "footer" "footer_container_page" %}
  2. {% show_placeholder "content" request.current_page.parent_id %}
  3. {% show_placeholder "teaser" request.current_page.get_root %}

3.2.1. Page Lookup

The page_lookup argument, passed to several templatetags to retrieve a page, can be of any of the following types:

  • String: interpreted as the reverse_id field of the desired page, which can be set in the “Advanced” section when editing a page.
  • Integer: interpreted as the primary key (pk field) of the desired page
  • dict: a dictionary containing keyword arguments to find the desired page (for instance: {'pk': 1})
  • Page: you can also pass a page object directly, in which case there will be no database lookup.

If you know the exact page you are referring to, it is a good idea to use a reverse_id (a string used to uniquely name a page) rather than a hard-coded numeric ID in your template. For example, you might have a help page that you want to link to or display parts of on all pages. To do this, you would first open the help page in the admin interface and enter an ID (such as help) under the ‘Advanced’ tab of the form. Then you could use that reverse_id with the appropriate templatetags:

  1. {% show_placeholder "right-column" "help" %}
  2. <a href="{% page_url "help" %}">Help page</a>

If you are referring to a page relative to the current page, you’ll probably have to use a numeric page ID or a page object. For instance, if you want the content of the parent page display on the current page, you can use:

  1. {% show_placeholder "content" request.current_page.parent_id %}

Or, suppose you have a placeholder called teaser on a page that, unless a content editor has filled it with content specific to the current page, should inherit the content of its root-level ancestor:

  1. {% placeholder "teaser" or %}
  2.     {% show_placeholder "teaser" request.current_page.get_root %}
  3. {% endplaceholder %}

3.3. show_uncached_placeholder

The same as show_placeholder, but the placeholder contents will not be cached.

Arguments:

  • placeholder_name
  • page_lookup (see Page Lookup for more information)
  • language (optional)
  • site (optional)

Example:

  1. {% show_uncached_placeholder "footer" "footer_container_page" %}

3.4. plugins_media

Outputs the appropriate tags to include all media that is used by the plugins on a page (defined using the Media class in the plugin class).

You normally want to place this in your <head> tag.

Example:

  1. {% plugins_media %}

Arguments:

  • page_lookup (optional; see Page Lookup for more information)

If you need to include the media from another page, for instance if you are using a placeholder from another page using the show_placeholder tag, you can supply the page_lookup attribute to indicate the page in question:

  1. {% plugins_media "teaser" %}

For a reference on what plugin media is required by a specific plugin, look at that plugin’s reference.

3.5. page_url

Displays the URL of a page in the current language.

Arguments:

Example:

  1. <a href="{% page_url "help" %}">Help page</a>
  2. <a href="{% page_url request.current_page.parent %}">Parent page</a>

3.6. page_attribute

This templatetag is used to display an attribute of the current page in the current language.

Arguments:

  • attribute_name
  • page_lookup (optional; see Page Lookup for more information)

Possible values for attribute_name are: "title", "menu_title", "page_title", "slug", "meta_description", "meta_keywords" (note that you can also supply that argument without quotes, but this is deprecated because the argument might also be a template variable).

Example:

  1. {% page_attribute "page_title" %}

If you supply the optional page_lookup argument, you will get the page attribute from the page found by that argument.

Example:

  1. {% page_attribute "page_title" "my_page_reverse_id" %}
  2. {% page_attribute "page_title" request.current_page.parent_id %}
  3. {% page_attribute "slug" request.current_page.get_root %}

3.7. show_menu

The show_menu tag renders the navigation of the current page. You can overwrite the appearance and the HTML if you add a cms/menu.html template to your project or edit the one provided with django-cms. show_menu takes four optional parameters: start_level, end_level, extra_inactive, and extra_active.

The first two parameters, start_level (default=0) and end_level (default=100) specify from what level to which level should the navigation be rendered. If you have a home as a root node and don’t want to display home you can render the navigation only after level 1.

The third parameter, extra_inactive (default=0), specifies how many levels of navigation should be displayed if a node is not a direct ancestor or descendant of the current active node.

Finally, the fourth parameter, extra_active (default=100), specifies how many levels of descendants of the currently active node should be displayed.

3.7.1. Some Examples

Complete navigation (as a nested list):

  1. <ul>
  2.     {% show_menu 0 100 100 100 %}
  3. </ul>

Navigation with active tree (as a nested list):

  1. <ul>
  2.     {% show_menu 0 100 0 100 %}
  3. </ul>

Navigation with only one active extra level:

  1. <ul>
  2.     {% show_menu 0 100 0 1 %}
  3. </ul>

Level 1 navigation (as a nested list):

  1. <ul>
  2.     {% show_menu 1 %}
  3. </ul>

Navigation with a custom template:

  1. {% show_menu 0 100 100 100 "myapp/menu.html" %}

3.8. show_menu_below_id

If you have set an id in the advanced settings of a page, you can display the submenu of this page with a template tag. For example, we have a page called meta that is not displayed in the navigation and that has the id “meta”:

  1. <ul>
  2.     {% show_menu_below_id "meta" %}
  3. </ul>

You can give it the same optional parameters as show_menu:

  1. <ul>
  2.     {% show_menu_below_id "meta" 0 100 100 100 "myapp/menu.html" %}
  3. </ul>

3.9. show_sub_menu

Displays the sub menu of the current page (as a nested list). Takes one argument that specifies how many levels deep should the submenu be displayed. The template can be found at cms/sub_menu.html:

  1. <ul>
  2.     {% show_sub_menu 1 %}
  3. </ul>

Or with a custom template:

  1. <ul>
  2.     {% show_sub_menu 1 "myapp/submenu.html" %}
  3. </ul>

3.10. show_breadcrumb

Renders the breadcrumb navigation of the current page. The template for the HTML can be found at cms/breadcrumb.html:

  1. {% show_breadcrumb %}

Or with a custom template and only display level 2 or higher:

  1. {% show_breadcrumb 2 "myapp/breadcrumb.html" %}

Usually, only pages visible in the navigation are shown in the breadcrumb. To include all pages in the breadcrumb, write:

  1. {% show_breadcrumb 0 "cms/breadcrumb.html" 0 %}

If the current URL is not handled by the CMS or by a navigation extender, the current menu node can not be determined. In this case you may need to provide your own breadcrumb via the template. This is mostly needed for pages like login, logout and third-party apps. This can easily be accomplished by a block you overwrite in your templates.

For example in your base.html:

  1. <ul>
  2.     {% block breadcrumb %}
  3.     {% show_breadcrumb %}
  4.     {% endblock %}
  5. <ul>

And then in your app template:

  1. {% block breadcrumb %}
  2. <li><a href="/">home</a></li>
  3. <li>My current page</li>
  4. {% endblock %}

3.11. page_language_url

Returns the url of the current page in an other language:

  1. {% page_language_url de %}
  2. {% page_language_url fr %}
  3. {% page_language_url en %}

If the current url has no cms-page and is handled by a navigation extender and the url changes based on the language: You will need to set a language_changer function with the set_language_changer function in cms.utils.

For more information, see Internationalization.

3.12. language_chooser

The language_chooser template tag will display a language chooser for the current page. You can modify the template in menu/language_chooser.html or provide your own template if necessary.

Example:

  1. {% language_chooser %}

or with custom template:

  1. {% language_chooser "myapp/language_chooser.html" %}

The language_chooser has three different modes in which it will display the languages you can choose from: “raw” (default), “native”, “current” and “short”. It can be passed as last argument to the language_chooser tag as a string. In “raw” mode, the language will be displayed like it’s verbose name in the settings. In “native” mode the languages are displayed in their actual language (eg. German will be displayed “Deutsch”, Japanese as “日本語” etc). In “current” mode the languages are translated into the current language the user is seeing the site in (eg. if the site is displayed in German, Japanese will be displayed as “Japanisch”). “Short” mode takes the language code (eg. “en”) to display.

If the current url has no cms-page and is handled by a navigation extender and the url changes based on the language: You will need to set a language_changer function with the set_language_changer function in cms.utils.

For more information, see Internationalization.