mirror of https://github.com/OCA/web.git
107 lines
3.6 KiB
ReStructuredText
107 lines
3.6 KiB
ReStructuredText
==============
|
|
Help Framework
|
|
==============
|
|
|
|
..
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! This file is generated by oca-gen-addon-readme !!
|
|
!! changes will be overwritten. !!
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! source digest: sha256:58edff8be040444604931118c74b543873d860d4e6a635d001bab8749eba9fa2
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
|
.. |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%2Fweb-lightgray.png?logo=github
|
|
:target: https://github.com/OCA/web/tree/16.0/web_help
|
|
:alt: OCA/web
|
|
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
|
:target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_help
|
|
: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/web&target_branch=16.0
|
|
:alt: Try me on Runboat
|
|
|
|
|badge1| |badge2| |badge3| |badge4| |badge5|
|
|
|
|
This module introduces a new way to guide the user through Odoo.
|
|
This module is created because **the standard Odoo tours:**
|
|
|
|
#. forces the user to create records;
|
|
#. cannot be reopened;
|
|
#. is only available for the admin user;
|
|
#. the bubbles are not obvious.
|
|
|
|
**Table of contents**
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
Usage
|
|
=====
|
|
|
|
**Demo:**
|
|
|
|
.. image:: https://raw.githubusercontent.com/OCA/web/16.0/web_help/static/description/demo.gif
|
|
|
|
You can see the demo live by going to the users list view (Settings > Users & Companies > Users)
|
|
and clicking the little '?' next to the view switcher.
|
|
|
|
.. image:: https://raw.githubusercontent.com/OCA/web/16.0/web_help/static/description/viewswitcher.png
|
|
|
|
Also there's a demo for the change password wizard:
|
|
|
|
.. image:: https://raw.githubusercontent.com/OCA/web/16.0/web_help/static/description/changepassword.png
|
|
|
|
It's easy to create your own guides, please refer to ``static/src/user_trip.esm.js`` and
|
|
``static/src/change_password_trip.esm.js``
|
|
|
|
Known issues / Roadmap
|
|
======================
|
|
|
|
* Implement keyboard shortcuts
|
|
|
|
Bug Tracker
|
|
===========
|
|
|
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/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/web/issues/new?body=module:%20web_help%0Aversion:%2016.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
|
|
~~~~~~~
|
|
|
|
* Onestein
|
|
|
|
Contributors
|
|
~~~~~~~~~~~~
|
|
|
|
* Dennis Sluijk <d.sluijk@onestein.nl>
|
|
|
|
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/web <https://github.com/OCA/web/tree/16.0/web_help>`_ project on GitHub.
|
|
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|