extension/packages/help.coffee

   1 utils             = require 'utils'
   2
   3 CONTAINER_ID = 'VimFxHelpDialogContainer'
   4
   5 removeHelp = (document) ->
   6   if div = document.getElementById CONTAINER_ID
   7     div.parentNode.removeChild div
   8
   9 injectHelp = (document, commandsHelp) ->
  10   if document.documentElement
  11     if div = document.getElementById CONTAINER_ID
  12       div.parentNode.removeChild div
  13     div = document.createElement 'div'
  14     div.id = CONTAINER_ID
  15     div.className = 'VimFxReset'
  16
  17     div.appendChild utils.parseHTML document, helpDialogHtml(commandsHelp)
  18
  19     document.documentElement.appendChild div
  20
  21     if button = document.getElementById('VimFxClose')
  22       clickHandler = (event) ->
  23         event.stopPropagation()
  24         event.preventDefault()
  25         removeHelp(document)
  26       button.addEventListener 'click', clickHandler, false
  27
  28 td = (text, klass='') ->
  29   """<td class="VimFxReset #{ klass }">#{ text }</td>"""
  30
  31 tr = (key, text) ->
  32   key = """#{ key } <span class="VimFxReset VimFxDot">&#8729;</span>"""
  33   """<tr class="VimFxReset">#{ td(key, 'VimFxSequence') }#{ td(text) }</tr>"""
  34
  35 table = (commands) ->
  36   """
  37   <table class="VimFxReset">
  38     #{ (tr(cmd, text) for cmd, text of commands).join('') }
  39   </table>
  40   """
  41
  42 section = (title, commands) ->
  43   """
  44   <div class="VimFxReset VimFxSectionTitle">#{ title }</div>
  45   #{ table(commands) }
  46   """
  47
  48 helpDialogHtml = (help) ->
  49   return """
  50
  51 <div id="VimFxHelpDialog" class="VimFxReset">
  52   <div class="VimFxReset VimFxHeader">
  53     <div class="VimFxReset VimFxTitle">
  54       <span class="VimFxReset VimFxTitleVim">Vim</span><span class="VimFxReset VimFxTitleFx">Fx</span>
  55       <span class="VimFxReset">#{ _('help') }</span>
  56     </div>
  57     <span class="VimFxReset VimFxVersion">#{ _('help_version') } #{ utils.getVersion() }</span>
  58     <a class="VimFxReset VimFxClose" id="VimFxClose" href="#">&#10006;</a>
  59     <div class="VimFxReset VimFxClearFix"></div>
  60   </div>
  61
  62   <div class="VimFxReset VimFxBody">
  63     <div class="VimFxReset VimFxColumn">
  64       #{ section(_('help_section_urls'),    help['urls']) }
  65       #{ section(_('help_section_nav'),     help['nav']) }
  66     </div>
  67     <div class="VimFxReset VimFxColumn">
  68       #{ section(_('help_section_tabs'),    help['tabs']) }
  69       #{ section(_('help_section_browse'),  help['browse']) }
  70       #{ section(_('help_section_misc'),    help['misc']) }
  71     </div>
  72     <div class="VimFxReset VimFxClearFix"></div>
  73   </div>
  74
  75   <div class="VimFxReset VimFxFooter">
  76     <div class="VimFxReset VimFxSocial">
  77       <p class="VimFxReset">
  78         #{ _('help_found_bug') }
  79         <a class="VimFxReset" target="_blank" href="https://github.com/akhodakivskiy/VimFx/issues">
  80           #{ _('help_report_bug') }
  81         </a>
  82       </p>
  83       <p class="VimFxReset">
  84         #{ _('help_enjoying') }
  85         <a class="VimFxReset" target="_blank" href="https://addons.mozilla.org/en-US/firefox/addon/vimfx/">
  86           #{ _('help_feedback') }
  87         </a>
  88       </p>
  89     </div>
  90   </div>
  91 </div>
  92
  93 """
  94
  95 exports.injectHelp = injectHelp
  96 exports.removeHelp = removeHelp