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.
 
 
 
 
 

93 lines
3.3 KiB

<?xml version="1.0" encoding="utf-8"?>
<openerp>
<data>
<record id="base.action_partner_form" model="ir.actions.act_window">
<field name="enduser_help"><![CDATA[
<b>Hi Odooer,</b>
<p/>
Here is a documentation tool. You can customize these lines.
Check lines below to learn more about this feature.
]]></field>
</record>
<record id="base.action_partner_form" model="ir.actions.act_window">
<field name="advanced_help"><![CDATA[
<b>Hi Odoo community,</b>
<h4>Main functionalities:</h4>
<ul>
<li>Documentation is contextual by model or action: the right help to the good place.</li>
<li>Modules contributors can embeds their documentation in their modules: documentation access in 1 click by model or action.</li>
<li>End users can also produce some html documentation to complete missing parts.</li>
<li>Documentation can also been edited for a complete base menu: Sales, Purchase, etc.</li>
<li>Documentation can be printed with <kbd>Ctrl + P</kbd> shortcut.</li>
</ul>
<p/>
<h4>How to use it:</h4>
<ul>
<li>When you see on any user interface part <img src="/help_popup/static/description/nodoc.png"/> click on '?'.</li>
<li>Click on edit and fill 'End Users help' field.</li>
<li>When you see <img src="/help_popup/static/description/doc.png"/> click on '?' button to access directly to the documentation.</li>
<li>With the 2 buttons on the right, can either edit help or call the documentation of the whole main menus <img src="/help_popup/static/description/sales.png"/></li>
</ul>
<p>
<h4>How to embedds documentation in your module:</h4>
<ul>
<li>You can insert html with standard Odoo xml data.</li>
<li>Data are inserted with 'ir.actions.act_window' model</li>
<li>If your data concerns a model, then fill the field 'advanced_help_model' of your action.</li>
<li>If your data is specific to 1 action window (i.e. only customers, not suppliers) then fill the field 'avanced_help' with your data.</li>
<li>Example of inserted data
<br/><code>
&lt;record id="base.action_partner_form" model="ir.actions.act_window"&gt;
<br/> &nbsp; &nbsp;
&lt;field name="advanced_help"&gt;&lt;![CDATA[
<p>put your html data here</p>
<br/> &nbsp; &nbsp;
]]&gt;&lt;/field&gt;
<br/>
&lt;/record&gt;</code>
</li>
<li>You can do of the same way with 'advanced_help_model' field.</li>
<li><b>Several modules can modify a fraction of the same field: remove of data at uninstall is taken account.</b></li>
</ul>
<p/>
<img src="/help_popup/static/description/contributor.png"/>
<p/>
]]></field>
</record>
<record id="base.action_partner_category_form"
model="ir.actions.act_window">
<field name="enduser_help"><![CDATA[
Hi all,<br><br>
A supplier can have several specialities.
<br><br>
Use these multicategories to classify your partners
]]></field>
</record>
<record id="base.action_res_bank_form"
model="ir.actions.act_window">
<field name="enduser_help_model"><![CDATA[
Hi all,<br>
<br><br>
Who does not want to rob a bank?
<br><br>
;-)
]]></field>
</record>
</data>
</openerp>