==================
Settings reference
==================

Settings are stored as class constants and therefore cannot be modified at
runtime.  For the most part, the only settings
that you will probably need to modify are :ref:`setting-css_path`, 
:ref:`setting-js_path`, and :ref:`setting-webmaster_email`.

Dates
=====

Date settings are stored in ``Pancake/Settings/Date.php``.

.. _setting-date_format:

``DATE_FORMAT``
---------------

.. attribute:: Date::DATE_FORMAT

    Format to display a date.

.. _setting-datetime_format:

``DATETIME_FORMAT``
-------------------

.. attribute:: Date::DATETIME_FORMAT

    Format to display a datetime stamp.

.. _setting-semester_regex:

``SEMESTER_REGEX``
------------------

.. attribute:: Date::SEMESTER_REGEX

    Regular expression that matches a semester and year combination.

Fields
======

Field settings are stored in ``Pancake/Settings/Fields.php``.

.. _setting-accessible_text-class:

``ACCESSIBLE_TEXT_CLASS``
-------------------------

.. attribute:: Fields::ACCESSIBLE_TEXT_CLASS

    HTML class to add to field paragraphs that contain accessible text.

.. _setting-accessible_text_html:

``ACCESSIBLE_TEXT_HTML``
------------------------

.. attribute:: Fields::ACCESSIBLE_TEXT_HTML

    Template for accessible text.

.. _setting-error_class:

``ERROR_CLASS``
---------------

.. attribute:: Fields::ERROR_CLASS

    HTML class to add to field paragraphs that do not pass validation.

.. _setting-error_html:

``ERROR_HTML``
--------------

.. attribute:: Fields::ERROR_HTML

    Template for validation error messages.

.. _setting-id_prefix:

``ID_PREFIX``
-------------

.. attribute:: Fields::ID_PREFIX

    Prefix for field IDs, e.g. "name" -> "f_name".  This helps to avoid
    IDs conflicting with other HTML elements on your webpage.

.. _setting-help_text_class:

``HELP_TEXT_CLASS``
-------------------

.. attribute:: Fields::HELP_TEXT_CLASS

    HTML class to add to field paragraphs that contain help text.

.. _setting-help_text_html:

``HELP_TEXT_HTML``
------------------

.. attribute:: Fields::HELP_TEXT_HTML

    Template for help text.

.. _setting-optional_class:

``OPTIONAL_CLASS``
------------------

.. attribute:: Fields::OPTIONAL_CLASS

    HTML class to add to field paragraphs if the field is optional.

.. _setting-optional_html:
   
``OPTIONAL_HTML``
-----------------

.. attribute:: Fields::OPTIONAL_HTML

    Template for the optional message.

.. _setting-upload_message_html:

``UPLOAD_MESSAGE_HTML``
-----------------------

.. attribute:: Fields::UPLOAD_MESSAGE_HTML

    Template for the file-already-uploaded message.

Hooks
=====

Hook settings are stored in ``Pancake/Settings/Hooks.php``.

.. _setting-confirmation_subject:

``CONFIRMATION_SUBJECT``
------------------------

.. attribute:: Fields::CONFIRMATION_SUBJECT

    Default subject for the confirmation email.

.. _setting-confirmation_message:

``CONFIRMATION_MESSAGE``
------------------------

.. attribute:: Fields::CONFIRMATION_MESSAGE

    Default message for the confirmation email.

Security
========

Security settings are stored in ``Pancake/Settings/Security.php``.

.. _setting-salt:

``SALT``
--------

.. attribute:: Fields::SALT

    CSRF protection salt.

.. _setting-spam_message:

``SPAM_MESSAGE``
----------------

.. attribute:: Fields::SPAM_MESSAGE

    Error message to display when the form has been flagged as spam.

Validation
==========

Validation settings are stored in ``Pancake/Settings/Validation.php``.

.. _setting-validation_error_html:

``ERROR_HTML``
--------------

.. attribute:: Fields::ERROR_HTML

    Template for the error-message list.

.. _setting-error_item_html:

``ERROR_ITEM_HTML``
-------------------

.. attribute:: Fields::ERROR_ITEM_HTML

    Template for each individual error in the error-message list.

.. _setting-error_item_field_html:

``ERROR_ITEM_FIELD_HTML``
-------------------------

.. attribute:: Fields::ERROR_ITEM_FIELD_HTML

    Template for each individual field-specific error in the error-message
    list.

.. _setting-success_html:

``SUCCESS_HTML``
----------------

.. attribute:: Fields::SUCCESS_HTML

    Template for the success message.

Other
=====

Miscellaneous settings are stored in ``Pancake/Settings/Other.php``.

.. _setting-css_path:

``CSS_PATH``
------------

.. attribute:: Fields::CSS_PATH

    File path to Pancake's CSS files.

.. _setting-js_path:

``JS_PATH``
-----------

.. attribute:: Fields::JS_PATH

    File path to Pancake's JavaScript files.

.. _setting-webmaster_email:

``WEBMASTER_EMAIL``
-------------------

.. attribute:: Fields::WEBMASTER_EMAIL

    Email address to which to send error messages (as a last resort
    operation).