mirror of
https://github.com/wagtail/wagtail.git
synced 2024-12-01 11:41:20 +01:00
7523d7f57f
Concatinating with settings.STATIC_URL is no longer reccomended for creating
URLs to static resources, because it doesn't take the configured storage engine
into account. For example, a site using S3 to store its static files will need
static URLs that link out to S3, rather than relative URLs within the same
domain.
I replaced it with django.contrib.staticfiles.templatetags.staticfiles.static()
in python example code, and the {% static %} tag in template examples.
77 lines
2.9 KiB
ReStructuredText
77 lines
2.9 KiB
ReStructuredText
.. _custom_branding:
|
|
|
|
Custom branding
|
|
===============
|
|
|
|
In your projects with Wagtail, you may wish to replace elements such as the Wagtail logo within the admin interface with your own branding. This can be done through Django's template inheritance mechanism, along with the `django-overextends <https://github.com/stephenmcd/django-overextends>`_ package.
|
|
|
|
Install ``django-overextends`` with ``pip install django-overextends`` (or add ``django-overextends`` to your project's requirements file), and add ``'overextends'`` to your project's ``INSTALLED_APPS``. You now need to create a ``templates/wagtailadmin/`` folder within one of your apps - this may be an existing one, or a new one created for this purpose, for example, ``dashboard``. This app must be registered in ``INSTALLED_APPS`` before ``wagtail.wagtailadmin``::
|
|
|
|
INSTALLED_APPS = (
|
|
# ...
|
|
|
|
'overextends',
|
|
'dashboard',
|
|
|
|
'wagtail.wagtailcore',
|
|
'wagtail.wagtailadmin',
|
|
|
|
# ...
|
|
)
|
|
|
|
# For Django 1.9+ you must also add overextends to the builtins key of your TEMPLATES setting:
|
|
TEMPLATES = [
|
|
{
|
|
'BACKEND': 'django.template.backends.django.DjangoTemplates',
|
|
'APP_DIRS': True,
|
|
'OPTIONS': {
|
|
# ...
|
|
'builtins': ['overextends.templatetags.overextends_tags'],
|
|
}
|
|
},
|
|
]
|
|
|
|
The template blocks that are available to be overridden are as follows:
|
|
|
|
``branding_logo``
|
|
-----------------
|
|
|
|
To replace the default logo, create a template file ``dashboard/templates/wagtailadmin/base.html`` that overrides the block ``branding_logo``::
|
|
|
|
{% overextends "wagtailadmin/base.html" %}
|
|
{% load staticfiles %}
|
|
|
|
{% block branding_logo %}
|
|
<img src="{% static 'images/custom-logo.svg' %}" alt="Custom Project" width="80" />
|
|
{% endblock %}
|
|
|
|
``branding_favicon``
|
|
--------------------
|
|
|
|
To replace the favicon displayed when viewing admin pages, create a template file ``dashboard/templates/wagtailadmin/admin_base.html`` that overrides the block ``branding_favicon``::
|
|
|
|
{% overextends "wagtailadmin/admin_base.html" %}
|
|
{% load staticfiles %}
|
|
|
|
{% block branding_favicon %}
|
|
<link rel="shortcut icon" href="{% static 'images/favicon.ico' %}" />
|
|
{% endblock %}
|
|
|
|
``branding_login``
|
|
------------------
|
|
|
|
To replace the login message, create a template file ``dashboard/templates/wagtailadmin/login.html`` that overrides the block ``branding_login``::
|
|
|
|
{% overextends "wagtailadmin/login.html" %}
|
|
|
|
{% block branding_login %}Sign in to Frank's Site{% endblock %}
|
|
|
|
``branding_welcome``
|
|
--------------------
|
|
|
|
To replace the welcome message on the dashboard, create a template file ``dashboard/templates/wagtailadmin/home.html`` that overrides the block ``branding_welcome``::
|
|
|
|
{% overextends "wagtailadmin/home.html" %}
|
|
|
|
{% block branding_welcome %}Welcome to Frank's Site{% endblock %}
|