Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add 'Configuration' section to README for moderation app settings #292

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,61 @@ Run::

to perform the application's database migrations.


Configuration
=============

The following settings can be added to your project's settings file to configure django CMS Moderation's behavior:

``CMS_MODERATION_DEFAULT_COMPLIANCE_NUMBER_BACKEND``
Default backend used for generating compliance numbers.

``CMS_MODERATION_COMPLIANCE_NUMBER_BACKENDS``
Dictionary of available compliance number backend classes.

``CMS_MODERATION_ENABLE_WORKFLOW_OVERRIDE``
Enable or disable workflow override functionality.
Default: ``False``

``CMS_MODERATION_DEFAULT_CONFIRMATION_PAGE_TEMPLATE``
Default template used for confirmation pages.

``CMS_MODERATION_CONFIRMATION_PAGE_TEMPLATES``
List of available confirmation page templates.

``CMS_MODERATION_COLLECTION_COMMENTS_ENABLED``
Enable or disable comments on collections.
Default: ``True``

``CMS_MODERATION_REQUEST_COMMENTS_ENABLED``
Enable or disable comments on moderation requests.
Default: ``True``

``CMS_MODERATION_COLLECTION_NAME_LENGTH_LIMIT``
Maximum length for collection names.
Default: ``255``

``EMAIL_NOTIFICATIONS_FAIL_SILENTLY``
Control whether email notification errors should be suppressed.
Default: ``True``

Example Configuration
---------------------

Add these settings to your project's settings file:

.. code-block:: python

# Enable workflow override
CMS_MODERATION_ENABLE_WORKFLOW_OVERRIDE = True

# Customize collection name length
CMS_MODERATION_COLLECTION_NAME_LENGTH_LIMIT = 100

# Disable comment features
CMS_MODERATION_COLLECTION_COMMENTS_ENABLED = False
CMS_MODERATION_REQUEST_COMMENTS_ENABLED = False

Documentation
=============

Expand Down
Loading