Make keyboard shortcuts declarative

docs/source/extending/index.rst

@@ -12,3 +12,4 @@ override the notebook's defaults with your own custom behavior.
     contents
     savehooks
     handlers
+    keymaps

docs/source/extending/keymaps.rst

@@ -0,0 +1,88 @@
+Customize keymaps
+=================
+
+.. note::
+
+    DEclarative Custom Keymaps is a provisional feature with unstable API which is not
+    guarantied to be keep in future versions odf the notebook, and can be
+    removed or changed without warnings. 
+
+The notebook shortcuts that are defined by jupyter both in edit mode an command
+mode are configurable in the frontend configuration file
+``~/.jupyter/nbconfig/notebook.json``. The modification of Keyboard shortcut
+suffer of several limitations, mainly that your Browser and OS might prevent
+certain shortcut to work correctly. If this is the case, there are
+unfortunately not much than can be done. The second issue can arise with
+keyboard that have a layout different than US English. Again even if we are
+aware of the issue, there is not much we can do about that. 
+
+Shortcut are also limited by the underlying library that handle code and text
+edition: CodeMirror. If some Keyboard shortcuts are conflicting, the method
+describe below might not work to create new keyboard shortcuts, especially in
+the ``edit`` mode of the notebook. 
+
+
+The 4 sections of interest in ``~/.jupyter/nbconfig/notebook.json`` are the following: 
+
+  - ``keys.command.unbind``
+  - ``keys.edit.unbind``
+  - ``keys.command.bind``
+  - ``keys.edit.bind``
+
+The first two section describe which default keyboard shortcut not to register
+at notebook startup time. These are mostly useful if you need to ``unbind`` a
+default keyboard shortcut before binding it to a new ``command``. 
+
+These two first sections apply respectively to the ``command`` and ``edit``
+mode of the notebook. They take a list of shortcut to ``unbind``.
+
+For example, to unbind the shortcut to split a cell at the position of the
+cursor (``Ctrl-Shift-Minus``)use the  following:
+
+.. code:: javascript
+
+    // file ~/.jupyter/nbconfig/notebook.json
+
+    {
+      "keys": {
+        "edit": {
+          "unbind": [
+            "Ctrl-Shift-Minus"
+          ]
+        },
+      },
+    }
+
+
+
+
+The last two section describe which new keyboard shortcut to register
+at notebook startup time, and which actions they trigger. 
+
+These two last sections apply respectively to the ``command`` and ``edit`` mode of the notebook. 
+They take a dictionary with shortcuts as ``keys`` and ``commands`` name as value.
+
+For example, to bind the shortcut ``G,G,G`` (Press G three time in a row) in
+command mode, to the command that restart the kernel and run all cells, use the
+following:
+
+
+.. code:: javascript
+
+    // file ~/.jupyter/nbconfig/notebook.json
+
+    {
+      "keys": {
+        "command": {
+            "bind": {
+                "G,G,G":"jupyter-notebook:restart-kernel-and-run-all-cells"
+            }
+        }
+      },
+    }
+
+
+
+
+The name of the available ``commands`` can be find by hovering the right end of
+a row in the command palette. 

notebook/static/base/js/keyboard.js

@@ -396,6 +396,10 @@ define([
          * Remove the binding of shortcut `sortcut` with its action.
          * throw an error if trying to remove a non-exiting shortcut
          **/
+        if(!shortcut){
+            console.warn('trying to remove empty shortcut');
+            return;
+        }
         shortcut = normalize_shortcut(shortcut);
         if( typeof(shortcut) === 'string'){
             shortcut = shortcut.split(',');
@@ -404,8 +408,8 @@ define([
          *  The shortcut error should be explicit here, because it will be
          *  seen by users.
          */
-        try
-        {
+        var that = this;
+        try {
           this._remove_leaf(shortcut, this._shortcuts);
           if (!suppress_help_update) {
             // update the keyboard shortcuts notebook help

notebook/static/deprecated-imports.js

@@ -76,4 +76,4 @@
             "notebookApp['" + modulePath + "']});`"].join(' '));
         return notebookApp[modulePath];
     });
-});
+});

notebook/static/notebook/js/celltoolbarpresets/attachments.js

@@ -43,8 +43,7 @@ define([
       attachments_preset.push('attachments.edit');
 
       CellToolbar.register_preset('Attachments', attachments_preset, notebook);
-      console.log('Attachments editing toolbar loaded.');
 
     };
-    return {'register' : register}
+    return {'register' : register};
 });

notebook/static/notebook/js/celltoolbarpresets/default.js

@@ -44,7 +44,6 @@ define([
         example_preset.push('default.rawedit');
 
         CellToolbar.register_preset('Edit Metadata', example_preset, notebook);
-        console.log('Default extension for cell metadata editing loaded.');
     };
     return {'register': register};
 });

notebook/static/notebook/js/celltoolbarpresets/rawcell.js

@@ -78,7 +78,6 @@ define([
     raw_cell_preset.push('raw_cell.select');
 
     CellToolbar.register_preset('Raw Cell Format', raw_cell_preset, notebook);
-    console.log('Raw Cell Format toolbar preset loaded.');
   };
   return {'register': register};
 

notebook/static/notebook/js/celltoolbarpresets/slideshow.js

@@ -39,7 +39,6 @@ define([
         slideshow_preset.push('slideshow.select');
 
         CellToolbar.register_preset('Slideshow',slideshow_preset, notebook);
-        console.log('Slideshow extension for metadata editing loaded.');
     };
     return {'register': register};
 });

notebook/static/notebook/js/commandpalette.js

@@ -169,7 +169,7 @@ define(function(require){
           group: ["group", "{{group}} command group"],
           searchOnFocus: true,
           mustSelectItem: true,
-          template: '<i class="fa fa-icon {{icon}}"></i>{{display}}  <div class="pull-right {{mode_shortcut}}">{{shortcut}}</div>',
+          template: '<i class="fa fa-icon {{icon}}"></i>{{display}}  <div title={{key}} class="pull-right {{mode_shortcut}}">{{shortcut}}</div>',
           order: "asc",
           source: src,
           callback: {

notebook/static/notebook/js/keyboardmanager.js

@@ -42,6 +42,46 @@ define([
         this.edit_shortcuts = new keyboard.ShortcutManager(undefined, options.events, this.actions, this.env);
         this.edit_shortcuts.add_shortcuts(this.get_default_common_shortcuts());
         this.edit_shortcuts.add_shortcuts(this.get_default_edit_shortcuts());
+
+
+        this.config = options.config;
+        var that = this;
+
+        this.config.loaded.then(function(){ 
+            var edit_unbind;
+
+            try {
+                edit_unbind = that.config.data.keys.edit.unbind;
+            } catch (e) {
+                if (e instanceof TypeError) {
+                    edit_unbind = [];
+                } else {
+                    throw e;
+                }
+            }
+
+            edit_unbind.forEach(function(u){that.edit_shortcuts.remove_shortcut(u);});
+
+            var command_unbind;
+
+            try {
+                command_unbind = that.config.data.keys.command.unbind;
+            } catch (e) {
+                if (e instanceof TypeError) {
+                    command_unbind = [];
+                } else {
+                    throw e;
+                }
+            }
+
+            command_unbind.forEach(function(u){that.command_shortcuts.remove_shortcut(u);});
+
+            that.command_shortcuts.add_shortcuts( ((that.config.data.keys||{}).command||{}).bind);
+            that.edit_shortcuts.add_shortcuts(    ((that.config.data.keys||{}).edit   ||{}).bind);
+
+            }
+        );
+
         Object.seal(this);
     };
 

notebook/static/notebook/js/main.js

@@ -84,7 +84,9 @@ require([
     var keyboard_manager = new keyboardmanager.KeyboardManager({
         pager: pager,
         events: events,
-        actions: acts });
+        actions: acts, 
+        config: config_section,
+    });
     var save_widget = new savewidget.SaveWidget('span#save_widget', {
         events: events,
         keyboard_manager: keyboard_manager});

notebook/static/notebook/js/notebook.js

@@ -164,6 +164,7 @@ define(function (require) {
         Object.seal(this);
     };
 
+
     Notebook.options_default = {
         // can be any cell type, or the special values of
         // 'above', 'below', or 'selected' to get the value from another cell.
@@ -2410,7 +2411,7 @@ define(function (require) {
           var cell = cells[i];
           cell.remove_unused_attachments();
       }
-    }
+    };
 
     /**
      * Load a notebook from JSON (.ipynb).

notebook/static/notebook/js/quickhelp.js

@@ -189,7 +189,7 @@ define([
         doc.append(
             'The Jupyter 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 '+
+            'border. <b>Command mode</b> binds the keyboard to notebook level commands '+
             'and is indicated by a grey cell border with a blue left margin.'
         );
         element.append(doc);

notebook/static/notebook/less/commandpalette.less

@@ -29,11 +29,12 @@ ul.typeahead-list {
 }
 
 .no-shortcut{
-    display:none;
+    min-width: 20px;
+    color: transparent;
 }
 
 .command-shortcut:before{
-    content:"(command)";
+    content:"(command mode)";
     padding-right:3px;
     color:@gray-light;
 }

notebook/static/services/config.js

@@ -81,7 +81,7 @@ function(utils) {
         if (this.classname) {
             return this.section.data[this.classname] || {};
         } else {
-            return this.section.data
+            return this.section.data;
         }
     };
 
@@ -92,7 +92,7 @@ function(utils) {
     ConfigWithDefaults.prototype.get = function(key) {
         var that = this;
         return this.section.loaded.then(function() {
-            return that._class_data()[key] || that.defaults[key]
+            return that._class_data()[key] || that.defaults[key];
         });
     };