You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@felix.apache.org by "Bertrand Delacretaz (JIRA)" <ji...@apache.org> on 2013/01/30 17:23:13 UTC

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

     [ https://issues.apache.org/jira/browse/FELIX-3880?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Bertrand Delacretaz updated FELIX-3880:
---------------------------------------

    Attachment: FELIX-3880.patch
    
> [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
>
>
> 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