[Kimchi-devel] [PATCH V2] Detect and enable help page from plugins tabs

Rodrigo Trujillo rodrigo.trujillo at linux.vnet.ibm.com
Wed Aug 27 22:18:54 UTC 2014


V1:
Kimchi is currently not able to configure and open help pages of any
plugin tab. This patch fixes this problem and removes the HELP button
if the plugin does not have a help configured properly.

Help pages for a plugin tab follow same Kimchi system:
   - html help file should have the same name of plugin html tab file
   - html files should be in plugin's " ui/pages/help/<LANG> " path
   - plugin should add following lines to <PLUGIN_NAME>.conf:
        * [/help]
        * tools.staticdir.on = True
        * tools.nocache.on = True
   - plugins should add a <help> element with tab help html name in
     "ui/config/tab-ext.xml", for each configured tab. If this
     element does not exist, 'Help' will be disabled

V2:
- Changed the way that tab help html is being checked.
- Now, all tabs have the help html file checked (per language)

You can check enabling Sample plugin. Go to plugin Sample tab.
For en_US, the help button will be enabled. But if you logout
and change to other language, the help button will be disabled,
because the sample plugin does not have help in other languages.


Rodrigo Trujillo (1):
  Detect and enable help pages for tabs and plugin tabs

 plugins/sample/sample.conf.in               |  4 ++++
 plugins/sample/ui/pages/help/en_US/tab.html |  1 +
 src/kimchi/config.py.in                     |  1 +
 src/kimchi/utils.py                         |  9 ++++++--
 ui/js/src/kimchi.main.js                    | 36 ++++++++++++++++++++++++++++-
 5 files changed, 48 insertions(+), 3 deletions(-)
 create mode 100644 plugins/sample/ui/pages/help/en_US/tab.html

-- 
1.9.3




More information about the Kimchi-devel mailing list