updated keyboead.js docs...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2014-01-18 05:34:46 +04:00
parent 0127e6427c
commit 8ab6300ef5

View File

@ -673,10 +673,30 @@ function buildKeybindingsHelpHTML(keybindings){
// Build HTML for a single key definition... // Build HTML for a single key definition...
// //
// Format if combining sections (default):
// <span class="key-doc">
// <span class="doc"> DOC </span>
// <span class="keys"> KEYS </span>
// </span>
//
// Format if not combining sections:
// <span class="key-doc">
// <span class="doc"> DOC </span>
// <span class="section">
// <span class="name"> MODE NAME </span>
// <span class="keys"> KEYS </span>
// </span>
// ...
// </span>
//
// XXX not yet sure if we are handling the sections correctly... // XXX not yet sure if we are handling the sections correctly...
function getKeysByDocHTML(doc, help, combine_sections){ function getKeysByDocHTML(doc, help, combine_sections){
combine_sections = combine_sections == null ? true : combine_sections
var spec = getKeysByDoc(doc, help) var spec = getKeysByDoc(doc, help)
var res = '<span class="key-doc">' var res = '<span class="key-doc">'
res += '<span class="doc">'+ doc +'</span>'
var keys = [] var keys = []
@ -685,7 +705,7 @@ function getKeysByDocHTML(doc, help, combine_sections){
keys = spec[section].join(', ') keys = spec[section].join(', ')
res += '<span class="section">' res += '<span class="section">'
+'<span class="name">'+ section +'</span>' +'<span class="name">'+ section +'</span>'
+'<span class="key">'+ keys +'</span>' +'<span class="keys">'+ keys +'</span>'
+'</span>' +'</span>'
} else { } else {
keys = keys.concat(spec[section]) keys = keys.concat(spec[section])
@ -693,8 +713,7 @@ function getKeysByDocHTML(doc, help, combine_sections){
} }
if(combine_sections){ if(combine_sections){
res += '<span class="doc">'+ doc +'</span>' res += '<span class="keys">'+ keys.join(', ') +'</span>'
+'<span class="key">'+ keys.join(', ') +'</span>'
} }
return res + '</span>' return res + '</span>'