https://github.com/django-cms/djangocms-alias

Provides collections of plugins that are managed centrally. References can be added to any placeholder.
https://github.com/django-cms/djangocms-alias
Last synced: 2 months ago
JSON representation
Provides collections of plugins that are managed centrally. References can be added to any placeholder.
Host: GitHub
URL: https://github.com/django-cms/djangocms-alias
Owner: django-cms
License: other
Created: 2018-04-06T13:31:24.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2026-05-14T06:32:11.000Z (2 months ago)
Last Synced: 2026-05-14T07:28:57.305Z (2 months ago)
Language: Python
Homepage:
Size: 993 KB
Stars: 13
Watchers: 9
Forks: 30
Open Issues: 4
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE.txt
- Security: SECURITY.md
Awesome Lists containing this project

README

          ****************

django CMS Alias

****************

|PyPiVersion| |Coverage| |DjVersion| |CmsVersion|

django CMS Alias replicates and extends the alias function of django CMS version 3 for

django CMS version 4 and later.

An alias is a collection of plugins that is managed centrally. A reference can be added to

any placeholder using the Alias plugin. Since the Alias plugin creates a reference any changes

to the alias are immediately reflected at all places it is used.

Aliases are created and edited independently of their usage through their own dedicated editing

endpoints, i.e. outside of django CMS pages. This allows content managers to maintain alias

content without needing to navigate to a page where the alias is used.

When editing a page that contains static aliases, these aliases are shown in the structure board,

providing visibility into the alias' content while maintaining the separation between alias management

and page editing. If the static alias can be changed, it is fully accessible through the structure board.

Static aliases cannot be changed in the structure board on views that have no editing interface.

django CMS Alias supports versioning aliases by django CMS Versioning.

.. warning::

    django CMS Alias 3 and later require django CMS 5.0 or later.

    Use ``djangocms-alias>=2,<3`` for django CMS 4.1.

============

Installation

============

Requirements

============

django CMS Alias requires that you have a django CMS 4 (or higher) project already running and set up.

To install

==========

Run::

    pip install djangocms-alias

Add ``djangocms_alias`` and ``parler`` to your project's ``INSTALLED_APPS``.

Run::

    python manage.py migrate djangocms_alias

to perform the application's database migrations.

=============

Configuration

=============

django CMS Alias provides several Django settings to control its behavior:

``STATIC_ALIAS_EDITING_ENABLED``

    Default: ``True``

    Controls whether static aliases can be edited directly on frontend editable objects

    (such as pages) that include the ``{% static_alias %}`` template tag. When set to ``False``,

    static aliases will not be visible in the structure board and only editable from the alias

    admin endpoint.

``VERSIONING_ALIAS_MODELS_ENABLED``

    Default: ``True`` (if djangocms-versioning is installed)

    Enables versioning support for alias models when djangocms-versioning is available. When enabled,

    aliases support draft/published workflows, version history, and proper content lifecycle management.

    Set to ``False`` to disable versioning for aliases even if djangocms-versioning is installed. Any changes

    to any alias will then be immediately visible to the world.

``MODERATING_ALIAS_MODELS_ENABLED``

    Default: ``True`` (if djangocms-moderation is installed)

    Enables moderation workflows for alias models when djangocms-moderation is available. When enabled,

    aliases can be subject to approval workflows before publication. Set to ``False`` to disable moderation

    for aliases even if djangocms-moderation is installed.

=====

Usage

=====

Static aliases

==============

Static aliases appear in templates and replace static placeholders which were part of django CMS up to version 3.x.

Example::

    {% load djangocms_alias_tags %}

    ...

    

      {% static_alias 'footer' %}

    

**New in version 3**: Static aliases can now be edited directly on any frontend

editable object (such as pages) that includes the ``{% static_alias %}``

template tag. Static aliases are marked by a pin icon in the structure board to

distinguish them from regular content.

Editing static aliases on the page provides a convenient way to manage alias

content in context. However, when using djangocms-versioning, there are important

considerations:

**Versioning Considerations:**

* **Independent Publishing**: Static aliases must be published independently from

  their edit endpoint. Use the edit entry in the alias's burger menu in the structure

  board to access the full alias editing interface.

* **Published Content Only**: When objects are viewed on the site (not in edit mode),

  only the latest published alias version is displayed. If no published version exists,

  nothing will be shown.

* **Draft Creation Required**: Published aliases cannot be edited - neither in the

  structure menu nor on their dedicated endpoint. You must create a new draft version

  of the alias before editing is possible.

This workflow ensures content consistency and proper version control while providing the flexibility to edit aliases in context when appropriate.

Alias plugin

============

Alternatively, aliases can be used with the Alias plugin. It allows to select which alias content is shown at the

exact position the alias plugin is placed.

=========

Templates

=========

For the plugin to work out of the box ``{% block content %}`` is expected to exist in your main ``base.html`` file.

Here is the template hierarchy for the edit and preview endpoints::

    base.html

        └── djangocms_alias/base.html {% block content %}

              ├── djangocms_alias//alias_content_preview.html  {% block alias_content %}

              └── djangocms_alias/alias_content_preview.html                {% block alias_content %}

For static aliases, ```` is the alias static code (or placeholder slotname when no static code is set).

django CMS Alias first tries the slot-specific preview template and falls back to

``djangocms_alias/alias_content_preview.html``.

Use Django's template override mechanism to customize these templates as needed. Say, if your base template has

a different name and the content goes into a block called ``main_content``, you would create a template at

``templates/djangocms_alias/base.html`` with the following content::

    {% extends "mybase.html" %}

    {% load i18n %}

    {% block title %}{% translate "Aliases" %}{% endblock %}

    {% block main_content %}

        


            {% block aliases_content %}

            {% endblock aliases_content %}

        

    {% endblock main_content %}

Customizing the alias preview template

======================================

When editing or previewing content managed via ``djangocms-alias`` (for example,

static aliases like headers or footers), django CMS renders the content inside

a dedicated template.

This template may extend your project's ``base.html`` template by default.

This could cause the full page layout to be displayed while editing a small piece of

content and make it difficult to focus on the alias itself.

You can override this default behaviour by supplying your own template at::

    templates/djangocms_alias/base.html

For static aliases you can also provide a slot-specific preview template at::

    templates/djangocms_alias//alias_content_preview.html

The provided template will then be used when rendering aliases in edit and preview

modes. Also, it does not need to extend your main ``base.html`` template.

However, be sure that the required CMS tags and assets are included, for example:

.. code-block:: html+django

    {% load cms_tags sekizai_tags %}

    

    

        

            {% render_block "css" %}

        

        

            {% cms_toolbar %}

            {% block content %}{% endblock %}

            {% render_block "js" %}

        

    

This helps you keep the editing interface focused on the alias content instead of

the surrounding site layout.

A note about versioning

=======================

If you enable djangocms-versioning after creating aliases, you need to run the management command

``manage.py create_versions --userid=`` to create Version objects for existing alias content.

See the `create_versions command documentation `_

for more details.

For more information about djangocms-versioning, see the `djangocms-versioning documentation `_.

.. |PyPiVersion| image:: https://img.shields.io/pypi/v/djangocms-alias.svg?style=flat-square

    :target: https://pypi.python.org/pypi/djangocms-alias

    :alt: Latest PyPI version

.. |Coverage| image:: https://codecov.io/gh/django-cms/djangocms-alias/graph/badge.svg?token=UUkVjsHGcA

    :target: https://codecov.io/gh/django-cms/djangocms-alias

    :alt: Coverage

.. |PyVersion| image:: https://img.shields.io/pypi/pyversions/djangocms-alias.svg?style=flat-square

    :target: https://pypi.python.org/pypi/djangocms-alias

    :alt: Python versions

.. |DjVersion| image:: https://img.shields.io/pypi/frameworkversions/django/djangocms-alias.svg?style=flat-square

    :target: https://pypi.python.org/pypi/djangocms-alias

    :alt: Django versions

.. |CmsVersion| image:: https://img.shields.io/pypi/frameworkversions/django-cms/djangocms-alias.svg?style=flat-square

    :target: https://pypi.python.org/pypi/djangocms-alias

    :alt: django CMS versions
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/django-cms/djangocms-alias

Awesome Lists containing this project

README
