You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

82 lines
3.2 KiB

9 years ago
9 years ago
  1. ================================
  2. Needaction counters in main menu
  3. ================================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
  15. :target: https://github.com/OCA/web/tree/10.0/web_menu_navbar_needaction
  16. :alt: OCA/web
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/web-10-0/web-10-0-web_menu_navbar_needaction
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/162/10.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module shows the sum of all submenus' needaction counters in main menus. This way, users get visual feedback where there's still work to do without having to open the respective menu beforehand.
  25. The counters are updated periodically, so users will also be notified if there are new records that require attention.
  26. **Table of contents**
  27. .. contents::
  28. :local:
  29. Configuration
  30. =============
  31. To configure the update frequency, set the configuration parameter `web_menu_navbar_needaction.refresh_timeout` to the amount of milliseconds after which the counters should be updated. Don't do this too often, as this will cause a lot of queries to the database. The default it 600000, which is equivalent to 10 minutes.
  32. To disable updates, set the parameter to 0.
  33. Bug Tracker
  34. ===========
  35. Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
  36. In case of trouble, please check there if your issue has already been reported.
  37. If you spotted it first, help us smashing it by providing a detailed and welcomed
  38. `feedback <https://github.com/OCA/web/issues/new?body=module:%20web_menu_navbar_needaction%0Aversion:%2010.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  39. Do not contact contributors directly about support or help with technical issues.
  40. Credits
  41. =======
  42. Authors
  43. ~~~~~~~
  44. * Therp BV
  45. Contributors
  46. ~~~~~~~~~~~~
  47. * Holger Brunn <hbrunn@therp.nl>
  48. Maintainers
  49. ~~~~~~~~~~~
  50. This module is maintained by the OCA.
  51. .. image:: https://odoo-community.org/logo.png
  52. :alt: Odoo Community Association
  53. :target: https://odoo-community.org
  54. OCA, or the Odoo Community Association, is a nonprofit organization whose
  55. mission is to support the collaborative development of Odoo features and
  56. promote its widespread use.
  57. This module is part of the `OCA/web <https://github.com/OCA/web/tree/10.0/web_menu_navbar_needaction>`_ project on GitHub.
  58. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.