Help Online

help_online
REPOSITORY
REPOSITORYOCA/web
GIT
GIThttps://github.com/OCA/web.git
GIT FOLDER
GIT FOLDERhttps://github.com/OCA/web/tree/10.0/help_online
VERSION
VERSION 1.0.0
CATEGORY
CATEGORYDocumentation
LICENSE
LICENSEAGPL-3
APPLICATION
APPLICATIONNo
AUTO-INSTALLABLE
AUTO-INSTALLABLENo
AUTHORS
AUTHORSOdoo Community Association (OCA), ACSONE SA/NV
MAINTAINERS
MAINTAINERSACSONE SA/NV
COMMITTERS
COMMITTERSPedro M. Baeza, Jairo Llopis, Laurent Mignon (ACSONE), Stéphane Bidoul (ACSONE), OCA Transbot, Laurent Mignon, oca-travis
WEBSITE
WEBSITEhttp://www.acsone.eu
LAST TRACKING UPDATE
LAST TRACKING UPDATE2026-07-06 00:20:00
ODOO DEPENDENCIES
ODOO DEPENDENCIES odoo/odoo:
    - website
    - web
    - base
    - web_editor
    - web_planner
PYTHON DEPENDENCIES
PYTHON DEPENDENCIES Not have
SYSTEM DEPENDENCIES
SYSTEM DEPENDENCIES Not have
DESCRIPTION
DESCRIPTION

Code Analysis

Views touched (5)
XML IDNameModelTypeStatus
assets_backend help.online.assets ir.ui.view qweb Inherits web.assets_backend
export_help_wizard_view export.help.wizard.view export.help.wizard form New
import_help_wizard_view import.help.wizard.view import.help.wizard form New
view_view_form ir.ui.view form (help_online) ir.ui.view xpath Inherits base.view_view_form
view_view_search ir.ui.view search (help_online) ir.ui.view xpath Inherits base.view_view_search
Models touched (4)

New fields (2)
  • data Binary
    readonly=True args: 'XML'
  • export_filename Char
    size=128 args: 'Export XML Filename'
Public methods (2)
  • auto_backup(self)
    @api.model
    Export data to a file on home directory of user
  • export_help(self)
    @api.multi
    Export all Qweb views related to help online in a Odoo data XML file

New fields (0)

No new fields.

Public methods (2)
  • get_existing_pages(self, name, limit=None)
  • get_page_url(self, model, view_type, domain=None, context=None)

New fields (1)
  • source_file Binary
    args: 'Source File'
Public methods (1)
  • import_help(self)
    @api.multi

New fields (0)

No new fields.

Public methods (1)
  • manageImageReferences(self, xml_str, module)
REPOSITORY
REPOSITORYOCA/web
GIT
GIThttps://github.com/OCA/web.git
GIT FOLDER
GIT FOLDERhttps://github.com/OCA/web/tree/9.0/help_online
VERSION
VERSION 1.0.0
CATEGORY
CATEGORYDocumentation
LICENSE
LICENSEAGPL-3
APPLICATION
APPLICATIONNo
AUTO-INSTALLABLE
AUTO-INSTALLABLENo
AUTHORS
AUTHORSOdoo Community Association (OCA), ACSONE SA/NV
MAINTAINERS
MAINTAINERSACSONE SA/NV
COMMITTERS
COMMITTERSPedro M. Baeza, Stéphane Bidoul (ACSONE), OCA Transbot, Laurent Mignon
WEBSITE
WEBSITEhttp://www.acsone.eu
LAST TRACKING UPDATE
LAST TRACKING UPDATE2026-07-06 00:15:23
ODOO DEPENDENCIES
ODOO DEPENDENCIES odoo/odoo:
    - base
    - website
    - web
    - web_editor
    - web_planner
PYTHON DEPENDENCIES
PYTHON DEPENDENCIES Not have
SYSTEM DEPENDENCIES
SYSTEM DEPENDENCIES Not have
DESCRIPTION
DESCRIPTION

Code Analysis

Views touched (5)
XML IDNameModelTypeStatus
assets_backend help.online.assets ir.ui.view qweb Inherits web.assets_backend
export_help_wizard_view export.help.wizard.view export.help.wizard form New
import_help_wizard_view import.help.wizard.view import.help.wizard form New
view_view_form ir.ui.view form (help_online) ir.ui.view xpath Inherits base.view_view_form
view_view_search ir.ui.view search (help_online) ir.ui.view xpath Inherits base.view_view_search
Models touched (4)

New fields (2)
  • data Binary
    readonly=True args: 'XML'
  • export_filename Char
    size=128 args: 'Export XML Filename'
Public methods (2)
  • auto_backup(self)
    @api.model
    Export data to a file on home directory of user
  • export_help(self)
    @api.multi
    Export all Qweb views related to help online in a Odoo data XML file

New fields (0)

No new fields.

Public methods (2)
  • get_existing_pages(self, name, limit=None)
  • get_page_url(self, model, view_type, domain=None, context=None)

New fields (1)
  • source_file Binary
    args: 'Source File'
Public methods (1)
  • import_help(self)
    @api.multi

New fields (0)

No new fields.

Public methods (1)
  • manageImageReferences(self, xml_str, module)
REPOSITORY
REPOSITORYOCA/web
GIT
GIThttps://github.com/OCA/web.git
GIT FOLDER
GIT FOLDERhttps://github.com/OCA/web/tree/8.0/help_online
VERSION
VERSION 1.0.0
CATEGORY
CATEGORYDocumentation
LICENSE
LICENSEAGPL-3
APPLICATION
APPLICATIONNo
AUTO-INSTALLABLE
AUTO-INSTALLABLENo
AUTHORS
AUTHORSOdoo Community Association (OCA), ACSONE SA/NV
MAINTAINERS
MAINTAINERSACSONE SA/NV
COMMITTERS
COMMITTERSStéphane Bidoul, Yannick Vaucher, Alexandre Fayolle, Pedro M. Baeza, Sylvain LE GAL, GitHub, Cédric Pigeon, Laurent Mignon (ACSONE), Stéphane Bidoul (ACSONE), OCA Transbot, Jonathan Nemry, Adrien Peiffer (ACSONE), Laurent Mignon, Laurent Mignon (aka lmi), oca-travis, Weblate, Matjaž Mozetič, Renzo Meister
WEBSITE
WEBSITEhttp://www.acsone.eu
LAST TRACKING UPDATE
LAST TRACKING UPDATE2026-07-06 00:11:25
ODOO DEPENDENCIES
ODOO DEPENDENCIES odoo/odoo:
    - base
    - website
    - web
    - share
    - mail
    - base_setup
    - web_kanban
PYTHON DEPENDENCIES
PYTHON DEPENDENCIES Not have
SYSTEM DEPENDENCIES
SYSTEM DEPENDENCIES Not have
DESCRIPTION
DESCRIPTION
Help Online
===========

This module allows the creation of an online help available from the lists
and forms in Odoo.

When loading a view, the module generates a button allowing access to an help
page for the related model if the page exists and the user is member of the
group 'Help reader'. If the page doesn't exist and the user is member of
the group 'Help writer', the module generate a button allowing the creation an
help page.

The help pages are created and managed via the website Module.

Note: When updating the page prefix parameters, the record rules must be
      adapted.
    

Code Analysis

Views touched (6)
XML IDNameModelTypeStatus
assets_backend help.online.assets ir.ui.view qweb Inherits web.assets_backend
assets_editor Help online customization ir.ui.view qweb Inherits website.assets_editor
export_help_wizard_view export.help.wizard.view export.help.wizard form New
import_help_wizard_view import.help.wizard.view import.help.wizard form New
view_view_form ir.ui.view form (help_online) ir.ui.view xpath Inherits base.view_view_form
view_view_search ir.ui.view search (help_online) ir.ui.view xpath Inherits base.view_view_search
Models touched (4)

New fields (2)
  • data Binary
    readonly=True args: 'XML'
  • export_filename Char
    size=128 args: 'Export XML Filename'
Public methods (2)
  • auto_backup(self)
    @api.model
    Export data to a file on home directory of user
  • export_help(self)
    @api.multi
    Export all Qweb views related to help online in a Odoo data XML file

New fields (0)

No new fields.

Public methods (1)
  • get_page_url(self, model, view_type, domain=None, context=None)

New fields (1)
  • source_file Binary
    args: 'Source File'
Public methods (1)
  • import_help(self)
    @api.one

New fields (0)

No new fields.

Public methods (1)
  • manageImageReferences(self, xml_str, module)