mirror of
https://github.com/jazzband/django-analytical.git
synced 2026-05-21 05:21:59 +00:00
Add message customization to Olark
This commit is contained in:
Joost Cassee
parent
ae89a6965c
commit
a4f41ee004
3 changed files with 159 additions and 4 deletions
|
|
@ -23,7 +23,15 @@ NICKNAME_CODE = "olark('api.chat.updateVisitorNickname', {snippet: '%s'});"
|
|||
NICKNAME_CONTEXT_KEY = 'olark_nickname'
|
||||
STATUS_CODE = "olark('api.chat.updateVisitorStatus', {snippet: %s});"
|
||||
STATUS_CONTEXT_KEY = 'olark_status'
|
||||
|
||||
MESSAGE_CODE = "olark.configure('locale.%(key)s', \"%(msg)s\");"
|
||||
MESSAGE_KEYS = set(["welcome_title", "chatting_title", "unavailable_title",
|
||||
"busy_title", "away_message", "loading_title", "welcome_message",
|
||||
"busy_message", "chat_input_text", "name_input_text",
|
||||
"email_input_text", "offline_note_message", "send_button_text",
|
||||
"offline_note_thankyou_text", "offline_note_error_text",
|
||||
"offline_note_sending_text", "operator_is_typing_text",
|
||||
"operator_has_stopped_typing_text", "introduction_error_text",
|
||||
"introduction_messages", "introduction_submit_button_text"])
|
||||
|
||||
register = Library()
|
||||
|
||||
|
|
@ -59,6 +67,7 @@ class OlarkNode(Node):
|
|||
simplejson.dumps(context[STATUS_CONTEXT_KEY]))
|
||||
except KeyError:
|
||||
pass
|
||||
extra_code.extend(self._get_configuration(context))
|
||||
html = SETUP_CODE % {'site_id': self.site_id,
|
||||
'extra_code': " ".join(extra_code)}
|
||||
return html
|
||||
|
|
@ -70,6 +79,16 @@ class OlarkNode(Node):
|
|||
else:
|
||||
return user.username
|
||||
|
||||
def _get_configuration(self, context):
|
||||
code = []
|
||||
for dict_ in context:
|
||||
for var, val in dict_.items():
|
||||
if var.startswith('olark_'):
|
||||
key = var[6:]
|
||||
if key in MESSAGE_KEYS:
|
||||
code.append(MESSAGE_CODE % {'key': key, 'msg': val})
|
||||
return code
|
||||
|
||||
|
||||
def contribute_to_analytical(add_node):
|
||||
OlarkNode() # ensure properly configured
|
||||
|
|
|
|||
|
|
@ -57,3 +57,33 @@ class OlarkTestCase(TagTestCase):
|
|||
['teststatus1', 'teststatus2']}))
|
||||
self.assertTrue("olark('api.chat.updateVisitorStatus', "
|
||||
'{snippet: ["teststatus1", "teststatus2"]});' in r, r)
|
||||
|
||||
def test_messages(self):
|
||||
messages = [
|
||||
"welcome_title",
|
||||
"chatting_title",
|
||||
"unavailable_title",
|
||||
"busy_title",
|
||||
"away_message",
|
||||
"loading_title",
|
||||
"welcome_message",
|
||||
"busy_message",
|
||||
"chat_input_text",
|
||||
"name_input_text",
|
||||
"email_input_text",
|
||||
"offline_note_message",
|
||||
"send_button_text",
|
||||
"offline_note_thankyou_text",
|
||||
"offline_note_error_text",
|
||||
"offline_note_sending_text",
|
||||
"operator_is_typing_text",
|
||||
"operator_has_stopped_typing_text",
|
||||
"introduction_error_text",
|
||||
"introduction_messages",
|
||||
"introduction_submit_button_text",
|
||||
]
|
||||
vars = dict(('olark_%s' % m, m) for m in messages)
|
||||
r = OlarkNode().render(Context(vars))
|
||||
for m in messages:
|
||||
self.assertTrue("olark.configure('locale.%s', \"%s\");" % (m, m)
|
||||
in r, r)
|
||||
|
|
|
|||
|
|
@ -43,8 +43,9 @@ Configuration
|
|||
=============
|
||||
|
||||
Before you can use the Olark integration, you must first set your site
|
||||
ID. You can also customize the visitor nickname and add information to
|
||||
their status in the operator buddy list.
|
||||
ID. You can customize the visitor nickname and add information to their
|
||||
status in the operator buddy list, and customize the text used in the
|
||||
chat window.
|
||||
|
||||
|
||||
Setting the site ID
|
||||
|
|
@ -65,7 +66,7 @@ If you do not set the site ID, the chat window will not be rendered.
|
|||
Setting the visitor nickname
|
||||
----------------------------
|
||||
|
||||
If your websites identifies visitors, you can use that to set their
|
||||
If your website identifies visitors, you can use that to set their
|
||||
nickname in the operator buddy list. By default, the name and username
|
||||
of an authenticated user are automatically used to set the nickname.
|
||||
See :ref:`identifying-visitors`.
|
||||
|
|
@ -117,6 +118,111 @@ documentation.
|
|||
|
||||
.. _`api.chat.updateVisitorStatus`: http://www.olark.com/documentation/javascript/api.chat.updateVisitorStatus
|
||||
|
||||
|
||||
Customizing the chat window messages
|
||||
------------------------------------
|
||||
|
||||
Olark lets you customize the appearance of the Chat window by changing
|
||||
location, colors and messages text. While you can configure these on
|
||||
the Olark website, sometimes one set of messages is not enough. For
|
||||
example, if you want to localize your website, you want to address every
|
||||
visitor in their own language. Olark allows you to set the messages on
|
||||
a per-page basis, and the :ttag:`olark` tag supports this feature by way
|
||||
of the following context variables:
|
||||
|
||||
========================================== =============================
|
||||
Context variable Example message
|
||||
========================================== =============================
|
||||
``olark_welcome_title`` Click to Chat
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_chatting_title`` Live Help: Now Chatting
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_unavailable_title`` Live Help: Offline
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_busy_title`` Live Help: Busy
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_away_message`` Our live support feature is
|
||||
currently offline, Please
|
||||
try again later.
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_loading_title`` Loading Olark...
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_welcome_message`` Welcome to my website. You
|
||||
can use this chat window to
|
||||
chat with me.
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_busy_message`` All of our representatives
|
||||
are with other customers at
|
||||
this time. We will be with
|
||||
you shortly.
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_chat_input_text`` Type here and hit to chat
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_name_input_text`` and type your Name
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_email_input_text`` and type your Email
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_offline_note_message`` We are offline, send us a
|
||||
message
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_send_button_text`` Send
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_offline_note_thankyou_text`` Thank you for your message.
|
||||
We will get back to you as
|
||||
soon as we can.
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_offline_note_error_text`` You must complete all fields
|
||||
and specify a valid email
|
||||
address
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_offline_note_sending_text`` Sending...
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_operator_is_typing_text`` is typing...
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_operator_has_stopped_typing_text`` has stopped typing
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_introduction_error_text`` Please leave a name and email
|
||||
address so we can contact you
|
||||
in case we get disconnected
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_introduction_messages`` Welcome, just fill out some
|
||||
brief information and click
|
||||
'Start chat' to talk to us
|
||||
------------------------------------------ -----------------------------
|
||||
``olark_introduction_submit_button_text`` Start chat
|
||||
========================================== =============================
|
||||
|
||||
As an example, you could set the texts site-wide base on the current
|
||||
language using a context processor that you add to the
|
||||
:data:`TEMPLATE_CONTEXT_PROCESSORS` list in :file:`settings.py`::
|
||||
|
||||
OLARK_TEXTS = {
|
||||
'en': {
|
||||
'welcome title': "Click for Live Help",
|
||||
'chatting_title': "Live Help: Now chatting",
|
||||
...
|
||||
},
|
||||
'nl': {
|
||||
'welcome title': "Klik voor online hulp",
|
||||
'chatting_title': "Online hulp: in gesprek",
|
||||
...
|
||||
},
|
||||
...
|
||||
}
|
||||
|
||||
def set_olark_texts(request):
|
||||
lang = request.LANGUAGE_CODE.split('-', 1)[0]
|
||||
texts = OLARK_TEXTS.get(lang)
|
||||
if texts is None:
|
||||
texts = OLARK_TEXTS.get('en')
|
||||
return dict(('olark_%s' % k, v) for k, v in texts.items())
|
||||
|
||||
|
||||
See also the Olark blog post on `supporting multiple languages`_.
|
||||
|
||||
.. _`supporting multiple languages`: http://www.olark.com/blog/2010/olark-in-your-favorite-language/
|
||||
|
||||
|
||||
----
|
||||
|
||||
Thanks go to Olark for their support with the development of this
|
||||
|
|
|
|||
Loading…
Reference in a new issue