server-ux/announcement/README.rst

============
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.