diff --git a/web_notify/README.rst b/web_notify/README.rst index fd96afc8b2c1..da426a0e9316 100644 --- a/web_notify/README.rst +++ b/web_notify/README.rst @@ -17,27 +17,28 @@ Web Notify :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :alt: License: AGPL-3 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github - :target: https://github.com/OCA/web/tree/16.0/web_notify + :target: https://github.com/OCA/web/tree/17.0/web_notify :alt: OCA/web .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png - :target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_notify + :target: https://translation.odoo-community.org/projects/web-17-0/web-17-0-web_notify :alt: Translate me on Weblate .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png - :target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=16.0 + :target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=17.0 :alt: Try me on Runboat |badge1| |badge2| |badge3| |badge4| |badge5| Send instant notification messages to the user in live. -This technical module allows you to send instant notification messages from the server to the user in live. -Two kinds of notification are supported. +This technical module allows you to send instant notification messages +from the server to the user in live. Two kinds of notification are +supported. -* Success: Displayed in a `success` theme color flying popup div -* Danger: Displayed in a `danger` theme color flying popup div -* Warning: Displayed in a `warning` theme color flying popup div -* Information: Displayed in a `info` theme color flying popup div -* Default: Displayed in a `default` theme color flying popup div +- Success: Displayed in a success theme color flying popup div +- Danger: Displayed in a danger theme color flying popup div +- Warning: Displayed in a warning theme color flying popup div +- Information: Displayed in a info theme color flying popup div +- Default: Displayed in a default theme color flying popup div **Table of contents** @@ -47,52 +48,54 @@ Two kinds of notification are supported. Installation ============ -This module is based on the Instant Messaging Bus. To work properly, the server must be launched in gevent mode. +This module is based on the Instant Messaging Bus. To work properly, the +server must be launched in gevent mode. Usage ===== +To send a notification to the user you just need to call one of the new +methods defined on res.users: -To send a notification to the user you just need to call one of the new methods defined on res.users: - -.. code-block:: python +.. code:: python self.env.user.notify_success(message='My success message') or -.. code-block:: python +.. code:: python self.env.user.notify_danger(message='My danger message') or -.. code-block:: python +.. code:: python self.env.user.notify_warning(message='My warning message') or -.. code-block:: python +.. code:: python self.env.user.notify_info(message='My information message') or -.. code-block:: python +.. code:: python self.env.user.notify_default(message='My default message') -.. figure:: https://raw.githubusercontent.com/OCA/web/16.0/web_notify/static/description/notifications_screenshot.gif - :scale: 80 % - :alt: Sample notifications +|image1| + +You can test the behaviour of the notifications by installing this +module in a demo database. Access the users form through Settings -> +Users & Companies. You'll see a tab called "Test web notify", here +you'll find two buttons that'll allow you test the module. -You can test the behaviour of the notifications by installing this module in a demo database. -Access the users form through Settings -> Users & Companies. You'll see a tab called "Test web notify", here you'll find two buttons that'll allow you test the module. +|image2| -.. figure:: https://raw.githubusercontent.com/OCA/web/16.0/web_notify/static/description/test_notifications_demo.png - :scale: 80 % - :alt: Sample notifications +.. |image1| image:: https://raw.githubusercontent.com/OCA/web/17.0/web_notify/static/description/notifications_screenshot.gif +.. |image2| image:: https://raw.githubusercontent.com/OCA/web/17.0/web_notify/static/description/test_notifications_demo.png Bug Tracker =========== @@ -100,7 +103,7 @@ Bug Tracker Bugs are tracked on `GitHub Issues `_. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed -`feedback `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -108,25 +111,25 @@ Credits ======= Authors -~~~~~~~ +------- * ACSONE SA/NV * AdaptiveCity Contributors -~~~~~~~~~~~~ +------------ -* Laurent Mignon -* Serpent Consulting Services Pvt. Ltd. -* Aitor Bouzas -* Shepilov Vladislav -* Kevin Khao -* `Tecnativa `_: +- Laurent Mignon +- Serpent Consulting Services Pvt. Ltd. +- Aitor Bouzas +- Shepilov Vladislav +- Kevin Khao +- `Tecnativa `__: - * David Vidal + - David Vidal Maintainers -~~~~~~~~~~~ +----------- This module is maintained by the OCA. @@ -138,6 +141,6 @@ 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. -This module is part of the `OCA/web `_ project on GitHub. +This module is part of the `OCA/web `_ project on GitHub. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/web_notify/__manifest__.py b/web_notify/__manifest__.py index 69b35556c686..0275191f28d2 100644 --- a/web_notify/__manifest__.py +++ b/web_notify/__manifest__.py @@ -6,7 +6,7 @@ "name": "Web Notify", "summary": """ Send notification messages to user""", - "version": "16.0.1.0.1", + "version": "17.0.1.0.0", "license": "AGPL-3", "author": "ACSONE SA/NV," "AdaptiveCity," "Odoo Community Association (OCA)", "development_status": "Production/Stable", diff --git a/web_notify/readme/CONTRIBUTORS.rst b/web_notify/readme/CONTRIBUTORS.rst deleted file mode 100644 index 77bb03c5e9dd..000000000000 --- a/web_notify/readme/CONTRIBUTORS.rst +++ /dev/null @@ -1,8 +0,0 @@ -* Laurent Mignon -* Serpent Consulting Services Pvt. Ltd. -* Aitor Bouzas -* Shepilov Vladislav -* Kevin Khao -* `Tecnativa `_: - - * David Vidal diff --git a/web_notify/readme/DESCRIPTION.rst b/web_notify/readme/DESCRIPTION.rst deleted file mode 100644 index 2cd89780128e..000000000000 --- a/web_notify/readme/DESCRIPTION.rst +++ /dev/null @@ -1,10 +0,0 @@ -Send instant notification messages to the user in live. - -This technical module allows you to send instant notification messages from the server to the user in live. -Two kinds of notification are supported. - -* Success: Displayed in a `success` theme color flying popup div -* Danger: Displayed in a `danger` theme color flying popup div -* Warning: Displayed in a `warning` theme color flying popup div -* Information: Displayed in a `info` theme color flying popup div -* Default: Displayed in a `default` theme color flying popup div diff --git a/web_notify/readme/INSTALL.rst b/web_notify/readme/INSTALL.rst deleted file mode 100644 index b47aebb79eb8..000000000000 --- a/web_notify/readme/INSTALL.rst +++ /dev/null @@ -1 +0,0 @@ -This module is based on the Instant Messaging Bus. To work properly, the server must be launched in gevent mode. diff --git a/web_notify/readme/USAGE.rst b/web_notify/readme/USAGE.rst deleted file mode 100644 index f31a5341fefa..000000000000 --- a/web_notify/readme/USAGE.rst +++ /dev/null @@ -1,41 +0,0 @@ - -To send a notification to the user you just need to call one of the new methods defined on res.users: - -.. code-block:: python - - self.env.user.notify_success(message='My success message') - -or - -.. code-block:: python - - self.env.user.notify_danger(message='My danger message') - -or - -.. code-block:: python - - self.env.user.notify_warning(message='My warning message') - -or - -.. code-block:: python - - self.env.user.notify_info(message='My information message') - -or - -.. code-block:: python - - self.env.user.notify_default(message='My default message') - -.. figure:: static/description/notifications_screenshot.gif - :scale: 80 % - :alt: Sample notifications - -You can test the behaviour of the notifications by installing this module in a demo database. -Access the users form through Settings -> Users & Companies. You'll see a tab called "Test web notify", here you'll find two buttons that'll allow you test the module. - -.. figure:: static/description/test_notifications_demo.png - :scale: 80 % - :alt: Sample notifications diff --git a/web_notify/static/description/index.html b/web_notify/static/description/index.html index d7700112dc6d..0de9cf6a9658 100644 --- a/web_notify/static/description/index.html +++ b/web_notify/static/description/index.html @@ -369,16 +369,17 @@

Web Notify

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! source digest: sha256:4517d4a854a8c5b84197dc9510ae75ac0fa82ce2a37a3a0d4078ea51a65c073f !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

Production/Stable License: AGPL-3 OCA/web Translate me on Weblate Try me on Runboat

+

Production/Stable License: AGPL-3 OCA/web Translate me on Weblate Try me on Runboat

Send instant notification messages to the user in live.

-

This technical module allows you to send instant notification messages from the server to the user in live. -Two kinds of notification are supported.

+

This technical module allows you to send instant notification messages +from the server to the user in live. Two kinds of notification are +supported.

    -
  • Success: Displayed in a success theme color flying popup div
    • -
  • Danger: Displayed in a danger theme color flying popup div
    • -
  • Warning: Displayed in a warning theme color flying popup div
    • -
  • Information: Displayed in a info theme color flying popup div
    • -
  • Default: Displayed in a default theme color flying popup div
    • +
  • Success: Displayed in a success theme color flying popup div
    • +
  • Danger: Displayed in a danger theme color flying popup div
    • +
  • Warning: Displayed in a warning theme color flying popup div
    • +
  • Information: Displayed in a info theme color flying popup div
    • +
  • Default: Displayed in a default theme color flying popup div

Table of contents

@@ -396,11 +397,13 @@

Web Notify

Installation

-

This module is based on the Instant Messaging Bus. To work properly, the server must be launched in gevent mode.

+

This module is based on the Instant Messaging Bus. To work properly, the +server must be launched in gevent mode.

Usage

-

To send a notification to the user you just need to call one of the new methods defined on res.users:

+

To send a notification to the user you just need to call one of the new +methods defined on res.users:

 self.env.user.notify_success(message='My success message')
@@ -420,21 +423,19 @@

Usage

 self.env.user.notify_default(message='My default message')
-
-Sample notifications -
-

You can test the behaviour of the notifications by installing this module in a demo database. -Access the users form through Settings -> Users & Companies. You’ll see a tab called “Test web notify”, here you’ll find two buttons that’ll allow you test the module.

-
-Sample notifications -
+

image1

+

You can test the behaviour of the notifications by installing this +module in a demo database. Access the users form through Settings -> +Users & Companies. You’ll see a tab called “Test web notify”, here +you’ll find two buttons that’ll allow you test the module.

+

image2

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed -feedback.

+feedback.

Do not contact contributors directly about support or help with technical issues.

@@ -467,7 +468,7 @@

Maintainers

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.

-

This module is part of the OCA/web project on GitHub.

+

This module is part of the OCA/web project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.