Univention Bugzilla – Full Text Bug Listing |
Summary: | help button for every module which links to online documentation | ||
---|---|---|---|
Product: | UCS | Reporter: | Alexander Kläser <klaeser> |
Component: | UMC (Generic) | Assignee: | Stefan Gohmann <gohmann> |
Status: | CLOSED FIXED | QA Contact: | Alexander Kramer <kramer> |
Severity: | enhancement | ||
Priority: | P4 | CC: | best, gohmann, hahn, klaeser, schwardt |
Version: | UCS 3.2 | Keywords: | interim-3 |
Target Milestone: | UCS 4.0 | ||
Hardware: | Other | ||
OS: | Linux | ||
See Also: |
https://forge.univention.org/bugzilla/show_bug.cgi?id=32037 https://forge.univention.org/bugzilla/show_bug.cgi?id=35654 |
||
What kind of report is it?: | --- | What type of bug is this?: | --- |
Who will be affected by this bug?: | --- | How will those affected feel about the bug?: | --- |
User Pain: | Enterprise Customer affected?: | ||
School Customer affected?: | ISV affected?: | ||
Waiting Support: | Flags outvoted (downgraded) after PO Review: | ||
Ticket number: | Bug group (optional): | Usability | |
Max CVSS v3 score: | |||
Bug Depends on: | |||
Bug Blocks: | 36435 | ||
Attachments: | Example screenshot for Help icon. |
Description
Alexander Kläser
2013-07-19 18:13:00 CEST
This has been requested for the printer module for UCS 3.2. Any suggestion where the link could be placed and how it should look like? (Note also the comment from Alexander Kläser from Bug #30517 comment #1) > I could also imagine that a dialog opens which includes the corresponding > part of the documentation directly. (In reply to Florian Best from comment #2) > (Note also the comment from Alexander Kläser from Bug #30517 comment #1) > > I could also imagine that a dialog opens which includes the corresponding > > part of the documentation directly. Let's start with a simple link to see how it works and how it will be used. (In reply to Stefan Gohmann from comment #1) > This has been requested for the printer module for UCS 3.2. Any suggestion > where the link could be placed and how it should look like? Hm, maybe as a ?-icon in the module header or so? Created attachment 6090 [details]
Example screenshot for Help icon.
See the attached faked screenshot. I could imagine a ?-Icon at the top right position in the module. The green colour is the same green as for the buttons and has 50% opacity by default and 100% opacity on mouseOver.
That looks really good. We should add the possibility to add such a link. I think it should be a value in the UDM module, for example: help_link=_('http://docs.univention.de/manual-3.2.html#print::shares') The translation for de could use the translated link: http://docs.univention.de/handbuch-3.2.html#print::shares Alternatively we could generate the link automatically but I think this more flexible. (In reply to Stefan Gohmann from comment #6) > That looks really good. We should add the possibility to add such a link. I > think it should be a value in the UDM module, for example: > help_link=_('http://docs.univention.de/manual-3.2.html#print::shares') > > The translation for de could use the translated link: > http://docs.univention.de/handbuch-3.2.html#print::shares > > Alternatively we could generate the link automatically but I think this more > flexible. If we implement this as UDM module property we are not able to use that feature in UCS@school… (In reply to Stefan Gohmann from comment #6) > That looks really good. We should add the possibility to add such a link. I > think it should be a value in the UDM module, for example: > help_link=_('http://docs.univention.de/manual-3.2.html#print::shares') > > The translation for de could use the translated link: > http://docs.univention.de/handbuch-3.2.html#print::shares There is Bug #32037 comment 3 which asks to unify the section ID between different translations, as this simplifies the fallback mechanism to the English documentation when no localized documentation exists. Therefore 'http://docs.univention.de/%(lang)s-%(version).html#%(section)s' % { 'lang': 'manual', # FIXME 'version': '3.2', 'section': 'print::shares', } (In reply to Florian Best from comment #7) > If we implement this as UDM module property we are not able to use that > feature in UCS@school… Could also be JS feature, such that it can be set via JS, as well. A handler python module can now define a property 'help_link' which is either a string (url) or a dict:
> defaults = {'lang': _('manual'), 'version': ucr.get('version/version', ''), 'section': ''}
> defaults.update(help_link)
> help_link = 'http://docs.univention.de/%(lang)s-%(version).html#%(section)s' % defaults
Leaving the bug open because not yet touched any handler module and no changelog.
@Alex: The solution is not generic, it is simply defining a headerButton which does window.open(help_link).
You can add the help_link to the wanted modules. (In reply to Florian Best from comment #11) > You can add the help_link to the wanted modules. Excellent. I've added one to the printers module: r55112 Changelog for printers module: r55115 Bug for more help links: Bug #36346 printers module OK - Firefox OK - Chrome OK - IE 9/10/11 added a link to users.py on my vm OK - Firefox OK - Chrome OK - IE 9/10/11 UCS 4.0-0 has been released: http://docs.univention.de/release-notes-4.0-0-en.html http://docs.univention.de/release-notes-4.0-0-de.html If this error occurs again, please use "Clone This Bug". |