<a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg"> </a> <a name="document-pages-for-help"></a> <h2>Document pages for help</h2> <p>This module knits <code>document_page</code> and <code>help_popup</code> 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.</p> <a name="installation"></a> <h3>Installation</h3> <p>To install this module, you need to:</p> <ol class="arabic simple"> <li>install <code>help_popup</code> from the <code>web</code> repository</li> </ol> <a name="configuration"></a> <h3>Configuration</h3> <p>To configure this module, you need to:</p> <ol class="arabic simple"> <li>add users to the <cite>Documentation writer</cite> or <cite>Advanced documentation writer</cite> group</li> <li>if you're so inclined, provide a template in the document category <cite>Documentation</cite> (added by this module)</li> </ol> <a name="usage"></a> <h3>Usage</h3> <p>Members of the above mentioned groups will have access to the the fields <cite>Documentation for</cite> and <cite>Advanced documentation for</cite> on a document page <em>if</em> the page's category is <cite>Documentation</cite>. In those fields, assign the window action(s) for which the current document page is the (advanced) documentation.</p> <p>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.</p> <a class="reference external image-reference" href="https://runbot.odoo-community.org/runbot/118/8.0"><img alt="Try me on Runbot" src="https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas" /></a> <a name="known-issues-roadmap"></a> <h3>Known issues / Roadmap</h3> <ul class="simple"> <li>it would be nice to have this refer to actions instead of window actions, but that's more a matter of help_popup</li> </ul> <a name="bug-tracker"></a> <h3>Bug Tracker</h3> <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/knowledge/issues">GitHub Issues</a>. 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.</p> <a name="credits"></a> <h3>Credits</h3> <a name="images"></a> <h4>Images</h4> <ul class="simple"> <li>Odoo Community Association: <a class="reference external" href="https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg">Icon</a>.</li> </ul> <a name="contributors"></a> <h4>Contributors</h4> <ul class="simple"> <li>Holger Brunn &lt;<a class="reference external" href="mailto:hbrunn&#64;therp.nl">hbrunn&#64;therp.nl</a>&gt;</li> </ul> <p>Do not contact contributors directly about help with questions or problems concerning this addon, but use the <a class="reference external" href="mailto:community&#64;mail.odoo.com">community mailing list</a> or the <a class="reference external" href="https://odoo-community.org/groups">appropriate specialized mailinglist</a> for help, and the bug tracker linked in <a class="reference internal" href="#bug-tracker">Bug Tracker</a> above for technical issues.</p> <a name="maintainer"></a> <h4>Maintainer</h4> <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a> <p>This module is maintained by the OCA.</p> <p>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.</p> <p>To contribute to this module, please visit <a class="reference external" href="https://odoo-community.org">https://odoo-community.org</a>.</p>