[exercise,exercise2] make buttons & hotkeys configurable

Author: jcb91

src/jupyter_contrib_nbextensions/nbextensions/exercise/exercise.yaml

@@ -1,7 +1,28 @@
-Type: IPython Notebook Extension
+Type: Jupyter Notebook Extension
 Name: Exercise
-Description: Exercise - Define a group of cells as a "solution". Then it is possible to hide/show these solutions cells by clicking on a cell widget.
+Description: |
+  Define a group of cells as an "exercise".
+  The first cell is the question,
+  while the rest of the group from the answer or solution.
+  The solution can be hidden/shown by clicking on a widget added to the
+  question cell.
 Link: readme.md
 Icon: icon.png
 Main: main.js
 Compatibility: 4.x, 5.x
+Parameters:
+
+- name: add_button
+  description: Add a toolbar button to create/remove an exercise
+  input_type: checkbox
+  default: true
+
+- name: use_hotkey
+  description: Add a keyboard shortcut to create/remove an exercise
+  input_type: checkbox
+  default: true
+
+- name: hotkey
+  description: Keyboard shortcut optionally used to create/remove an exercise
+  input_type: hotkey
+  default: 'Alt-D'

src/jupyter_contrib_nbextensions/nbextensions/exercise/main.js

@@ -30,6 +30,12 @@ define([
 ], function(IPython, $, requirejs, events) {
     "use strict";
 
+    var cfg = {
+        add_button: true,
+        use_hotkey: true,
+        hotkey: 'Alt-S',
+    };
+
     /**
      * handle click event
      *
@@ -141,8 +147,20 @@ define([
             handler : create_remove_exercise
         }, 'create_remove_exercise', 'exercise');
 
-        IPython.toolbar.add_buttons_group([action_name]);
-        IPython.keyboard_manager.command_shortcuts.add_shortcuts({'Alt-S': action_name}});
+        IPython.notebook.config.loaded.then(function() {
+            $.extend(true, cfg, IPython.notebook.config.data);
+
+            if (cfg.add_button) {
+                IPython.toolbar.add_buttons_group([action_name]);
+            }
+            if (cfg.use_hotkey && cfg.hotkey) {
+                var cmd_shrts = {};
+                cmd_shrts[cfg.hotkey] = action_name;
+                IPython.keyboard_manager.command_shortcuts.add_shortcuts(cmd_shrts);
+            }
+        }).catch(function(err) {
+            console.warn('[exercise] error:', err);
+        });
     }
 
     return {

src/jupyter_contrib_nbextensions/nbextensions/exercise2/exercise2.yaml

@@ -1,7 +1,28 @@
-Type: IPython Notebook Extension
+Type: Jupyter Notebook Extension
 Name: Exercise2
-Description: Exercise2 - Define a group of cells as a "solution". Then it is possible to hide/show these solutions cells by clicking on a cell widget.
+Description: |
+  Define a group of cells as an "exercise".
+  The first cell is the question,
+  while the rest of the group from the answer or solution.
+  The solution can be hidden/shown by clicking on a widget added to the
+  question cell.
 Link: readme.md
 Icon: icon.png
 Main: main.js
 Compatibility: 4.x, 5.x
+Parameters:
+
+- name: add_button
+  description: Add a toolbar button to create/remove an exercise
+  input_type: checkbox
+  default: true
+
+- name: use_hotkey
+  description: Add a keyboard shortcut to create/remove an exercise
+  input_type: checkbox
+  default: true
+
+- name: hotkey
+  description: Keyboard shortcut optionally used to create/remove an exercise
+  input_type: hotkey
+  default: 'Alt-D'

src/jupyter_contrib_nbextensions/nbextensions/exercise2/main.js

@@ -16,6 +16,12 @@ define([
 ], function(IPython, $, requirejs, events) {
     "use strict";
 
+    var cfg = {
+        add_button: true,
+        use_hotkey: true,
+        hotkey: 'Alt-D',
+    };
+
     /**
      * handle click event
      *
@@ -141,8 +147,20 @@ define([
             handler   : create_remove_exercise,
         }, 'create_remove_exercise', 'exercise2');
 
-        IPython.toolbar.add_buttons_group([action_name]);
-        IPython.keyboard_manager.command_shortcuts.add_shortcuts({'Alt-D': action_name}});
+        return IPython.notebook.config.loaded.then(function() {
+            $.extend(true, cfg, IPython.notebook.config.data.exercise2);
+
+            if (cfg.add_button) {
+                IPython.toolbar.add_buttons_group([action_name]);
+            }
+            if (cfg.use_hotkey && cfg.hotkey) {
+                var cmd_shrts = {};
+                cmd_shrts[cfg.hotkey] = action_name;
+                IPython.keyboard_manager.command_shortcuts.add_shortcuts(cmd_shrts);
+            }
+        }).catch(function(err) {
+            console.warn('[exercise2] error:', err);
+        });
     }
 
     return {