[19.0][MIG] screen_help: reinvented version of help_module by bealdav · Pull Request #653 · OCA/knowledge

bealdav · 2026-10-17T16:00:06Z

Not a really critical module but convenient to document features

cc @gurneyalex @hbrunn @dreispt

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

…sisted-by: Claude Opus 5.5

hbrunn

not sure why you renamed this? i mean, it still pops up help?

please remove all the bullshit comments in code files, they have negative value for readability of the code.

hbrunn · 2026-10-23T06:23:06Z

+    def _response(self, html):
+        return request.make_response(
+            html, headers=[("Content-Type", "text/html; charset=utf-8")]
+        )


what's the point of this function?

def _response is now removed. Thanks

hbrunn · 2026-10-23T06:27:53Z

+        else:
+            title, prefix = env["ir.model"]._get(model).name or model, "help"
+        body, toc = env["help.section"]._for(action, model)._html(prefix)
+        html = env["ir.actions.report"]._render_template(


what's the reason for rendering this as a report instead of passing template and context to the response? I'd also rather see ir.http#webclient_rendering_context included here instead of the _dark function, making all of this more standard Odoo

hbrunn · 2026-10-23T06:31:12Z

+    @http.route("/screen_help/app/<int:menu_id>", type="http", auth="user")
+    def app_help(self, menu_id):
+        """Help of all the screens of an application (root menu)"""
+        html, __ = request.env["ir.actions.report"]._render_qweb_html(


same question as above

hbrunn · 2026-10-23T06:38:02Z

+FRONT_MATTER_RE = re.compile(r"\A---\s*\n(.*?)\n---\s*\n", re.DOTALL)
+
+
+def front_matter(text):


why is this not a model function to allow overrides?

is now def _front_matter(self, text):

hbrunn · 2026-10-23T06:39:30Z

+    as Markdown files (see `_load_markdown`).
+
+    A section targets either a window action, or a model: then it is shown on
+    every screen of this model, whatever the action."""


I suggest to allow also targeting specific menus, as some window actions are generic and depending on the menu, other help texts are appropriate

Maybe I can add it in ROADMAP if you need a such feature ?

hbrunn · 2026-10-23T06:51:45Z

+from odoo import fields, models
+
+
+class IrActionsActWindow(models.Model):


support for client actions would be nice, but I see how this is difficult

Can you explain use cases ? And shouldn't implement it in another module ?

hbrunn · 2026-10-23T06:52:37Z

+- [Akretion](https://www.akretion.com):
+  - David Beal <david.beal@akretion.com>
+    Original help_popup author augmented and renamed to screen_help
+    Assisted-by: Claude Opus 5.5


this goes in the commit message

hbrunn · 2026-10-23T06:57:52Z

+            <div class="o_help_content flex-grow-1" style="min-width: 0;">
+                <t t-out="0" />
+            </div>
+        </div>


it would be nice if this included some javascript that looks for data-* attributes which allow linking to some action in Odoo, as not all actions have paths

hbrunn · 2026-10-23T07:00:45Z

+                t-on-click="onClickHelp"
+            >
+                <!-- Book icon: documentation of the screen -->
+                <i class="fa fa-book" />


I'd find circle-question or some other icon involving a question mark more appropriate

hbrunn · 2026-10-23T07:16:58Z

+        if (
+            not self.env.context.get("install_module")
+            and set(vals) & set(self._file_fields)
+            and any(self.mapped("file"))


this seems to make it impossible to overwrite some generic help texts in a customer-specific module with xml records? I'd suggest to also check for install_mode

Ok, for install mode. If you have to override this section, maybe it's easy to do it when you'll have a such case ?

bealdav · 2026-10-23T17:29:15Z

Thanks @hbrunn for your full review.

I renamed because a popup is inside a tab. In this case this a new window.

But @tonygalmiche suggest me to support a way to embed documentation near chatter place. It seems a good idea with user preference.
But now I really don't know which name must be chosen for this module ;-)

The main purpose of the module, is that the documentation is contextual to the current page. I don't know if we could find a good name with this consideration.

Thanks for any suggestion

I'll answer to all your other requests.

hbrunn · 2026-10-24T04:15:32Z

the word pop-up was a thing long before there was the concept of browser tabs ;-) but anyways, why not just help? I also liked the name help_online which is abandoned by now.

the exact way of displaying should be something easy to tinker with in other modules/user preferences in any case, as I can imagine ie showing this full screen on mobile, or indeed a popup to move to a second screen can be very useful.

finally, as there's not really anything left of the old module, I'm not sure it makes sense to carry the old commits forward.

hbrunn · 2026-10-24T04:16:39Z

+
+    _name = "help.section"
+    _description = "Help Section"
+    _order = "sequence, id"


set _rec_name to something useful here or override _compute_display_name

I addded _compute_display_name to have a better display

bealdav

@hbrunn I'll let confirm it'OK before to:

rename module as help, why not
make it possible to display help near chatter place
remove commits from help_module

bealdav · 2026-10-25T10:04:17Z

+FRONT_MATTER_RE = re.compile(r"\A---\s*\n(.*?)\n---\s*\n", re.DOTALL)
+
+
+def front_matter(text):


is now def _front_matter(self, text):

bealdav · 2026-10-25T10:07:09Z

+    def _response(self, html):
+        return request.make_response(
+            html, headers=[("Content-Type", "text/html; charset=utf-8")]
+        )


def _response is now removed. Thanks

bealdav · 2026-10-25T10:09:38Z

+                t-on-click="onClickHelp"
+            >
+                <!-- Book icon: documentation of the screen -->
+                <i class="fa fa-book" />


bealdav · 2026-10-25T10:10:45Z

+- [Akretion](https://www.akretion.com):
+  - David Beal <david.beal@akretion.com>
+    Original help_popup author augmented and renamed to screen_help
+    Assisted-by: Claude Opus 5.5


bealdav · 2026-10-25T10:13:26Z

+        else:
+            title, prefix = env["ir.model"]._get(model).name or model, "help"
+        body, toc = env["help.section"]._for(action, model)._html(prefix)
+        html = env["ir.actions.report"]._render_template(


bealdav · 2026-10-25T10:15:14Z

+
+    _name = "help.section"
+    _description = "Help Section"
+    _order = "sequence, id"


I addded _compute_display_name to have a better display

bealdav · 2026-10-25T10:17:12Z

+from odoo import fields, models
+
+
+class IrActionsActWindow(models.Model):


Can you explain use cases ? And shouldn't implement it in another module ?

bealdav · 2026-10-25T10:18:58Z

+    @http.route("/screen_help/app/<int:menu_id>", type="http", auth="user")
+    def app_help(self, menu_id):
+        """Help of all the screens of an application (root menu)"""
+        html, __ = request.env["ir.actions.report"]._render_qweb_html(


bealdav · 2026-10-25T10:20:23Z

+    as Markdown files (see `_load_markdown`).
+
+    A section targets either a window action, or a model: then it is shown on
+    every screen of this model, whatever the action."""


Maybe I can add it in ROADMAP if you need a such feature ?

bealdav and others added 9 commits October 17, 2026 17:03

[IMP] add help fields, qweb report

ff9d3b5

[IMP] display button with condition

e7b5b89

[IMP] highlight popup button

f1179ce

[FIX] display popup if action is undefined

a415a3e

[FIX] double key in manifest dict

6016566

[UPD] prefix versions with 8.0

bece145

Remove debug code in JS

16637c6

[FIX] help_popup: License in manifest

f6ef7b1

[REN] help_popup: rename to screen_help

d1f5faf

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

OCA-git-bot added series:19.0 mod:screen_help Module screen_help labels Oct 17, 2026

bealdav mentioned this pull request Oct 17, 2026

[IMP] help_popup module OCA/web#417

Closed

5 of 6 tasks

bealdav marked this pull request as ready for review October 17, 2026 16:04

[19.0][MIG] screen_help: previously named help_popup in web repo ; As…

72aaa4e

…sisted-by: Claude Opus 5.5

bealdav force-pushed the 19-screen-help branch from 5f00584 to 72aaa4e Compare October 17, 2026 16:10

fixup

9aaaf55

hbrunn requested changes Oct 23, 2026

View reviewed changes

hbrunn reviewed Oct 24, 2026

View reviewed changes

fixup hbrunn comments

dcb6784

bealdav force-pushed the 19-screen-help branch from 0381335 to dcb6784 Compare October 25, 2026 10:23

bealdav commented Oct 25, 2026

View reviewed changes

bealdav requested a review from hbrunn October 25, 2026 10:30

		FRONT_MATTER_RE = re.compile(r"\A---\s\n(.?)\n---\s*\n", re.DOTALL)


		def front_matter(text):

		from odoo import fields, models


		class IrActionsActWindow(models.Model):

Conversation

bealdav commented Oct 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hbrunn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bealdav commented Oct 23, 2026

Uh oh!

hbrunn commented Oct 24, 2026

Uh oh!

hbrunn Oct 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bealdav left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Uh oh!

Assignees

bealdav commented Oct 17, 2026 •

edited

Loading

hbrunn Oct 24, 2026 •

edited

Loading

bealdav left a comment •

edited

Loading