David Beal
10 years ago
16 changed files with 205 additions and 87 deletions
-
35help_contextual_popup/README.rst
-
2help_contextual_popup/__init__.py
-
43help_contextual_popup/controller.py
-
76help_popup/README.rst
-
1help_popup/__init__.py
-
9help_popup/__openerp__.py
-
55help_popup/demo/help.xml
-
7help_popup/model.py
-
42help_popup/report/help.xml
-
13help_popup/report/report.xml
-
BINhelp_popup/static/description/icon.png
-
BINhelp_popup/static/description/popup.png
-
6help_popup/static/src/js/popup_help.js
-
0help_popup/static/src/xml/popup_help.xml
-
1help_popup/views/action_view.xml
-
2help_popup/views/popup_help_view.xml
@ -1,35 +0,0 @@ |
|||
Add contextual help popup |
|||
========================= |
|||
|
|||
This module add a contextual html help popup on each model action. |
|||
You also may use dedicated field custom_help on actions to add specific help |
|||
|
|||
Installation |
|||
============ |
|||
|
|||
It was tested on Odoo 8.0 branch. |
|||
|
|||
Credits |
|||
======= |
|||
|
|||
Akretion |
|||
|
|||
Contributors |
|||
------------ |
|||
|
|||
* Sylvain Calador <sylvain.calador@akretion.com> |
|||
* David Beal <david.beal@akretion.com> |
|||
|
|||
Maintainer |
|||
---------- |
|||
|
|||
.. image:: http://odoo-community.org/logo.png |
|||
:alt: Odoo Community Association |
|||
:target: http://odoo-community.org |
|||
|
|||
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 http://odoo-community.org. |
|||
|
@ -1,2 +0,0 @@ |
|||
from . import model |
|||
from . import controller |
@ -1,43 +0,0 @@ |
|||
# coding: utf-8 |
|||
############################################################################## |
|||
# |
|||
# Odoo, Open Source Management Solution |
|||
# Copyright (C) 2015-TODAY Akretion (<http://www.akretion.com>). |
|||
# |
|||
# This program is free software: you can redistribute it and/or modify |
|||
# it under the terms of the GNU Affero General Public License as |
|||
# published by the Free Software Foundation, either version 3 of the |
|||
# License, or (at your option) any later version. |
|||
# |
|||
# This program is distributed in the hope that it will be useful, |
|||
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
|||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|||
# GNU Affero General Public License for more details. |
|||
# |
|||
# You should have received a copy of the GNU Affero General Public License |
|||
# along with this program. If not, see <http://www.gnu.org/licenses/>. |
|||
# |
|||
############################################################################## |
|||
|
|||
from openerp.http import Controller, route, request |
|||
|
|||
|
|||
class MyController(Controller): |
|||
@route([ |
|||
"/help/<int:action_id>", |
|||
], type='http', auth="public") |
|||
def handler(self, action_id, *args, **kwargs): |
|||
req = request.session.model('ir.actions.act_window') |
|||
return 'blabla %s db %s' % (action_id, req) |
|||
|
|||
def _get_html_tpl(self): |
|||
return """<html> |
|||
<head> |
|||
<title>{{title}}</title> |
|||
{{head}} |
|||
</head> |
|||
<body> |
|||
<h1>{{h1}}</h1> |
|||
{{body}} |
|||
</body> |
|||
</html>""" |
@ -0,0 +1,76 @@ |
|||
|
|||
.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg |
|||
:alt: License: AGPL-3 |
|||
|
|||
Help Popup |
|||
=========== |
|||
|
|||
This module adds an html help popup on each model action. |
|||
Two help fields are added to actions: owner_help and custom_help. |
|||
|
|||
|
|||
Installation |
|||
============ |
|||
|
|||
It was tested on Odoo 8.0 branch. |
|||
|
|||
|
|||
Configuration |
|||
============= |
|||
|
|||
Go to the action of your choice to add some help content |
|||
or put data in some modules. |
|||
|
|||
|
|||
Usage |
|||
===== |
|||
|
|||
Click on ? button |
|||
|
|||
.. image:: help_popup/static/description/popup.png |
|||
:alt: License: Help Popup |
|||
|
|||
|
|||
Known issues / Roadmap |
|||
====================== |
|||
|
|||
* ... |
|||
|
|||
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 smashing it by providing a detailed and welcomed feedback |
|||
`here <https://github.com/OCA/web/issues/new?body=module:%20web%0Aversion:%200.5%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. |
|||
|
|||
|
|||
Credits |
|||
======= |
|||
|
|||
Contributors |
|||
------------ |
|||
|
|||
* Sylvain Calador <sylvain.calador@akretion.com> |
|||
* David Beal <david.beal@akretion.com> |
|||
|
|||
|
|||
Icons |
|||
------ |
|||
https://www.iconfinder.com/Vecteezy |
|||
|
|||
|
|||
Maintainer |
|||
---------- |
|||
|
|||
.. image:: https://odoo-community.org/logo.png |
|||
:alt: Odoo Community Association |
|||
:target: https://odoo-community.org |
|||
|
|||
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 http://odoo-community.org. |
@ -0,0 +1 @@ |
|||
from . import model |
@ -0,0 +1,55 @@ |
|||
<?xml version="1.0" encoding="utf-8"?> |
|||
|
|||
<openerp> |
|||
<data noupdate="1"> |
|||
|
|||
<record id="base.action_partner_form" model="ir.actions.act_window"> |
|||
<field name="owner_help"><![CDATA[ |
|||
<b>Hi Odooer,</b> |
|||
|
|||
<br/> |
|||
<br/> |
|||
<p> |
|||
I'm the field 'owner_help' in the Customer action model |
|||
</p> |
|||
<p> |
|||
I'm displayed in a Qweb html report |
|||
</p> |
|||
|
|||
<p> |
|||
Don't hesitate to customized me with your own words and syntax |
|||
</p> |
|||
|
|||
]]></field> |
|||
</record> |
|||
</data> |
|||
|
|||
<data noupdate="0"> |
|||
<record id="base.action_partner_form" model="ir.actions.act_window"> |
|||
<field name="custom_help"><![CDATA[ |
|||
<b>Hi developers,</b> |
|||
|
|||
<br/> |
|||
<br/> |
|||
<p> |
|||
I'm the field 'custom_help' in the customer action also displayed in Qweb report. |
|||
</p> |
|||
<p> |
|||
<b>Akretion</b> wrote these words to explain my main purpose: |
|||
<blockquote> |
|||
Allows to developers to write documentation on their work. |
|||
</blockquote> |
|||
</p> |
|||
<p> |
|||
|
|||
</p> |
|||
|
|||
<p>You can write any html tag. Here is an image with img tag</p> |
|||
|
|||
<img src="http://www.akretion.com/sites/50443990c3c67e1bf3000004/theme/images/logo.png"/> |
|||
|
|||
]]></field> |
|||
</record> |
|||
|
|||
</data> |
|||
</openerp> |
@ -0,0 +1,42 @@ |
|||
<?xml version="1.0" encoding="utf-8"?> |
|||
|
|||
<openerp> |
|||
<data> |
|||
|
|||
<template id="tpl_help"> |
|||
|
|||
<t t-call="report.html_container"> |
|||
<t t-call="report.internal_layout"> |
|||
|
|||
|
|||
<t t-foreach="docs" t-as="o"> |
|||
|
|||
<div class="page"> |
|||
|
|||
<b><h1 t-field="o.name"/></b> |
|||
|
|||
<div t-raw="o.owner_help"/> |
|||
|
|||
<hr width="70%"/> |
|||
|
|||
<h3 t-if="o.custom_help">Help from developer</h3> |
|||
<div t-raw="o.custom_help"/> |
|||
|
|||
<hr width="70%"/> |
|||
|
|||
<h3 t-if="o.help">Help from Odoo</h3> |
|||
<div t-raw="o.help"/> |
|||
|
|||
</div> |
|||
|
|||
<!--end foreach--> |
|||
</t> |
|||
|
|||
</t> |
|||
</t> |
|||
|
|||
</template> |
|||
|
|||
|
|||
</data> |
|||
</openerp> |
@ -0,0 +1,13 @@ |
|||
<?xml version="1.0" encoding="utf-8"?> |
|||
|
|||
<openerp> |
|||
<data> |
|||
|
|||
<report id="report_help_popup" |
|||
model="ir.actions.act_window" |
|||
string="Contextual Help" |
|||
name="help_popup.tpl_help" |
|||
report_type="qweb-html"/> |
|||
|
|||
</data> |
|||
</openerp> |
After Width: 79 | Height: 69 | Size: 1.6 KiB |
After Width: 874 | Height: 793 | Size: 121 KiB |
Write
Preview
Loading…
Cancel
Save
Reference in new issue