============
Announcement
============
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:d4a1cef7f9eb1c77270b3b0fe3027b94881ac7908ce458b3392f8ca09b698602
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--ux-lightgray.png?logo=github
:target: https://github.com/OCA/server-ux/tree/17.0/announcement
:alt: OCA/server-ux
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/server-ux-17-0/server-ux-17-0-announcement
: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/server-ux&target_branch=17.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
This module adds popup announcements in the backend for targeted
internal users. Those announcements can contain rich format and a user
read log is kept for everyone.
**Table of contents**
.. contents::
:local:
Configuration
=============
To create new announcements a user should be in the *Announcements
Managers* group. When your user has such permissions, this is the way to
create an announcement:
1. Go to *Discuss > Announcements*
2. Create a new one and define a title. This title will be shown in the
announcement header.
3. Define the announcement scope:
- Specific users: manually select which users will see the
announcement.
- User groups: users from the selected groups will be the ones to
see the announcement.
4. Define the announcement body. You can use rich formatting and event
paste your own html (editor in debug mode).
5. By default, the announcement will be archived. This is to prevent the
announcement to show up before time.
6. Once the announcement is ready, unarchive it going to the *Actions*
menu an choosing the *Unarchive* option.
7. Optionally you can set an announcement date to schedule the
announcement. The announcement won't show up until that date.
8. If the announcement doesn't make sense once a date is passed, you can
set a due date. From that date, the announcement won't be shown to
anyone.
Usage
=====
When a user in the scope of active announcements logs in, those will
popup. The user has to mark them as read to continue working. If the
announcement is set during the user session, the announcement will be
eventually prompted in the top bar on the right part. The user click on
the unread announcements icon (a speaker) and the announcements will
popup for the user to check them.
Users can go *Discuss > Announcements* to check current and past
announcements. Announcement managers can also track which users have
read the announcement.
Known issues / Roadmap
======================
- It could be integrated in Discuss app to review past announcements.
- Log other information like geolocation, IP, browser agent, etc when
marking announcement as read.
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-ux/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 <https://github.com/OCA/server-ux/issues/new?body=module:%20announcement%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.
Credits
=======
Authors
-------
* Tecnativa
Contributors
------------
- `Tecnativa <https://www.tecnativa.com>`__:
- Pedro M. Baeza
- David Vidal
- Carlos Roca
Maintainers
-----------
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
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/server-ux <https://github.com/OCA/server-ux/tree/17.0/announcement>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/server-ux",
"name": "odoo-addon-announcement",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Tecnativa, Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": null,
"platform": null,
"description": "============\nAnnouncement\n============\n\n.. \n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! source digest: sha256:d4a1cef7f9eb1c77270b3b0fe3027b94881ac7908ce458b3392f8ca09b698602\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png\n :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n :alt: License: AGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--ux-lightgray.png?logo=github\n :target: https://github.com/OCA/server-ux/tree/17.0/announcement\n :alt: OCA/server-ux\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/server-ux-17-0/server-ux-17-0-announcement\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n :target: https://runboat.odoo-community.org/builds?repo=OCA/server-ux&target_branch=17.0\n :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nThis module adds popup announcements in the backend for targeted\ninternal users. Those announcements can contain rich format and a user\nread log is kept for everyone.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nConfiguration\n=============\n\nTo create new announcements a user should be in the *Announcements\nManagers* group. When your user has such permissions, this is the way to\ncreate an announcement:\n\n1. Go to *Discuss > Announcements*\n2. Create a new one and define a title. This title will be shown in the\n announcement header.\n3. Define the announcement scope:\n\n - Specific users: manually select which users will see the\n announcement.\n - User groups: users from the selected groups will be the ones to\n see the announcement.\n\n4. Define the announcement body. You can use rich formatting and event\n paste your own html (editor in debug mode).\n5. By default, the announcement will be archived. This is to prevent the\n announcement to show up before time.\n6. Once the announcement is ready, unarchive it going to the *Actions*\n menu an choosing the *Unarchive* option.\n7. Optionally you can set an announcement date to schedule the\n announcement. The announcement won't show up until that date.\n8. If the announcement doesn't make sense once a date is passed, you can\n set a due date. From that date, the announcement won't be shown to\n anyone.\n\nUsage\n=====\n\nWhen a user in the scope of active announcements logs in, those will\npopup. The user has to mark them as read to continue working. If the\nannouncement is set during the user session, the announcement will be\neventually prompted in the top bar on the right part. The user click on\nthe unread announcements icon (a speaker) and the announcements will\npopup for the user to check them.\n\nUsers can go *Discuss > Announcements* to check current and past\nannouncements. Announcement managers can also track which users have\nread the announcement.\n\nKnown issues / Roadmap\n======================\n\n- It could be integrated in Discuss app to review past announcements.\n- Log other information like geolocation, IP, browser agent, etc when\n marking announcement as read.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/server-ux/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`feedback <https://github.com/OCA/server-ux/issues/new?body=module:%20announcement%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n-------\n\n* Tecnativa\n\nContributors\n------------\n\n- `Tecnativa <https://www.tecnativa.com>`__:\n\n - Pedro M. Baeza\n - David Vidal\n - Carlos Roca\n\nMaintainers\n-----------\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nThis module is part of the `OCA/server-ux <https://github.com/OCA/server-ux/tree/17.0/announcement>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n",
"bugtrack_url": null,
"license": "AGPL-3",
"summary": "Notify internal users about relevant organization stuff",
"version": "17.0.1.0.0.3",
"project_urls": {
"Homepage": "https://github.com/OCA/server-ux"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7a408ab2368324ffc39515216da22ae2358dae3e7c948228315cfb54c7ee972c",
"md5": "484a372bbfe7bec52651060fdc4cde80",
"sha256": "041c67b5ce829b2295cdb9492f20055def88a2458aeefe6c32516dbbb9aef8b7"
},
"downloads": -1,
"filename": "odoo_addon_announcement-17.0.1.0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "484a372bbfe7bec52651060fdc4cde80",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 41612,
"upload_time": "2024-09-04T04:24:09",
"upload_time_iso_8601": "2024-09-04T04:24:09.498973Z",
"url": "https://files.pythonhosted.org/packages/7a/40/8ab2368324ffc39515216da22ae2358dae3e7c948228315cfb54c7ee972c/odoo_addon_announcement-17.0.1.0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-04 04:24:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "server-ux",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "odoo-addon-announcement"
}
JSON
