Browse Source

[IMP] add help fields, qweb report

pull/149/head
David Beal 10 years ago
parent
commit
9adccf5013
  1. 35
      help_contextual_popup/README.rst
  2. 2
      help_contextual_popup/__init__.py
  3. 43
      help_contextual_popup/controller.py
  4. 76
      help_popup/README.rst
  5. 1
      help_popup/__init__.py
  6. 9
      help_popup/__openerp__.py
  7. 55
      help_popup/demo/help.xml
  8. 7
      help_popup/model.py
  9. 42
      help_popup/report/help.xml
  10. 13
      help_popup/report/report.xml
  11. BIN
      help_popup/static/description/icon.png
  12. BIN
      help_popup/static/description/popup.png
  13. 6
      help_popup/static/src/js/popup_help.js
  14. 0
      help_popup/static/src/xml/popup_help.xml
  15. 1
      help_popup/views/action_view.xml
  16. 2
      help_popup/views/popup_help_view.xml

35
help_contextual_popup/README.rst

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

2
help_contextual_popup/__init__.py

@ -1,2 +0,0 @@
from . import model
from . import controller

43
help_contextual_popup/controller.py

@ -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>"""

76
help_popup/README.rst

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

1
help_popup/__init__.py

@ -0,0 +1 @@
from . import model

9
help_contextual_popup/__openerp__.py → help_popup/__openerp__.py

@ -20,8 +20,8 @@
##############################################################################
{
'name': 'Help Contextual Popup',
'version': '0.1',
'name': 'Help Popup',
'version': '0.5',
'author': 'Akretion, Odoo Community Association (OCA)',
'depends': [
'web',
@ -31,6 +31,11 @@
'data': [
'views/popup_help_view.xml',
'views/action_view.xml',
'report/report.xml',
'report/help.xml',
],
'demo': [
'demo/help.xml',
],
'qweb': [
'static/src/xml/popup_help.xml',

55
help_popup/demo/help.xml

@ -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>

7
help_contextual_popup/model.py → help_popup/model.py

@ -25,6 +25,11 @@ from openerp import models, fields
class IrActionsActwindow(models.Model):
_inherit = 'ir.actions.act_window'
owner_help = fields.Html(
string="Owner Help",
help="Use this field to add custom content for documentation purpose\n"
"mainly for the ERP owner")
custom_help = fields.Text(
string="Custom Help",
help="Use this field to add custom content for documentation purpose")
help="Use this field to add custom content for documentation purpose\n"
"mainly for module developers")

42
help_popup/report/help.xml

@ -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>

13
help_popup/report/report.xml

@ -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>

BIN
help_popup/static/description/icon.png

After

Width: 79  |  Height: 69  |  Size: 1.6 KiB

BIN
help_popup/static/description/popup.png

After

Width: 874  |  Height: 793  |  Size: 121 KiB

6
help_contextual_popup/static/src/js/popup_help.js → help_popup/static/src/js/popup_help.js

@ -1,4 +1,4 @@
openerp.help_contextual_popup = function(instance, local) {
openerp.help_popup = function(instance, local) {
var _t = instance.web._t;
instance.web.ViewManager.include({
@ -13,10 +13,10 @@ openerp.help_contextual_popup = function(instance, local) {
}
$elem.data('click-init', true);
$elem.on('click', function(e) {
var params = 'height=400, width=600, location=no, ';
var params = 'height=650, width=800, location=no, ';
params += 'resizable=yes, menubar=yes, titlebar=Bla';
path = self.action.id;
my_window = window.open('/help/' + path, 'Help', params);
my_window = window.open('/report/html/help_popup.tpl_help/' + path, 'Help', params);
// allows to back to the window if opened previoulsy
setTimeout('my_window.focus()', 1);
});

0
help_contextual_popup/static/src/xml/popup_help.xml → help_popup/static/src/xml/popup_help.xml

1
help_contextual_popup/views/action_view.xml → help_popup/views/action_view.xml

@ -8,6 +8,7 @@
ref="base.view_window_action_form"/>
<field name="arch" type="xml">
<field name="help" position="after">
<field name="owner_help"/>
<field name="custom_help"/>
</field>
</field>

2
help_contextual_popup/views/popup_help_view.xml → help_popup/views/popup_help_view.xml

@ -3,7 +3,7 @@
<data>
<template id="assets_backend" name="custom assets" inherit_id="web.assets_backend">
<xpath expr="." position="inside">
<script type="text/javascript" src="/help_contextual_popup/static/src/js/popup_help.js"></script>
<script type="text/javascript" src="/help_popup/static/src/js/popup_help.js"></script>
</xpath>
</template>
</data>
Loading…
Cancel
Save