Home Configuration
******************

`Django settings <https://docs.djangoproject.com/en/dev/topics/settings/>`_ can
be used to customize and control the overall look, feel, and functionality of
the **Django-AdminLTE2-PDQ** package.

All settings are listed here for reference, even though some of these settings
(such as the :doc:`../menu/general_information` and
:doc:`Authorization <../authorization/policies>`) can become quite complex,
to the point that they have dedicated documentation pages to better explain
the full extent of these settings.


----


Base Configuration
==================

ADMINLTE2_HOME_ROUTE
--------------------

Set the "Home" route for your project. This tells the package where to redirect
users when they click a link that is designed to take the user home.

:Type: ``string``
:Default: ``adminlte2_pdq:home``

Example::

    ADMINLTE2_HOME_ROUTE = 'adminlte2_pdq:home'


----


Logo & Skin Color Configuration
===============================

ADMINLTE2_LOGO_TEXT
-------------------

Set the Logo text for your site. This will be shown in the top left of the top
bar, when the sidebar is expanded.

.. note::

    If you would like to include HTML in your text, you will need to import
    and use ``mark_safe`` from ``django.utils.safestring``. Otherwise, your
    HTML will be escaped.

:Type: ``string``
:Default: ``AdminLTE``

Example::

    ADMINLTE2_LOGO_TEXT = 'My Awesome Site'


ADMINLTE2_LOGO_TEXT_SMALL
-------------------------

Set the small Logo text for your site. This will be shown in the top left of the
top bar, when the sidebar is collapsed.

.. note::

    If you would like to include HTML in your text, you will need to import
    and use ``mark_safe`` from ``django.utils.safestring``. Otherwise, your
    HTML will be escaped.

:Type: ``string``
:Default: ``ALTE``

Example::

    ADMINLTE2_LOGO_TEXT_SMALL = 'MAS'


ADMINLTE2_SKIN_CLASS
--------------------

Set the skin class to use for the site. Valid skin classes can be found on the
`AdminLTE documentation <https://adminlte.io/themes/AdminLTE/documentation/>`_
page.

:Type: ``string``
:Default: ``skin-blue``

Example::

    ADMINLTE2_SKIN_CLASS = 'skin-green-light'

