Metadata-Version: 2.0
Name: odoo9-addon-cms-status-message
Version: 9.0.1.0.0.99.dev2
Summary: Basic status messages for your CMS system
Home-page: UNKNOWN
Author: Camptocamp SA,Odoo Community Association (OCA)
Author-email: support@odoo-community.org
License: AGPL-3
Platform: UNKNOWN
Requires-Dist: odoo (<9.1a,>=9.0a)
Classifier: Programming Language :: Python :: 2.7
Classifier: Framework :: Odoo
Classifier: License :: OSI Approved :: GNU Affero General Public License v3

.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
   :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
   :alt: License: AGPL-3

==================
CMS status message
==================

A "status message" is an important message that you want to show to users.

For instance: a user submit a form or does a specific action
and you want to report the status of this action
like "your profile has been updated" or "Your upgrade has been successful.".

This module allows to easily display this kind of messages to your users.

Messages are displayed using Twitter bootstrap alerts.

You can add several messages: they will be displayed one after another.

Usage
=====

Set a message::

    msg = _('My important message.')
    if request.website:
        request.website.add_status_message(msg)

By default the message type is `info`.
The title (the label at the beginning of the message) matches the message type:

* 'info': 'Info'
* 'success': 'Success'
* 'danger': 'Error'
* 'warning': 'Warning'


You can change message parameters::

    msg = _('Watch out!')
    if request.website:
        request.website.add_status_message(msg, mtype='warning', mtitle='Oh no')

Messages will be displayed like this:

|preview|

Customize appereance
--------------------

By default the alert box is added on top of `<main />` content.
If you want to customize this behavior just override or disable `cms_status_message.add_status_message` template.


Bug Tracker
===========

Bugs are tracked on `GitHub Issues
<https://github.com/OCA/website-cms/issues>`_. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smashing it by providing a detailed and welcomed feedback.

Credits
=======

Images
------

* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.

Contributors
------------

* Simone Orsi <simone.orsi@camptocamp.com>

Maintainer
----------

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

To contribute to this module, please visit https://odoo-community.org.


.. |preview| image:: ./images/preview.png


