Document pages for help
This module knits document_page and help_popup together such that you can write your help texts as document pages. The advantage is that you can use your help texts also as (part of) a functional description of your installation, or the other way around.
Installation
To install this module, you need to:
install help_popup from the web repository
Configuration
To configure this module, you need to:
add users to the Documentation writer or Advanced documentation writer group
if you’re so inclined, provide a template in the document category Documentation (added by this module)
Usage
Members of the above mentioned groups will have access to the the fields Documentation for and Advanced documentation for on a document page if the page’s category is Documentation. In those fields, assign the window action(s) for which the current document page is the (advanced) documentation.
Given you can add multiple document pages as help for the same action (they will be concatenated), you can share writing documentation between multiple people writing about different aspects.
Known issues / Roadmap
it would be nice to have this refer to actions instead of window actions, but that’s more a matter of help_popup
Bug Tracker
Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.
Credits
Images
Odoo Community Association: Icon.
Contributors
Holger Brunn <hbrunn@therp.nl>
Do not contact contributors directly about help with questions or problems concerning this addon, but use the community mailing list or the appropriate specialized mailinglist for help, and the bug tracker linked in Bug Tracker above for technical issues.
Maintainer
This module is maintained by the OCA.
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.
To contribute to this module, please visit https://odoo-community.org.
1 maintainer
Metadata
1 maintainer
Release files for odoo8-addon-help-popup-document-page 8.0.1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| odoo8_addon_help_popup_document_page-8.0.1.0.0-py2-none-any.whl | Python 2 | none | any | Details for odoo8_addon_help_popup_document_page-8.0.1.0.0-py2-none-any.whl |
Release files / odoo8_addon_help_popup_document_page-8.0.1.0.0-py2-none-any.whl
| Download URL | odoo8_addon_help_popup_document_page-8.0.1.0.0-py2-none-any.whl |
|---|---|
| Size | 21.2 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
2c53d3bd658d39e5f521393702491ce68888f7bfbf8eaf48b1215ac5fa4bfa63
|
|
BLAKE2b-256 checksum How to use checksums |
b7f9f54c32cf178ca1b2437a19277efbbd693ffb00417164c882abd21cddd000
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/57.4.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.5
|
Security for odoo8-addon-help-popup-document-page 8.0.1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
