Repository :
http://git.fedorahosted.org/cgit/fedocal.git
On branch : master
---------------------------------------------------------------
commit fefc2cd38211233bc1337e23acdcff0bf4988e1b
Author: Pierre-Yves Chibon <pingou(a)pingoured.fr>
Date: Wed Nov 14 10:52:22 2012 +0100
Add some documentation about the reminders
---------------------------------------------------------------
doc/usage.rst | 32 ++++++++++++++++++++++++++++++++
1 files changed, 32 insertions(+), 0 deletions(-)
diff --git a/doc/usage.rst b/doc/usage.rst
index 087d77a..bcd6454 100644
--- a/doc/usage.rst
+++ b/doc/usage.rst
@@ -124,5 +124,37 @@ This iCal is read-only and can be found at::
Reminders
---------
+When creating a meeting you can set the option to send a reminder. You will be
+asked for:
+
+- ``when`` to send the reminder
+- ``who`` to send the reminder to
+
+The reminder is sent in the name of the person who created the meeting.
+
+.. note:: when sending the reminder to a mailing-list, make sure that the
+ person that created the meeting is registered to the list in order
+ for the reminder to be allowed.
+
+The reminder will be formated as such:
+
+subject:
+
+::
+
+ [Fedocal] Reminder meeting : <meeting name>
+
+
+content:
+
+::
+
+ Dear all,
+
+ You are kindly invited to the meeting :
+ <meeting name> on <meetin date> from <starting time> to <ending
time>
+
+ The meeting will be about:
+ <meeting description>