[jira] [Commented] (FELIX-3880) [PATCH] placeholders for help links in the webconsole

["Carsten Ziegeler (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FELIX-3880?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13566585#comment-13566585 ] 

Carsten Ziegeler commented on FELIX-3880:
-----------------------------------------

While I think that help links are a good idea, it looks to me like each and every element gets a help link even if there is no help link for this element. Is this assumption correct?

In addition, I fail to see why we need this overridable mechanism for such a basic feature.

So I think we should rather define a service in the web console that gets called to deliver links for help texts or maybe the help text itself. The web console plugins supporting this, are calling this service and add the links or help dialogs where information is available.
The service can get a key to define the element which is kind of a url like "help:config:org.apache.felix.myservice" or "help:config:org.apache.felix.myservice:propA"
                
> [PATCH] placeholders for help links in the webconsole
> -----------------------------------------------------
>
>                 Key: FELIX-3880
>                 URL: https://issues.apache.org/jira/browse/FELIX-3880
>             Project: Felix
>          Issue Type: Improvement
>          Components: Web Console
>    Affects Versions: webconsole-4.0.0
>            Reporter: Bertrand Delacretaz
>            Priority: Minor
>             Fix For: webconsole-4.0.2
>
>         Attachments: FELIX-3880.patch, helplinks.jpg
>
>
> The attached patch adds placeholders for help links to the webconsole, like
> <span 
>   class="configHelpLink" 
>   data-config-param="ds.loglevel" 
>   data-config-pid="org.apache.felix.scr.ScrService" 
>   data-config-name="SCR Log Level" 
>   data-config-description="Allows limiting the amount..." >
> </span>
> which can be enhanced with client-side javascript to build customized help links.
> The patch also adds a script reference at the end of the config page:
> <script 
>   type="text/javascript" 
>   src="/system/console/overridable/scripts/confighelp.js"></script>
> which by default points to an empty script provided by the FELIX-3879 mechanism, overridable by providing a Servlet service that returns the desired code.
> I have created an example such servlet/script at https://github.com/bdelacretaz/felix-confighelp-demo, to test this feature:
> -Apply the FELIX-3879 patch and this patch and install the patched webconsole
> -Install the felix-confighelp-demo bundle
> -The /system/console/overridable/scripts/confighelp.js path must then return the felix-confighelp-demo's confighelp.js script
> -Open a config form in the console, help links should be present next to each parameter, which point to google.com for the demo

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira