From 0912faef4c4a122bcb3f4b48050e44cf7ef903c3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thibault=20Delavall=C3=A9e?= <tde@openerp.com>
Date: Mon, 16 Apr 2012 10:18:05 +0200
Subject: [PATCH] [DOC] Small doc update.

bzr revid: tde@openerp.com-20120416081805-wz85d6sxd90n472b
---
 addons/mail/doc/index.rst         | 10 ++++++++--
 addons/mail/doc/index.rst.inc     |  3 ++-
 addons/mail/doc/mail_thread.rst   |  1 +
 addons/mail/static/src/js/mail.js |  6 +++++-
 4 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/addons/mail/doc/index.rst b/addons/mail/doc/index.rst
index b9217c42443..033b1241af6 100644
--- a/addons/mail/doc/index.rst
+++ b/addons/mail/doc/index.rst
@@ -1,6 +1,12 @@
-:orphan:
-
 Mail module documentation
 =========================
 
+The Mail module holds all models and logic related to messages management. At low-level, it handles messages and offers an API to message queues for email sending. At an higher level, it provides the OpenChatter feature that is a thread management system inside OpenERP. A model that inherits from the mail module adds OpenChatter to its document. Its gives them the following capabilities :
+
+ - messages management with a threaded design
+ - subscription mechanism tha allow users to follow/unfollow documents
+ - notifications mechanism; notifications are pushed to users to form a Wall page holding the latest pushed messages
+
+The mail module also comes with an email composition wizard, along with discussion groups.
+
 .. include:: index.rst.inc
diff --git a/addons/mail/doc/index.rst.inc b/addons/mail/doc/index.rst.inc
index 700c91c7d4f..6816b756759 100644
--- a/addons/mail/doc/index.rst.inc
+++ b/addons/mail/doc/index.rst.inc
@@ -4,5 +4,6 @@ Mail Module
 
 .. toctree::
    :maxdepth: 1
-
+   
+   mail_message
    mail_thread
diff --git a/addons/mail/doc/mail_thread.rst b/addons/mail/doc/mail_thread.rst
index f21d66da295..fd596c06689 100644
--- a/addons/mail/doc/mail_thread.rst
+++ b/addons/mail/doc/mail_thread.rst
@@ -10,6 +10,7 @@ mail.group
 
 A mail_group is a collection of users sharing messages in a discussion group. Group users are users that follow the mail group, using the subscription/follow mechanism of OpenSocial. A mail group has nothing in common wih res.users.group.
 Additional information on fields:
+
  - ``member_ids``: user member of the groups are calculated with ``message_get_subscribers`` method from mail.thread
  - ``member_count``: calculated with member_ids
  - ``is_subscriber``: calculated with member_ids
diff --git a/addons/mail/static/src/js/mail.js b/addons/mail/static/src/js/mail.js
index c29b81fc097..326225b6b24 100644
--- a/addons/mail/static/src/js/mail.js
+++ b/addons/mail/static/src/js/mail.js
@@ -388,6 +388,11 @@ openerp.mail = function(session) {
             return this.fetch_comments(this.params.limit, this.params.offset, domain);
         },
         
+        /**
+         *
+         * var regex_login = new RegExp(/(^|\s)@((\w|@|\.)*)/g);
+         * var regex_intlink = new RegExp(/(^|\s)#(\w*[a-zA-Z_]+\w*)\.(\w+[a-zA-Z_]+\w*),(\w+)/g);
+         */
         do_replace_internal_links: function (string) {
             var self = this;
             var icon_list = ['al', 'pinky']
@@ -427,7 +432,6 @@ openerp.mail = function(session) {
         
         /**
          *
-         * var regex_login = new RegExp(/(^|\s)@(\w*[a-zA-Z_.]+\w*\s)/g);
          * var regex_login = new RegExp(/(^|\s)@((\w|@|\.)*)/g);
          * var regex_intlink = new RegExp(/(^|\s)#(\w*[a-zA-Z_]+\w*)\.(\w+[a-zA-Z_]+\w*),(\w+)/g);
          */