Author: jtauber
Date: Mon Oct 20 16:34:17 2008
New Revision: 115
Modified:
trunk/docs/usage.txt
Log:
improvements to doc
Modified: trunk/docs/usage.txt
==============================================================================
--- trunk/docs/usage.txt (original)
+++ trunk/docs/usage.txt Mon Oct 20 16:34:17 2008
@@ -46,14 +46,15 @@
Notification templates
======================
-There are four different templates that need to be written for the actual
content of the notices:
+There are four different templates that can to be written for the actual
content of the notices:
* ``short.txt`` is a very short, text-only version of the notice
(suitable for things like email subjects)
* ``full.txt`` is a longer, text-only version of the notice (suitable
for things like email bodies)
* ``notice.html`` is a short, html version of the notice, displayed in a
user's notice list on the website
* ``full.html`` is a long, html version of the notice (not currently
used for anything)
-Each of these should be put in a directory on the template path called
``notification/`notice_type_label`/``.
+Each of these should be put in a directory on the template path called
``notification/``notice_type_label``/``template_name.
+If any of these are missing, a default would be used. In practice,
``notice.html`` and ``full.txt`` should be provided at a minimum.
For example, ``notification/friends_invite/notice.html`` might contain::
@@ -66,6 +67,8 @@
http://{{ current_site }}{{ invitation_page }}
{% endblocktrans %}
+
+The context variables are provided when sending the notification.
Sending Notification
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"pinax-updates" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/pinax-updates?hl=en
-~----------~----~----~----~------~----~------~--~---
