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.

86 lines
2.0 KiB

10 years ago
  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :alt: License: AGPL-3
  3. Help Popup
  4. ===========
  5. This module adds an html help popup on each model action.
  6. Two help fields are added to actions: enduser_help (html widget)
  7. and advanced_help.
  8. Installation
  9. ============
  10. It was tested on Odoo 8.0 branch.
  11. Configuration
  12. =============
  13. Go to the action of your choice to add some help content
  14. or put data in some modules.
  15. To display the button which open the popup, enduser_help or advanced_help field
  16. should be set to any value.
  17. Usage
  18. =====
  19. Click on ? button
  20. .. image:: help_popup/static/description/popup.png
  21. :alt: License: Help Popup
  22. Alternative
  23. -----------
  24. If you have website module installed, it could be an option
  25. to install help_online instead of this module.
  26. Help Online is more advanced (allow the end user to add help)
  27. but depends on an other module.
  28. Help popup is more like an embedded help that use power users for end users.
  29. Bug Tracker
  30. ===========
  31. Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
  32. In case of trouble, please check there if your issue has already been reported.
  33. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  34. `here <https://github.com/OCA/web/issues/new?body=module:%20web%0Aversion:%200.5%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  35. Credits
  36. =======
  37. Contributors
  38. ------------
  39. * Sylvain Calador <sylvain.calador@akretion.com>
  40. * David Beal <david.beal@akretion.com>
  41. Icons
  42. ------
  43. https://www.iconfinder.com/Vecteezy
  44. Maintainer
  45. ----------
  46. .. image:: https://odoo-community.org/logo.png
  47. :alt: Odoo Community Association
  48. :target: https://odoo-community.org
  49. This module is maintained by the OCA.
  50. OCA, or the Odoo Community Association, is a nonprofit organization whose
  51. mission is to support the collaborative development of Odoo features and
  52. promote its widespread use.
  53. To contribute to this module, please visit http://odoo-community.org.