****************
django CMS Alias
****************
|coverage| |python| |django| |djangocms4|
django CMS Alias replicates and extends the alias function of django CMS version 3 for django CMS version 4.
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.
django CMS Alias supports versioning aliases by django CMS Versioning.
.. warning::
This is the development branch for django CMS version 4.1 support.
For django CMS V4.0 support, see `support/django-cms-4.0.x branch <https://github.com/django-cms/djangocms-alias/tree/support/django-cms-4.0.x>`_
============
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 git+https://github.com/django-cms/djangocms-alias@master#egg=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.
=====
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 %}
...
<footer>
{% static_alias 'footer' %}
</footer>
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.
.. |coverage| image:: https://codecov.io/gh/django-cms/djangocms-alias/branch/master/graph/badge.svg
:target: https://codecov.io/gh/django-cms/djangocms-alias
.. |python| image:: https://img.shields.io/badge/python-3.7+-blue.svg
:target: https://pypi.org/project/djangocms-alias/
.. |django| image:: https://img.shields.io/badge/django-3.2--4.1-blue.svg
:target: https://www.djangoproject.com/
.. |djangocms4| image:: https://img.shields.io/badge/django%20CMS-4-blue.svg
:target: https://www.django-cms.org/
Side notes
============
For the plugin to work out of the box ``{% block content %}`` is expected to exist in your main ``base.html`` file.
Raw data
{
"_id": null,
"home_page": "https://github.com/django-cms/djangocms-alias",
"name": "djangocms-alias",
"maintainer": "Django CMS Association and contributors",
"docs_url": null,
"requires_python": null,
"maintainer_email": "info@django-cms.org",
"keywords": null,
"author": "Divio AG",
"author_email": "info@divio.ch",
"download_url": "https://files.pythonhosted.org/packages/6e/15/e60d2cf8b3d7e62b90882c7d3fb3a2e5aa00a8f0082fedb4068ef6fd1551/djangocms_alias-2.0.2.tar.gz",
"platform": "OS Independent",
"description": "\n\n****************\ndjango CMS Alias\n****************\n\n|coverage| |python| |django| |djangocms4|\n\ndjango CMS Alias replicates and extends the alias function of django CMS version 3 for django CMS version 4.\n\nAn 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.\n\ndjango CMS Alias supports versioning aliases by django CMS Versioning.\n\n.. warning::\n\n This is the development branch for django CMS version 4.1 support.\n\n For django CMS V4.0 support, see `support/django-cms-4.0.x branch <https://github.com/django-cms/djangocms-alias/tree/support/django-cms-4.0.x>`_\n\n\n============\nInstallation\n============\n\nRequirements\n============\n\ndjango CMS Alias requires that you have a django CMS 4 (or higher) project already running and set up.\n\n\nTo install\n==========\n\nRun::\n\n pip install git+https://github.com/django-cms/djangocms-alias@master#egg=djangocms-alias\n\nAdd ``djangocms_alias`` and ``parler`` to your project's ``INSTALLED_APPS``.\n\nRun::\n\n python manage.py migrate djangocms_alias\n\nto perform the application's database migrations.\n\n\n=====\nUsage\n=====\n\nStatic aliases\n==============\n\nStatic aliases appear in templates and replace static placeholders which were part of django CMS up to version 3.x.\n\nExample::\n\n {% load djangocms_alias_tags %}\n ...\n <footer>\n {% static_alias 'footer' %}\n </footer>\n\nAlias plugin\n============\n\nAlternatively, 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.\n\n.. |coverage| image:: https://codecov.io/gh/django-cms/djangocms-alias/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/django-cms/djangocms-alias\n\n.. |python| image:: https://img.shields.io/badge/python-3.7+-blue.svg\n :target: https://pypi.org/project/djangocms-alias/\n\n.. |django| image:: https://img.shields.io/badge/django-3.2--4.1-blue.svg\n :target: https://www.djangoproject.com/\n\n.. |djangocms4| image:: https://img.shields.io/badge/django%20CMS-4-blue.svg\n :target: https://www.django-cms.org/\n\nSide notes\n============\nFor the plugin to work out of the box ``{% block content %}`` is expected to exist in your main ``base.html`` file.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": null,
"version": "2.0.2",
"project_urls": {
"Homepage": "https://github.com/django-cms/djangocms-alias"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "30c32f35473dccf7823f9d07e710f706ed1df96a8eb6098bc728fbaaf11549c8",
"md5": "f164b27da5bfba35b80a506026dcc5ea",
"sha256": "9cbb844120715eea12838d8bff61649fc88eb036d5e039d7739a872c81107066"
},
"downloads": -1,
"filename": "djangocms_alias-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f164b27da5bfba35b80a506026dcc5ea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 89708,
"upload_time": "2025-01-16T11:39:04",
"upload_time_iso_8601": "2025-01-16T11:39:04.550898Z",
"url": "https://files.pythonhosted.org/packages/30/c3/2f35473dccf7823f9d07e710f706ed1df96a8eb6098bc728fbaaf11549c8/djangocms_alias-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6e15e60d2cf8b3d7e62b90882c7d3fb3a2e5aa00a8f0082fedb4068ef6fd1551",
"md5": "82b49240e7e165024ed27b12df96d62b",
"sha256": "10cc530a31a8ae713e7dac3d464092333c94182ac69bd9c7acba4f328dffcfd9"
},
"downloads": -1,
"filename": "djangocms_alias-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "82b49240e7e165024ed27b12df96d62b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 63634,
"upload_time": "2025-01-16T11:39:06",
"upload_time_iso_8601": "2025-01-16T11:39:06.024783Z",
"url": "https://files.pythonhosted.org/packages/6e/15/e60d2cf8b3d7e62b90882c7d3fb3a2e5aa00a8f0082fedb4068ef6fd1551/djangocms_alias-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-16 11:39:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "django-cms",
"github_project": "djangocms-alias",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "djangocms-alias"
}
JSON
