DjangoCMS Help Rating

A project for simple evaluation of DjangoCMS website content.

Install

pip install djangocms-help-rating

Add into settings.py:

INSTALLED_APPS = [
    ...
    "help_rating",
]

Add into site urls.py:

urlpatterns = [
    ...
    path('help-rating/', include(('help_rating.urls', "help_rating"))),
]

If you define a namespace other than help_rating in the urls.py, you must redefine it in settings with the value HELP_RATING_PATH_NAMESPACE. Default of HELP_RATING_PATH_NAMESPACE is "help_rating".

Customize appearance and functionality

You set the appearance with the HELP_RATING_RATINGS parameter in settings. For example:

from help_rating.constants import ScoreItem, ScoreType

HELP_RATING_RATINGS = [
    ScoreItem(ScoreType.NOT_AT_ALL.value, "no", "img/thumb-down.svg", _("No")),
    ScoreItem(ScoreType.YES.value, "yes", "img/thumb-up.svg", _("Yes")),
]

The standard question can be redefined with the HELP_RATING_MSG_QUESTION parameter in settings:

HELP_RATING_MSG_QUESTION = "Did this help you?"

The standard response can be redefined with the HELP_RATING_MSG_THANK_YOU parameter in settings:

HELP_RATING_MSG_THANK_YOU = "Thank you for the feedback!"

The Javascript function that is called when the form is successfully submitted is set by the HELP_RATING_SCRIPT_SUCCESS parameter in settings. For example:

HELP_RATING_SCRIPT_SUCCESS = "help_rating_success"

The function accepts one parameter, which is a <div class="answer"> element. For example:

window.help_rating_success = (node) => {
    const frame = node.closest('.help-rating-frame')
    ...
}

A function with the same parameter can be defined in the HELP_RATING_SCRIPT_FAILURE parameter even in case the form submission fails.

License

BSD License