DRY: style in one place, removed code duplication

IPython/html/static/notebook/js/quickhelp.js

@@ -1,153 +1,126
 //----------------------------------------------------------------------------
 //  Copyright (C) 2008-2011  The IPython Development Team
 //
 //  Distributed under the terms of the BSD License.  The full license is in
 //  the file COPYING, distributed as part of this software.
 //----------------------------------------------------------------------------
 
 //============================================================================
 // QuickHelp button
 //============================================================================
 
 var IPython = (function (IPython) {
     "use strict";
 
     var QuickHelp = function (selector) {
     };
 
     QuickHelp.prototype.show_keyboard_shortcuts = function () {
         // toggles display of keyboard shortcut dialog
         var that = this;
         if ( this.force_rebuild ) {
             delete(this.shortcut_dialog);
             this.force_rebuild = false;
         }
         if ( this.shortcut_dialog ){
             // if dialog is already shown, close it
             $(this.shortcut_dialog).modal("toggle");
             return;
         }
         var command_shortcuts = IPython.keyboard_manager.command_shortcuts.help();
         var edit_shortcuts = IPython.keyboard_manager.edit_shortcuts.help();
         var help, shortcut;
         var i, half, n;
         var element = $('<div/>');
 
         // The documentation
         var doc = $('<div/>').addClass('alert');
         doc.append(
             $('<button/>').addClass('close').attr('data-dismiss','alert').html('&times;')
         ).append(
             'The IPython Notebook has two different keyboard input modes. <b>Edit mode</b> '+
             'allows you to type code/text into a cell and is indicated by a green cell '+
             'border. <b>Command mode</b> binds the keyboard to notebook level actions '+
             'and is indicated by a grey cell border.'
         )
         element.append(doc);
 
         // Command mode
         var cmd_div = this.build_command_help();
         element.append(cmd_div);
 
         // Edit mode
         var edit_div = this.build_edit_help();
         element.append(edit_div);
 
         this.shortcut_dialog = IPython.dialog.modal({
             title : "Keyboard shortcuts",
             body : element,
             destroy : false,
             buttons : {
                 Close : {}
             }
         });
         
         $([IPython.events]).on('rebuild.QuickHelp', function() { that.force_rebuild = true;});
     };
 
     QuickHelp.prototype.build_command_help = function () {
         var command_shortcuts = IPython.keyboard_manager.command_shortcuts.help();
-        var help, shortcut;
-        var i, half, n;
-
-        // Command mode
-        var cmd_div = $('<div/>').append($('<h4>Command Mode (press <code>Esc</code> to enable)</h4>'));
-        var cmd_sub_div = $('<div/>').addClass('hbox');
-        var cmd_col1 = $('<div/>').addClass('box-flex0');
-        var cmd_col2 = $('<div/>').addClass('box-flex0');
-        n = command_shortcuts.length;
-        half = ~~(n/2);  // Truncate :)
-        for (i=0; i<half; i++) {
-            help = command_shortcuts[i]['help'];
-            shortcut = prettify(command_shortcuts[i]['shortcut']);
-            cmd_col1.append($('<div>').addClass('quickhelp').
-                append($('<span/>').addClass('shortcut_key').text(shortcut)).
-                append($('<span/>').addClass('shortcut_descr').text(' : ' + help))
-            );
-        };
-        for (i=half; i<n; i++) {
-            help = command_shortcuts[i]['help'];
-            shortcut = prettify(command_shortcuts[i]['shortcut']);
-            cmd_col2.append($('<div>').addClass('quickhelp').
-                append($('<span/>').addClass('shortcut_key').text(shortcut)).
-                append($('<span/>').addClass('shortcut_descr').text(' : ' + help))
-            );
-        };
-        cmd_sub_div.append(cmd_col1).append(cmd_col2);
-        cmd_div.append(cmd_sub_div);
-        return cmd_div;
+        return build_div('<h4>Command Mode (press <code>Esc</code> to enable)</h4>', command_shortcuts);
     }
 
     var special_case = { pageup: "PageUp", pagedown: "Page Down" };
     var prettify = function (s) {
         var keys = s.split('+');
         var k, i;
         for (i in keys) {
             k = keys[i];
-            if ( k.length == 1 ) continue; // leave individual keys lower-cased
+            if ( k.length == 1 ) {
+                keys[i] = "<code><strong>" + k + "</strong></code>";
+                continue; // leave individual keys lower-cased
+            }
             keys[i] = ( special_case[k] ? special_case[k] : k.charAt(0).toUpperCase() + k.slice(1) );
+            keys[i] = "<code><strong>" + keys[i] + "</strong></code>";
         }
         return keys.join('-');
 
 
     };
 
     QuickHelp.prototype.build_edit_help = function () {
         var edit_shortcuts = IPython.keyboard_manager.edit_shortcuts.help();
-        var help, shortcut;
-        var i, half, n;
-
         // Edit mode
-        var edit_div = $('<div/>').append($('<h4>Edit Mode (press <code>Enter</code> to enable)</h4>'));
-        var edit_sub_div = $('<div/>').addClass('hbox');
-        var edit_col1 = $('<div/>').addClass('box-flex0');
-        var edit_col2 = $('<div/>').addClass('box-flex0');
-        n = edit_shortcuts.length;
+        return build_div('<h4>Edit Mode (press <code>Enter</code> to enable)</h4>', edit_shortcuts);
+    }
+
+    var build_one = function (s) {
+        var help = s['help'];
+        var shortcut = prettify(s['shortcut']);
+        return $('<div>').addClass('quickhelp').
+            append($('<span/>').addClass('shortcut_key').append($(shortcut))).
+            append($('<span/>').addClass('shortcut_descr').text(' : ' + help))
+
+    }
+
+    var build_div = function (title, shortcuts) {
+        var i, half, n;
+        var div = $('<div/>').append($(title));
+        var sub_div = $('<div/>').addClass('hbox');
+        var col1 = $('<div/>').addClass('box-flex0');
+        var col2 = $('<div/>').addClass('box-flex0');
+        n = shortcuts.length;
         half = ~~(n/2);  // Truncate :)
-        for (i=0; i<half; i++) {
-            help = edit_shortcuts[i]['help'];
-            shortcut = prettify(edit_shortcuts[i]['shortcut']);
-            edit_col1.append($('<div>').addClass('quickhelp').
-                append($('<span/>').addClass('shortcut_key').text(shortcut)).
-                append($('<span/>').addClass('shortcut_descr').text(' : ' + help))
-            );
-        };
-        for (i=half; i<n; i++) {
-            help = edit_shortcuts[i]['help'];
-            shortcut = prettify(edit_shortcuts[i]['shortcut']);
-            edit_col2.append($('<div>').addClass('quickhelp').
-                append($('<span/>').addClass('shortcut_key').text(shortcut)).
-                append($('<span/>').addClass('shortcut_descr').text(' : ' + help))
-            );
-        };
-        edit_sub_div.append(edit_col1).append(edit_col2);
-        edit_div.append(edit_sub_div);
-        return edit_div;
+        for (i=0; i<half; i++) { col1.append( build_one(shortcuts[i]) ); };
+        for (i=half; i<n; i++) { col2.append( build_one(shortcuts[i]) ); };
+        sub_div.append(col1).append(col2);
+        div.append(sub_div);
+        return div;
     }
 
     // Set module variables
     IPython.QuickHelp = QuickHelp;
 
     return IPython;
 
 }(IPython));