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
2.1 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. It brings to end users inline documentation.
  7. Some parts of the documentation can be modified by anyone (with proper rights).
  8. Configuration
  9. =============
  10. * Go to any view and click on the `?` near the title view.
  11. * Edit the html field to add content
  12. * You can provide documentation with this module by appending data
  13. in the field advanced_help (relative to action) or advanced_help_model
  14. if your help must be associated to model instead of action
  15. Usage
  16. =====
  17. Click on ? button
  18. .. image:: help_popup/static/description/popup.png
  19. :alt: License: Help Popup
  20. Alternative
  21. -----------
  22. If you have website module installed, it could be an option
  23. to install help_online instead of this module.
  24. Help Online is more advanced (allow the end user to add help)
  25. but depends on an other module.
  26. Help popup is more like an embedded help that use power users for end users.
  27. Bug Tracker
  28. ===========
  29. Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
  30. In case of trouble, please check there if your issue has already been reported.
  31. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  32. `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**>`_.
  33. Credits
  34. =======
  35. Contributors
  36. ------------
  37. * Sylvain Calador <sylvain.calador@akretion.com>
  38. * David Beal <david.beal@akretion.com>
  39. Icons
  40. ------
  41. https://www.iconfinder.com/Vecteezy
  42. Maintainer
  43. ----------
  44. .. image:: https://odoo-community.org/logo.png
  45. :alt: Odoo Community Association
  46. :target: https://odoo-community.org
  47. This module is maintained by the OCA.
  48. OCA, or the Odoo Community Association, is a nonprofit organization whose
  49. mission is to support the collaborative development of Odoo features and
  50. promote its widespread use.
  51. To contribute to this module, please visit http://odoo-community.org.