[IMP] Documentation

[ADD] Translation file + french
[FIX] employee_id field does not exist
[FIX] user_email field deprecated
[IMP] Split long lines
[ADD] Images

document_page_approval/__openerp__.py

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 ##############################################################################
-#    
+#
 #    OpenERP, Open Source Management Solution
 #    Copyright (C) 2013 Savoir-faire Linux (<http://www.savoirfairelinux.com>).
 #
@@ -15,28 +15,42 @@
 #    GNU Affero General Public License for more details.
 #
 #    You should have received a copy of the GNU Affero General Public License
-#    along with this program.  If not, see <http://www.gnu.org/licenses/>.  
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 ##############################################################################
 
 {
     'name': 'Document Page Approval',
     'version': '1.0',
-    "author" : "Savoir-faire Linux",
-    "website" : "http://www.savoirfairelinux.com",
-    "license" : "AGPL-3",
+    "author": "Savoir-faire Linux",
+    "website": "http://www.savoirfairelinux.com",
+    "license": "AGPL-3",
     'category': 'Knowledge Management',
     'description': """
-Add a workflow to approve page modification and show the approved version by default
+This module adds a workflow to approve page modification and show the approved version by default.
+
+Scenario
+========
+
+* Set a valid email address on the company settings.
+* Create a new page category and set an approver group. Make sure users belonging to that group
+  have valid email addresses.
+* Create a new page and choose the previously created category.
+* A notification is sent to the group with a link to the page history to review.
+* Depending on the review, the page history is approved or not.
+* Users reading the page see the last approved version.
     """,
-    'depends': ['document_page', 'email_template'],
-    'update_xml': ['document_page_wkfl.xml','document_page_view.xml'],
-    'installable': True,
-    'auto_install': False,
-    'images': [],
+    'depends': [
+        'document_page',
+        'email_template',
+        ],
     'data': [
+        'document_page_wkfl.xml',
+        'document_page_view.xml',
         'security/document_page_security.xml',
         'security/ir.model.access.csv',
-        ]
+        ],
+    'installable': True,
+    'auto_install': False,
+    'images': ['images/category.png', 'images/page_history_list.png', 'images/page_history.png'],
 }
-# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: