Skip to main content

Use document pages as help popup

Project description

License: AGPL-3

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:

  1. install help_popup from the web repository

Configuration

To configure this module, you need to:

  1. add users to the Documentation writer or Advanced documentation writer group

  2. 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.

Try me on Runbot

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

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

Odoo Community Association

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

File details

Details for the file odoo8_addon_help_popup_document_page-8.0.1.0.0-py2-none-any.whl.

File metadata

File hashes

Hashes for odoo8_addon_help_popup_document_page-8.0.1.0.0-py2-none-any.whl
Algorithm Hash digest
SHA256 2c53d3bd658d39e5f521393702491ce68888f7bfbf8eaf48b1215ac5fa4bfa63
MD5 6248e1d2202b0142bc85ecfd493db584
BLAKE2b-256 b7f9f54c32cf178ca1b2437a19277efbbd693ffb00417164c882abd21cddd000

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page