From cf6d317824b520540f1728360bcae2204c7ad1e7 Mon Sep 17 00:00:00 2001
From: mathieui <mathieui@mathieui.net>
Date: Thu, 20 Jun 2013 23:30:47 +0200
Subject: Add a documentation page for PEP (and update some commands)

---
 doc/source/commands.rst             | 22 +++++++++++
 doc/source/misc/index.rst           |  1 +
 doc/source/misc/personal_events.rst | 74 +++++++++++++++++++++++++++++++++++++
 3 files changed, 97 insertions(+)
 create mode 100644 doc/source/misc/personal_events.rst

diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index ad8eb7d0..02f044a8 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -190,6 +190,28 @@ These commands work in *any* tab.
         Show the pending invitations.
 
     /activity
+        **Usage:** ``/activity [<general> [specific] [comment]]``
+
+        Send your current activity to your contacts (use the completion to cycle
+        through all the general and specific possible activities).
+
+        Nothing means "stop broadcasting an activity".
+
+    /mood
+        **Usage:** ``/mood [<mood> [comment]]``
+        Send your current mood to your contacts (use the completion to cycle
+        through all the possible moods).
+
+        Nothing means "stop broadcasting a mood".
+
+    /gaming
+        **Usage:** ``/gaming [<game name> [server address]]``
+
+        Send your current gaming activity to your contacts.
+
+        Nothing means "stop broadcasting a gaming activity".
+
+    /last_activity
         **Usage:** ``/activity <jid>``
 
         Show the last activity of a contact or a server (its
diff --git a/doc/source/misc/index.rst b/doc/source/misc/index.rst
index 713459de..182f35c3 100644
--- a/doc/source/misc/index.rst
+++ b/doc/source/misc/index.rst
@@ -8,6 +8,7 @@ Contents:
 
     carbons
     correct
+    personal_events
     separate
     ssl
 
diff --git a/doc/source/misc/personal_events.rst b/doc/source/misc/personal_events.rst
new file mode 100644
index 00000000..37a388ad
--- /dev/null
+++ b/doc/source/misc/personal_events.rst
@@ -0,0 +1,74 @@
+Personal Events
+===============
+
+Starting from poezio 0.8, poezo now supports `user mood`_, `user activity`_,
+`user tune`_, and `user gaming`_.
+
+Those extensions are standardized ways to broadcast informations that might be
+useful to your contacts (they will receive those informations only if they
+have indicated their interest in them).
+
+You can see below the list of the related options and commands.
+
+.. note::
+
+    All the *display_foo_notifications* options can be tab-specific, so you
+    can display those notifications only for a specific contact, or the
+    other way around.
+
+
+User Mood
+~~~~~~~~~
+
+Options:
+
+- :term:`enable_user_mood`
+- :term:`display_mood_notifications`
+
+Commands:
+
+- :term:`/mood`
+
+User Activity
+~~~~~~~~~~~~~
+
+Options:
+
+- :term:`enable_user_activity`
+- :term:`display_activity_notifications`
+
+Commands:
+
+- :term:`/activity`
+
+User Gaming
+~~~~~~~~~~~
+
+Options:
+
+- :term:`enable_user_gaming`
+- :term:`display_gaming_notifications`
+
+Commands:
+
+- :term:`/gaming`
+
+User Tune
+~~~~~~~~~
+
+Options:
+
+- :term:`enable_user_tune`
+- :term:`display_tune_notifications`
+
+.. note::
+
+    There is no /tune command because it wouldn’t be really useful.
+    There was originally a way to broadcast the current tune with the
+    mpd plugin, but it was no good. You should use an external script
+    to do that, or use a player that has the feature.
+
+.. _user mood: http://xmpp.org/extensions/xep-0107.html
+.. _user tune: http://xmpp.org/extensions/xep-0118.html
+.. _user gaming: http://xmpp.org/extensions/xep-0197.html
+.. _user activity: http://xmpp.org/extensions/xep-0108.html
-- 
cgit v1.2.3