Changes between Version 15 and Version 16 of SessionMessages

Timestamp:

Oct 10, 2009, 11:52:12 AM (16 years ago)

Author:

Tobias McNulty

Comment:

add API for django-notify

SessionMessages

@@ -54 +54 @@
 
 Please update this table with new options or corrected information as necessary.
+
+== Potential API ==
+django-notify is the current front-runner in terms of technical features so a sampling of the potential API is included below.  Feel free to include the API(s) of other solutions as well for comparison.  Discussion of the API should take place on the [http://groups.google.com/group/django-developers/browse_thread/thread/eba93088c649022b django-developers list].
+
+=== django-notify ===
+Add the middleware to your MIDDLEWARE_CLASSES setting (after !SessionMiddleware):
+{{{
+    'django_notify.middleware.NotificationsMiddleware',
+}}}
+
+Add the context processor into your TEMPLATE_CONTEXT_PROCESSORS setting:
+{{{
+    'django_notify.context_processors.notifications',
+}}}
+
+Add a temporary notification message like this:
+{{{
+    request.notifications.add('Hello world.')
+    # You can optionally provide a string containing tags (which is usually represented as HTML classes for the message).
+    request.notifications.add('Your rating is over 9000!', 'error')
+}}}
+
+Use notifications in your template:
+{{{
+{% if notifications %}
+<ul class="notifications">
+        {% for message in notifications %}
+        <li{% if message.tags %} class="{{ message.tags }}"{% endif %}>{{ message }}</li>
+        {% endfor %}
+</ul>
+{% endif %}
+}}}