Permalink
Browse files

improvements to doc

git-svn-id: https://django-notification.googlecode.com/svn/trunk@115 590c3fc9-4838-0410-bb95-17a0c9b37ca9
  • Loading branch information...
1 parent 1c7284e commit 69937db95f7ebe56fcf3a35e9b6cabc973e40aaf @jtauber jtauber committed Oct 20, 2008
Showing with 5 additions and 2 deletions.
  1. +5 −2 docs/usage.txt
View
@@ -46,14 +46,15 @@ not installed, your app will proceed anyway.
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::
@@ -67,6 +68,8 @@ and ``notification/friends_full.txt`` might contain::
http://{{ current_site }}{{ invitation_page }}
{% endblocktrans %}
+The context variables are provided when sending the notification.
+
Sending Notification
====================

0 comments on commit 69937db

Please sign in to comment.