Skip to content

[19.0][MIG] screen_help: reinvented version of help_module - #653

Open
bealdav wants to merge 12 commits into
OCA:19.0from
akretion:19-screen-help
Open

bealdav wants to merge 12 commits into
OCA:19.0from
akretion:19-screen-help

Conversation

@bealdav

@bealdav bealdav commented Oct 17, 2026 •

Copy link
Copy Markdown
Member

Not a really critical module but convenient to document features

help1 help2 help3

cc @gurneyalex @hbrunn @dreispt

@bealdav bealdav mentioned this pull request Oct 17, 2026
5 of 6 tasks
@bealdav
bealdav marked this pull request as ready for review October 17, 2026 16:04

@hbrunn hbrunn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread screen_help/controllers/main.py Resolved
Comment thread screen_help/controllers/main.py Resolved
Comment thread screen_help/controllers/main.py Resolved
Comment thread screen_help/models/help_section.py Resolved
Comment thread screen_help/models/help_section.py Resolved
from odoo import fields, models


class IrActionsActWindow(models.Model):

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ie you want to write a help text for odoo/discuss, then you're out of luck because that's a client action. and there's a tendency to have more and more client actions in Odoo.
I'm not saying you should implement this right away, but I think it's prudent to make it possible in the data model. Comes with baggage of course.

Comment thread screen_help/readme/CONTRIBUTORS.md Resolved
<div class="o_help_content flex-grow-1" style="min-width: 0;">
<t t-out="0" />
</div>
</div>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this still seems like a very useful feature to me

Comment thread screen_help/models/help_section.py Resolved
@bealdav

bealdav commented Oct 23, 2026

Copy link
Copy Markdown
Member Author

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

hbrunn commented Oct 24, 2026

Copy link
Copy Markdown
Member

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.

Comment thread screen_help/models/help_section.py Resolved

@bealdav bealdav left a comment •

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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

Comment thread screen_help/models/help_section.py Resolved
Comment thread screen_help/controllers/main.py Resolved
Comment thread screen_help/readme/CONTRIBUTORS.md Resolved
Comment thread screen_help/controllers/main.py Resolved
Comment thread screen_help/models/help_section.py Resolved
from odoo import fields, models


class IrActionsActWindow(models.Model):

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread screen_help/controllers/main.py Resolved
Comment thread screen_help/models/help_section.py Resolved
@bealdav
bealdav requested a review from hbrunn October 25, 2026 10:30
@hbrunn

hbrunn commented Oct 30, 2026

Copy link
Copy Markdown
Member
* rename module as help, why not
* make it possible to display help near chatter place
* remove commits from help_module

I agree with all of this

@bealdav

bealdav commented Oct 30, 2026

Copy link
Copy Markdown
Member Author

Thanks @hbrunn , I'll also move this code to 20.0 instead of 19.0 because my customer finally go to 20.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants