').addClass("col-xs-4 col-sm-6");
+ col_right.appendTo(ext_row);
+
+ // Extension icon
+ if (extension.hasOwnProperty('Icon')) {
+ $('', {'class': 'nbext-icon'}).append(
+ $('![]()
', {
+ 'src': base_url + extension.url + '/' + extension['Icon'],
+ 'alt': extension.Name + ' icon'
+ })
+ ).appendTo(col_right);
+ }
+
+ var col_left = $('').addClass("col-xs-8 col-sm-6");
+ // put left col before right col
+ col_left.prependTo(ext_row);
+
+ // Extension name
+ var ext_name_head = $('
').append(
+ $('', {'class': 'nbext-title'}).html(extension.Name)
+ );
+ ext_name_head.appendTo(col_left);
+
+ // Extension compatibility & description
+ var div_compat_and_desc = $('').addClass('nbext-desc');
+ div_compat_and_desc.appendTo(col_left);
+
+ if (extension.hasOwnProperty('Description')) {
+ div_compat_and_desc.append(
+ $('').text(extension['Description'])
+ );
+ }
+
+ if (extension.Link !== undefined) {
+ var link = extension.Link;
+ if (!/^(f|ht)tps?:\/\//i.test(link)) {
+ link = base_url + 'rendermd/' + extension['url'] +'/' + link;
+ }
+ link = $('').attr('href', link).text('more...');
+ link.appendTo(div_compat_and_desc);
+ }
+
+ var span_compat_wrap = $('');
+ span_compat_wrap.text('compatibility: ');
+ span_compat_wrap.appendTo(div_compat_and_desc);
+
+ var compat = extension.Compatibility || "?.x";
+ var span_compat = $('');
+ span_compat.text(compat);
+ var is_compat = compat.toLowerCase().indexOf(
+ IPython.version.substring(0, 2) + 'x') >= 0;
+ span_compat.addClass('nbext-compat-' + is_compat);
+ if (!is_compat) ext_row.addClass('nbext-compat');
+ span_compat.appendTo(span_compat_wrap);
+
+ // Activate/Deactivate buttons
+ build_activate_buttons(ext_id).appendTo(col_left);
+ var ext_url = get_ext_url(extension);
+ set_buttons_active(
+ ext_id,
+ config.data.load_extensions[ext_url] === true
+ );
+
+ if (!extension.hasOwnProperty('Parameters')) continue;
+ var params = extension['Parameters'];
+
+ // Assemble and add params
+ var div_param_list = $('', {'class' : 'nbext-params'});
+ div_param_list.appendTo(col_left);
+
+ for (var param_name in params) {
+ if (!params.hasOwnProperty(param_name)) continue;
+ var param = params[param_name];
+ console.log('Found ext param:', param_name);
+
+ var param_div = $('', {
+ 'class' : 'nbext-param'});
+ param_div.appendTo(div_param_list);
+
+ if (param.hasOwnProperty('description')) {
+ // param description
+ $('', {'class' : 'nbext-param-desc'}).html(
+ param['description']
+ ).appendTo(param_div);
+ }
+ else {
+ // param name
+ $('', {'class' : 'nbext-param-name'}).text(
+ param_name
+ ).appendTo(param_div);
+ }
+
+ // input to configure the param
+ var input = build_param_input(param);
+ input.attr('id', param_id_prefix + param_name);
+ input.appendTo(param_div);
+
+ // set input value form config or default, if poss
+ if (config.data.hasOwnProperty(param_name)) {
+ var configval = config.data[param_name];
+ console.log(
+ 'ext parameter',
+ param_name,
+ 'loaded from config as:',
+ configval);
+ set_input_value(input, configval);
+ }
+ else if (param.hasOwnProperty('default')) {
+ set_input_value(input, param['default']);
+ }
+ }
+ }
+
+ var hide_incompat = true;
+ if (config.data.hasOwnProperty('nbext_hide_incompat')) {
+ hide_incompat = config.data['nbext_hide_incompat'];
+ console.log(
+ 'nbext_hide_incompat loaded from config as: ',
+ hide_incompat
+ );
+ }
+ set_hide_incompat(hide_incompat);
+ };
+
+ /**
+ * Add CSS file to page
+ *
+ * @param name filename
+ */
+ var add_css = function (name) {
+ var link = document.createElement("link");
+ link.type = "text/css";
+ link.rel = "stylesheet";
+ link.href = require.toUrl(name);
+ document.getElementsByTagName("head")[0].appendChild(link);
+ };
+
+ // finally, actually do the work
+ add_css('/nbextensions/config/main.css');
+ config.loaded.then(build_page);
+ config.load();
+ nbext_config_page.show();
+});
diff --git a/nbextensions/config/readme.md b/nbextensions/config/readme.md
new file mode 100644
index 0000000..a47c332
--- /dev/null
+++ b/nbextensions/config/readme.md
@@ -0,0 +1,65 @@
+# Introduction
+
+The Jupyter notebook functionality (i.e. what you do with the Browser) can be extended using Javascript extensions.
+This page allows you to activate or deacivate installed notebook extensions, if they provide a `YAML` file description.
+
+Activating an extension means it is loaded automatically when working with a notebook document.
+
+If you encounter problems with this page, please create an issue at the [ipython-contrib](https://github.com/ipython-contrib/IPython-notebook-extensions) repository.
+
+## Checking/loading notebook extension manually from IPython
+You can check if the directory or a file (or list of files) exists:
+```Python
+import notebook
+notebook.nbextensions.check_nbextension('usability/codefolding', user=True)
+notebook.nbextensions.check_nbextension('usability/codefolding/main.js', user=True)
+```
+Make sure to use `user=True` if you have the extensions installed in your local path (in `jupyter_data_dir()`).
+
+To enable an extension:
+```Python
+import notebook
+E = notebook.nbextensions.EnableNBExtensionApp()
+E.enable_nbextension('usability/codefolding/main')
+```
+
+To disable an extension:
+```Python
+import notebook
+D = notebook.nbextensions.DisableNBExtensionApp()
+D.disable_nbextension('usability/codefolding/main')
+```
+The configuration is stored in either `jupyter_config_dir()/notebok.json` or `jupyter_config_dir()/nbconfig/notebook.json`
+depending on your Jupyter (4.0.xx or master) version.
+
+If you reload the notebook after enabling a notebook extension, the extension will be loaded. You can check the Javascript console to confirm.
+
+
+# General extension installation instructions
+Installing and activating notebook extensions works differently in Jupyter compared to Python. Please be aware that Jupyter is still in development stage and some commands would change in future.
+
+* There is a graphical interface for activating/deactivating notebook extensions now. You might want to use it:
+[config-extension](config-extension)
+
+##1. Installing an extension
+
+`jupyter nbextension install `
+
+Example:
+`jupyter nbextension install usability/codefolding/main`
+
+##2. Activating an extension
+
+`jupyter nbextension enable `
+
+##3. Deactivating extensions
+
+`jupyter nbextension disable `
+
+## Troubleshooting
+If the extension does not work, here is how you can check what is wrong:
+
+1. Clear your browser cache or start a private browser tab.
+2. Verify the extension can be loaded by the IPython notebook, for example:
+ `http://127.0.0.1:8888/nbextensions/IPython-notebook-extensions-master/usability/runtools/main.js`
+3. Check for error messages in the JavaScript console of the browser.
diff --git a/nbextensions/config/render.js b/nbextensions/config/render.js
new file mode 100644
index 0000000..ab0b1bc
--- /dev/null
+++ b/nbextensions/config/render.js
@@ -0,0 +1,34 @@
+// Copyright (c) IPython-Contrib Team.
+// Distributed under the terms of the Modified BSD License.
+
+// Render markdown url
+
+require([
+ 'base/js/namespace',
+ 'base/js/utils',
+ 'base/js/page',
+ 'jquery',
+ 'require',
+ 'components/marked/lib/marked'
+], function(
+ IPython,
+ utils,
+ page,
+ $, require,
+ marked
+ ){
+ page = new page.Page();
+
+ var base_url = utils.get_body_data('baseUrl');
+ var md_url = $('body').data('md-url');
+ /* build html body listing all extensions */
+ var html = "";
+ $("#nbextensions-container").html(html);
+
+ var url = base_url + md_url;
+ $.get(url, function( my_var ) {
+ $("#render-container").html(marked(my_var));
+ }, 'text'); // or 'text', 'xml', 'more' */
+
+ page.show();
+});
diff --git a/nbextensions/publishing/printview/printview-button.png b/nbextensions/publishing/printview/printview-button.png
deleted file mode 100644
index e98073d..0000000
Binary files a/nbextensions/publishing/printview/printview-button.png and /dev/null differ
diff --git a/nbextensions/usability/aspell/ipy-aspell-server.py b/nbextensions/usability/aspell/ipy-aspell-server.py
new file mode 100644
index 0000000..7bc3fd7
--- /dev/null
+++ b/nbextensions/usability/aspell/ipy-aspell-server.py
@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+"""
+# Copyright (C) 2013
+
+# Distributed under the terms of the BSD License. The full license is in
+# the file COPYING, distributed as part of this software.
+
+@author: juhasch
+"""
+
+"""
+Tornado web server to
+ push value received from Pyzmq pull messages
+ to web browser using a webscocket connection
+"""
+
+import time
+import os.path
+
+import tornado.web
+import tornado.websocket
+import tornado.ioloop
+
+import random
+import json
+import aspell
+
+from zmq.eventloop import ioloop, zmqstream
+
+webport = 8989 # port address for web client
+
+s = aspell.Speller('lang', 'en')
+
+GLOBALS={
+ 'sockets': []
+}
+
+class WebSocketHandler(tornado.websocket.WebSocketHandler):
+ def open(self):
+ print "open socket"
+ GLOBALS['sockets'].append(self)
+
+ def on_close(self):
+ print "on_close"
+ GLOBALS['sockets'].remove(self)
+
+ def on_message(self, message):
+ x=json.loads(message)
+ text = x['text']
+ reply = s.check(text)
+ # reply to request:
+ # check 1 for OK, 0 for not a valid word
+ # id cell_id
+ # line codemirror line number
+ # start codemirror start position of word
+ # stop codemirror end position of word
+ reply = {"check": reply, "id" : x['id'], "line": x['line'],
+ "start" : x['start'], "end": x['end'] }
+ self.write_message(reply)
+
+application = tornado.web.Application([
+ (r"/websocket", WebSocketHandler),
+])
+
+if __name__ == "__main__":
+ ioloop.install()
+
+ application.listen(webport)
+ main_loop = tornado.ioloop.IOLoop.instance()
+ main_loop.start()
+ print "Running"
diff --git a/nbextensions/usability/chrome-clipboard/chrome-clipboard.yaml b/nbextensions/usability/chrome-clipboard/chrome-clipboard.yaml
index bf0f4d7..a51e52a 100644
--- a/nbextensions/usability/chrome-clipboard/chrome-clipboard.yaml
+++ b/nbextensions/usability/chrome-clipboard/chrome-clipboard.yaml
@@ -1,7 +1,7 @@
Type: IPython Notebook Extension
Name: Chrome Clipboard
Description: This extension allows using the system-wide clipboard to copy cells and images
-Link: https://github.com/ipython-contrib/IPython-notebook-extensions/wiki/Chrome-Clipboard
+Link: readme.md
Icon: chrome.png
Main: main.js
-Compatibility: 3.x
+Compatibility: 4.x
diff --git a/nbextensions/usability/chrome-clipboard/main.js b/nbextensions/usability/chrome-clipboard/main.js
index e9dbc31..78d0df8 100644
--- a/nbextensions/usability/chrome-clipboard/main.js
+++ b/nbextensions/usability/chrome-clipboard/main.js
@@ -4,158 +4,149 @@
define([
'base/js/namespace',
'jquery',
- "base/js/events",
+ 'base/js/events'
], function(IPython, $, events) {
"use strict";
- if (window.chrome == undefined) return;
+ if (window.chrome === undefined) return;
/* http://stackoverflow.com/questions/3231459/create-unique-id-with-javascript */
- function uniqueid(){
+ function uniqueid() {
// always start with a letter (for DOM friendlyness)
- var idstr=String.fromCharCode(Math.floor((Math.random()*25)+65));
- do {
+ var idstr = String.fromCharCode(Math.floor((Math.random() * 25) + 65));
+ do {
// between numbers and characters (48 is 0 and 90 is Z (42-48 = 90)
- var ascicode=Math.floor((Math.random()*42)+48);
- if (ascicode<58 || ascicode>64){
+ var ascicode = Math.floor((Math.random() * 42) + 48);
+ if (ascicode < 58 || ascicode > 64) {
// exclude all chars between : (58) and @ (64)
- idstr+=String.fromCharCode(ascicode);
- }
- } while (idstr.length<32);
+ idstr += String.fromCharCode(ascicode);
+ }
+ } while (idstr.length < 32);
return (idstr);
}
-
- var send_to_server = function(name,path,msg) {
+
+ var send_to_server = function (name, path, msg) {
if (name == '') {
name = uniqueid() + '.' + msg.match(/data:image\/(\S+);/)[1];
- }
+ }
var path = path.substring(0, path.lastIndexOf('/')) + '/';
if (path === '/') path = '';
var url = '//' + location.host + '/api/contents/' + path + name;
var img = msg.replace(/(^\S+,)/, ''); // strip header
- var data = {'name': name, 'format':'base64', 'content': img, 'type': 'file'}
+ var data = {'name': name, 'format': 'base64', 'content': img, 'type': 'file'};
var settings = {
- processData : false,
- cache : false,
- type : "PUT",
- dataType : "json",
- data : JSON.stringify(data),
- headers : {'Content-Type': 'text/plain'},
- async : false,
- success : function (data, status, xhr) {
+ processData: false,
+ cache: false,
+ type: "PUT",
+ dataType: "json",
+ data: JSON.stringify(data),
+ headers: {'Content-Type': 'text/plain'},
+ async: false,
+ success: function (data, status, xhr) {
var new_cell = IPython.notebook.insert_cell_below('markdown');
var str = '
';
new_cell.set_text(str);
new_cell.execute();
- //new_cell.select();
- },
- error : function() {console.log('Failed to send to server:',name); },
+ },
+ error: function () {
+ console.log('Failed to send to server:', name);
+ }
};
$.ajax(url, settings);
- }
- /*
- * override clipboard 'paste' and insert new cell from json data in clipboard
+ };
+
+ /**
+ * Initialize extension
*/
- window.addEventListener('paste', function(event){
- var cell = IPython.notebook.get_selected_cell();
- if (cell.mode == "command" ) {
- event.preventDefault();
- var items = event.clipboardData.items;
- for (var i = 0; i < items.length; i++) {
- //console.log("items:", items[i].type);
- if (items[i].type == 'notebook-cell/json') {
- /* json data adds a new notebook cell */
- var data = event.clipboardData.getData('notebook-cell/json').split("\n").filter(Boolean)
- for (var i=0 ; i < data.length; i++) {
- var ix = data.length - 1 - i
- var new_cell_data = JSON.parse(data[ix])
- var new_cell = IPython.notebook.insert_cell_below(new_cell_data.cell_type);
- new_cell.fromJSON(new_cell_data);
+ var load_ipython_extension = function() {
+
+ /*
+ * override clipboard 'paste' and insert new cell from json data in clipboard
+ */
+ window.addEventListener('paste', function (event) {
+ var cell = IPython.notebook.get_selected_cell();
+ if (cell.mode == "command") {
+ event.preventDefault();
+ var items = event.clipboardData.items;
+ for (var i = 0; i < items.length; i++) {
+ //console.log("items:", items[i].type);
+ if (items[i].type == 'notebook-cell/json') {
+ /* json data adds a new notebook cell */
+ var data = event.clipboardData.getData('notebook-cell/json').split("\n").filter(Boolean);
+ for (var i = 0; i < data.length; i++) {
+ var ix = data.length - 1 - i;
+ var new_cell_data = JSON.parse(data[ix]);
+ var new_cell = IPython.notebook.insert_cell_below(new_cell_data.cell_type);
+ new_cell.fromJSON(new_cell_data);
}
- } else if (items[i].type.indexOf('image/') !== -1) {
- /* images are transferred to the server as file and linked to */
- var blob = items[i].getAsFile();
- var reader = new FileReader();
- reader.onload = ( function(evt) {
- var filename = '';
- send_to_server(filename, IPython.notebook.notebook_path, evt.target.result);
- event.preventDefault();
+ } else if (items[i].type.indexOf('image/') !== -1) {
+ /* images are transferred to the server as file and linked to */
+ var blob = items[i].getAsFile();
+ var reader = new FileReader();
+ reader.onload = ( function (evt) {
+ var filename = '';
+ send_to_server(filename, IPython.notebook.notebook_path, evt.target.result);
+ event.preventDefault();
} );
- reader.readAsDataURL(blob);
+ reader.readAsDataURL(blob);
+ }
}
}
- }
- });
+ });
- /*
- * override clipboard 'copy' and copy current cell as json and text to clipboard
- */
- window.addEventListener('copy', function(event){
- var ncells = IPython.notebook.ncells()
- var cells = IPython.notebook.get_cells()
- var cell_indices = []
- for ( var i=0; i < ncells ; i++) {
- if (cells[i].metadata.selected === true) {
- cell_indices.push(i)
+ /*
+ * override clipboard 'copy' and copy current cell as json and text to clipboard
+ */
+ window.addEventListener('copy', function (event) {
+ var cell = IPython.notebook.get_selected_cell();
+ if (cell.mode == "command") {
+ var sel = window.getSelection();
+ if (sel.type == "Range") return;
+ /* default: copy marked text */
+ event.preventDefault();
+ var json = "";
+ var text = "";
+ var selected_cells = IPython.notebook.get_selected_cells();
+ for (var i in selected_cells) {
+ var j = selected_cells[i].toJSON();
+ json += JSON.stringify(j) + '\n';
+ text += selected_cells[i].code_mirror.getValue() + '\n';
+ }
+ /* copy cell as json and cell contents as text */
+ event.clipboardData.setData('notebook-cell/json', json);
+ event.clipboardData.setData("Text", text);
}
- }
- if (cell_indices.length === 0) {
- cell_indices.push(IPython.notebook.get_selected_index())
- }
-
- var cell = IPython.notebook.get_selected_cell();
- if (cell.mode == "command") {
- var sel = window.getSelection();
- if (sel.type == "Range") return; /* default: copy marked text */
- event.preventDefault();
- var json = ""
- var text = ""
- for (var i in cell_indices) {
- var cell = cells[cell_indices[i]]
- var j = cell.toJSON();
- json += JSON.stringify(j) + '\n'
- text += cell.code_mirror.getValue() + '\n'
- }
- /* copy cell as json and cell contents as text */
- event.clipboardData.setData('notebook-cell/json',json);
- event.clipboardData.setData("Text", text);
- }
- });
+ });
- /*
- * override clipboard 'cut' and copy current cell as json and text to clipboard
- */
- window.addEventListener('cut', function(event){
- var ncells = IPython.notebook.ncells()
- var cells = IPython.notebook.get_cells()
- var cell_indices = []
- for ( var i=0; i < ncells ; i++) {
- if (cells[i].metadata.selected === true) {
- cell_indices.push(i)
+ /*
+ * override clipboard 'cut' and copy current cell as json and text to clipboard
+ */
+ window.addEventListener('cut', function (event) {
+ var cell = IPython.notebook.get_selected_cell();
+ if (cell.mode == "command") {
+ var sel = window.getSelection();
+ if (sel.type == "Range") return;
+ /* default: copy marked text */
+ event.preventDefault();
+ var json = "";
+ var text = "";
+ var selected_cells = IPython.notebook.get_selected_cells();
+ for (var i in selected_cells) {
+ var j = selected_cells[i].toJSON();
+ json += JSON.stringify(j) + '\n';
+ text += selected_cells[i].code_mirror.getValue() + '\n';
+ IPython.notebook.delete_cell(IPython.notebook.find_cell_index(selected_cells[i]));
+ }
+ /* copy cell as json and cell contents as text */
+ event.clipboardData.setData('notebook-cell/json', json);
+ event.clipboardData.setData("Text", text);
}
- }
- if (cell_indices.length === 0) {
- cell_indices.push(IPython.notebook.get_selected_index())
- }
+ });
- var cell = IPython.notebook.get_selected_cell();
- if (cell.mode == "command") {
- var sel = window.getSelection();
- if (sel.type == "Range") return; /* default: copy marked text */
- event.preventDefault();
- var json = ""
- var text = ""
- for (var i in cell_indices) {
- var cell = cells[cell_indices[i]]
- var j = cell.toJSON();
- json += JSON.stringify(j) + '\n'
- text += cell.code_mirror.getValue() + '\n'
- IPython.notebook.delete_cell(IPython.notebook.find_cell_index(cell));
- }
- /* copy cell as json and cell contents as text */
- event.clipboardData.setData('notebook-cell/json',json);
- event.clipboardData.setData("Text", text);
- }
- });
+ };
+
+ var extension = {
+ load_ipython_extension : load_ipython_extension
+ };
+ return extension;
});
-
diff --git a/nbextensions/usability/chrome-clipboard/readme.md b/nbextensions/usability/chrome-clipboard/readme.md
new file mode 100644
index 0000000..3318032
--- /dev/null
+++ b/nbextensions/usability/chrome-clipboard/readme.md
@@ -0,0 +1,36 @@
+# Description
+
+This IPython notebook extension adds system clipboard actions for single or multiple cells.
+It allows cut/copy/paste operation of notebook cells and images. Images will be saved to the directory where the
+current notebook sits. There is currently no way to embed images in markdown cells, due to the google-caja sanitizer
+used to prevent malicous code execution. Multi-cell operation is possible with the latest Jupyter version, or using the `rubberband` extension in this repository.
+
+
+A demo showing single-cell copy&paste operating in Chrome here:
+http://youtu.be/iU9dNe4vMUY
+
+*This extension works only for Chrome, as other browsers do not expose the system clipboard to Javascript.*
+
+
+## Hotkeys
+
+| Key | <--> | Function |
+| ----------|- |----------|
+| CTRL+C || Copy cell to system clipboard |
+| CTRL+X || Cut cell and copy to system clipboard |
+| CTRL+V || Paste cell or image from system clipboard |
+
+
+## Installation
+You can manually load the extension from within the IPyton notebook:
+```javascript
+%%javascript
+IPython.load_extensions('nbextensions/usability/chrome_clipboard');
+```
+
+For installation instructions using the nbextensions config tool, please see the
+[Readme](/rendermd/nbextensions/config/readme.md)
+
+
+## Internals
+Regarding copying notebook cells over the clipboard, they are stored as mime-type `notebook-cell/json`.
diff --git a/nbextensions/usability/codefolding/codefolding.yaml b/nbextensions/usability/codefolding/codefolding.yaml
index 55eb035..1bbc824 100644
--- a/nbextensions/usability/codefolding/codefolding.yaml
+++ b/nbextensions/usability/codefolding/codefolding.yaml
@@ -1,7 +1,7 @@
Type: IPython Notebook Extension
Name: Codefolding
Description: This extension enables the CodeMirror feature to llow codefolding in code cells
-Link: https://github.com/ipython-contrib/IPython-notebook-extensions/wiki/Codefolding
+Link: readme.md
Icon: icon.png
Main: main.js
-Compatibility: 3.x
+Compatibility: 4.x
diff --git a/nbextensions/usability/codefolding/codefolding_firstline_folded.png b/nbextensions/usability/codefolding/codefolding_firstline_folded.png
deleted file mode 100644
index 4ce9908..0000000
Binary files a/nbextensions/usability/codefolding/codefolding_firstline_folded.png and /dev/null differ
diff --git a/nbextensions/usability/codefolding/codefolding_firstline_unfolded.png b/nbextensions/usability/codefolding/codefolding_firstline_unfolded.png
deleted file mode 100644
index f421e00..0000000
Binary files a/nbextensions/usability/codefolding/codefolding_firstline_unfolded.png and /dev/null differ
diff --git a/nbextensions/usability/codefolding/codefolding_indent_folded_1.png b/nbextensions/usability/codefolding/codefolding_indent_folded_1.png
deleted file mode 100644
index e5b98b7..0000000
Binary files a/nbextensions/usability/codefolding/codefolding_indent_folded_1.png and /dev/null differ
diff --git a/nbextensions/usability/codefolding/codefolding_indent_folded_2.png b/nbextensions/usability/codefolding/codefolding_indent_folded_2.png
deleted file mode 100644
index 287e292..0000000
Binary files a/nbextensions/usability/codefolding/codefolding_indent_folded_2.png and /dev/null differ
diff --git a/nbextensions/usability/codefolding/codefolding_indent_unfolded.png b/nbextensions/usability/codefolding/codefolding_indent_unfolded.png
deleted file mode 100644
index 0e07bb7..0000000
Binary files a/nbextensions/usability/codefolding/codefolding_indent_unfolded.png and /dev/null differ
diff --git a/nbextensions/usability/codefolding/main.js b/nbextensions/usability/codefolding/main.js
index f4aa798..6f251a6 100644
--- a/nbextensions/usability/codefolding/main.js
+++ b/nbextensions/usability/codefolding/main.js
@@ -14,20 +14,31 @@ define([
'jquery',
'require',
'base/js/events',
+ 'services/config',
+ 'base/js/utils',
'codemirror/lib/codemirror',
'codemirror/addon/fold/foldgutter',
'codemirror/addon/fold/foldcode',
'codemirror/addon/fold/brace-fold',
'codemirror/addon/fold/indent-fold'
-], function(IPython, $, require, events, codemirror) {
+], function(IPython, $, require, events, configmod, utils, codemirror) {
"use strict";
- if (IPython.version[0] < 3) {
- console.log("This extension requires IPython 3.x");
- return
- }
- var foldingKey = { "Alt-F" : toggleFolding };
-
+ var HOTKEY = 'Alt-F';
+ var foldingKey = { HOTKEY : toggleFolding };
+
+ var base_url = utils.get_body_data("baseUrl");
+ var config = new configmod.ConfigSection('notebook', {base_url: base_url});
+ config.load();
+
+ config.loaded.then(function() {
+ if (config.data.hasOwnProperty('codefolding_hotkey') ){
+ HOTKEY = config.data.codefolding_hotkey;
+ foldingKey = {};
+ foldingKey[HOTKEY] = toggleFolding;
+ }
+ });
+
/*
* Toggle folding on/off at current line
*
@@ -77,7 +88,8 @@ define([
var cell = IPython.notebook.get_selected_cell();
if (cell.code_mirror != cm) {
var cells = IPython.notebook.get_cells();
- for(var k in cells){
+ var ncells = IPython.notebook.ncells();
+ for(var k=0; k < ncells; k++){
var _cell = cells[k];
if (_cell.code_mirror == cm ) { break; }
}
@@ -93,13 +105,13 @@ define([
function cellFolding(cell) {
if (CodeMirror.fold != undefined) {
var keys = cell.code_mirror.getOption('extraKeys');
- cell.code_mirror.setOption('extraKeys', collect(keys, foldingKey ));
+ cell.code_mirror.setOption('extraKeys', collect(keys, foldingKey ));
var mode = cell.code_mirror.getOption('mode');
/* use indent folding in Python */
if (mode.name == 'ipython' ) {
- cell.code_mirror.setOption('foldGutter',{rangeFinder: new CodeMirror.fold.combine(CodeMirror.fold.firstline, CodeMirror.fold.magic, CodeMirror.fold.indent) });
+ cell.code_mirror.setOption('foldGutter',{rangeFinder: new CodeMirror.fold.combine(CodeMirror.fold.firstline, CodeMirror.fold.indent) });
} else {
- cell.code_mirror.setOption('foldGutter',{rangeFinder: new CodeMirror.fold.combine(CodeMirror.fold.firstline, CodeMirror.fold.magic, CodeMirror.fold.brace) });
+ cell.code_mirror.setOption('foldGutter',{rangeFinder: new CodeMirror.fold.combine(CodeMirror.fold.firstline, CodeMirror.fold.brace) });
}
var gutters = cell.code_mirror.getOption('gutters');
var found = jQuery.inArray("CodeMirror-foldgutter", gutters);
@@ -131,16 +143,18 @@ define([
*/
var initGutter = function() {
var cells = IPython.notebook.get_cells();
- for(var i in cells){
+ var ncells = IPython.notebook.ncells();
+ for (var i=0; i'
- img = '
'
- else:
- img = '
'
- return img
-
- def postprocess(self, input):
- regex = re.compile('
`
+
+If you run `nbconvert` to generate a HTML file, this image will remain outside of the html file. You can embedd all images by calling `nbconvert` with the option `--post=embed.EmbedPostProcessor`. The file `embed.py`, located in the same directory of this extension needs to be in `PYTHONPATH` to be found.
\ No newline at end of file
diff --git a/nbextensions/usability/execute_time/ExecuteTime.js b/nbextensions/usability/execute_time/ExecuteTime.js
index 82fd407..20485a0 100755
--- a/nbextensions/usability/execute_time/ExecuteTime.js
+++ b/nbextensions/usability/execute_time/ExecuteTime.js
@@ -18,7 +18,7 @@ define(["require", "jquery", "base/js/namespace", "base/js/events"], function (r
var patchCodecellExecute = function() {
console.log('patching codecell to trigger ExecuteCell.ExecuteTime');
- IPython.CodeCell.prototype.old_execute = IPython.CodeCell.prototype.execute
+ IPython.CodeCell.prototype.old_execute = IPython.CodeCell.prototype.execute;
IPython.CodeCell.prototype.execute = function () {
this.old_execute(arguments);
@@ -165,14 +165,18 @@ define(["require", "jquery", "base/js/namespace", "base/js/events"], function (r
}
};
+ var load_ipython_extension = function() {
+ patchCodecellExecute();
- patchCodecellExecute();
+ events.on('ExecuteCell.ExecuteTime', executionStartTime);
+ events.on('kernel_idle.Kernel', executionEndTime);
- events.on('ExecuteCell.ExecuteTime',executionStartTime);
- events.on('kernel_idle.Kernel', executionEndTime);
+ $("head").append($(""));
+ create_menu();
+ };
- $("head").append($(""));
- create_menu();
-
- console.log('Execute Timings loaded');
+ var extension = {
+ load_ipython_extension : load_ipython_extension
+ };
+ return extension;
});
diff --git a/nbextensions/usability/execute_time/ExecuteTime.yaml b/nbextensions/usability/execute_time/ExecuteTime.yaml
index 36baf93..6df3cda 100644
--- a/nbextensions/usability/execute_time/ExecuteTime.yaml
+++ b/nbextensions/usability/execute_time/ExecuteTime.yaml
@@ -1,7 +1,7 @@
# IPython Notebook Extension Description
Name: ExecuteTime
Description: Display when each cell has been executed and how long it took
-Link: https://github.com/ipython-contrib/IPython-notebook-extensions/wiki/execute_timings
+Link: readme.md
Icon: icon.png
Main: main.js
-Compatibility: 3.x
+Compatibility: 4.x
diff --git a/nbextensions/usability/execute_time/execution-timings-box.png b/nbextensions/usability/execute_time/execution-timings-box.png
deleted file mode 100644
index 401edc0..0000000
Binary files a/nbextensions/usability/execute_time/execution-timings-box.png and /dev/null differ
diff --git a/nbextensions/usability/execute_time/execution-timings-menu.png b/nbextensions/usability/execute_time/execution-timings-menu.png
deleted file mode 100644
index fa129d3..0000000
Binary files a/nbextensions/usability/execute_time/execution-timings-menu.png and /dev/null differ
diff --git a/nbextensions/usability/execute_time/readme.md b/nbextensions/usability/execute_time/readme.md
new file mode 100644
index 0000000..7611119
--- /dev/null
+++ b/nbextensions/usability/execute_time/readme.md
@@ -0,0 +1,28 @@
+This extension displays when the last execution of a cell occurred and how long it took.
+
+## Display
+
+Every executed cell is extended with a new area, attached at the bottom of the input area, that displays when the user started the last execution of this cell. When the kernel finishes to execute a cell, this area is update with the duration.
+
+
+
+## Toggling
+
+The timings area can be hide by double clicking on it or using the option in the cell menu. The menu toggle timings->All hides (resp. shows) all the possible timings area if the first cell is displayed (resp. hidden).
+
+
+
+## Internals
+To be sure that the kernel is run intentionally by executing a codecell, codecell.prototype.execute() is overloaded and a new event 'ExecuteCell.ExecuteTime' is fired, that this extension catches to display the start time. We use the event 'status_idle.Kernel' to know when the kernel finished the execution of the cell.
+
+## Installation
+Copy `ExecuteTime.{js,css}`, and add `require(['/static/custom/ExecuteTime.js'])` to `custom.js` in your profile's `/static/custom` directory, so it looks like this:
+```javascript
+$([IPython.events]).on('app_initialized.NotebookApp', function(){
+ //...
+ require(['/static/custom/ExecuteTime.js'])
+});
+```
+
+## TODO
+The timings information could be stored into the notebook and displayed when it is loaded. Where these information should be stored is still to be decided (maybe in the metadata).
diff --git a/nbextensions/usability/exercise/exercise.yaml b/nbextensions/usability/exercise/exercise.yaml
new file mode 100644
index 0000000..e62ead7
--- /dev/null
+++ b/nbextensions/usability/exercise/exercise.yaml
@@ -0,0 +1,7 @@
+Type: IPython Notebook Extension
+Name: Exercise
+Description: Exercise TEST
+Link: https://github.com/ipython-contrib/IPython-notebook-extensions/wiki/
+Icon: icon.png
+Main: main.js
+Compatibility: 3.x
diff --git a/nbextensions/usability/exercise/icon.png b/nbextensions/usability/exercise/icon.png
new file mode 100644
index 0000000..4acc18f
Binary files /dev/null and b/nbextensions/usability/exercise/icon.png differ
diff --git a/nbextensions/usability/exercise/main.js b/nbextensions/usability/exercise/main.js
index cf387d9..9862eab 100644
--- a/nbextensions/usability/exercise/main.js
+++ b/nbextensions/usability/exercise/main.js
@@ -1,14 +1,15 @@
-// Hide or diplay solutions in a notebook
+// Copyright (c) IPython-Contrib Team.
+// Distributed under the terms of the Modified BSD License.
-// To define a solution, select all cells of a solution using shift button and mouse
-// All cells will be hidden, except the first one
-// A hide/unhide symbol will be displayed. Click on it and the solution will be displayed/hidden
+// Hide or diplay solutions in a notebook
define([
'base/js/namespace',
'jquery',
- "base/js/events",
-], function(IPython, $, events) {
+ 'require',
+ 'base/js/events',
+ 'nbextensions/usability/rubberband/main'
+], function(IPython, $, require, events, rubberband) {
"use strict";
/**
@@ -18,21 +19,21 @@ define([
* @param ev {Event} jquery event
*/
function click_solution_lock(ev) {
- var cell=IPython.notebook.get_selected_cell()
- var is_locked = cell.element.find('#lock').hasClass('fa-plus-square-o')
+ var cell=IPython.notebook.get_selected_cell();
+ var is_locked = cell.element.find('#lock').hasClass('fa-plus-square-o');
if (is_locked == true) {
- cell.element.find('#lock').removeClass('fa-plus-square-o')
- cell.element.find('#lock').addClass('fa-minus-square-o')
+ cell.element.find('#lock').removeClass('fa-plus-square-o');
+ cell.element.find('#lock').addClass('fa-minus-square-o');
while (cell.metadata.solution == true) {
IPython.notebook.select_next();
cell.element.show();
cell = IPython.notebook.get_selected_cell()
}
} else {
- cell.element.find('#lock').removeClass('fa-minus-square-o')
- cell.element.find('#lock').addClass('fa-plus-square-o')
+ cell.element.find('#lock').removeClass('fa-minus-square-o');
+ cell.element.find('#lock').addClass('fa-plus-square-o');
IPython.notebook.select_next();
- cell = IPython.notebook.get_selected_cell()
+ cell = IPython.notebook.get_selected_cell();
while (cell.metadata.solution == true) {
cell.element.hide();
IPython.notebook.select_next();
@@ -49,48 +50,48 @@ define([
*/
function hide_solutions() {
// first check if lock symbol is already present in selected cell, if yes, remove it
- var cell=IPython.notebook.get_selected_cell()
- var has_lock = cell.element.find('#lock').is('div')
+ var cell=IPython.notebook.get_selected_cell();
+ var has_lock = cell.element.find('#lock').is('div');
if (has_lock === true) {
- cell.element.find('#lock').remove()
+ cell.element.find('#lock').remove();
while (cell.metadata.solution == true) {
- delete cell.metadata.solution
- cell.element.show()
- IPython.notebook.select_next()
+ delete cell.metadata.solution;
+ cell.element.show();
+ IPython.notebook.select_next();
cell = IPython.notebook.get_selected_cell()
}
} else {
// find first cell with solution
- var start_cell_i // = undefined
- var cells = IPython.notebook.get_cells()
+ var start_cell_i; // = undefined
+ var cells = IPython.notebook.get_cells();
for(var i in cells){
- var cell = cells[i]
+ var cell = cells[i];
if (typeof cell.metadata.selected != undefined && cell.metadata.selected === true) {
- start_cell_i = i
- console.log("selected start cell:",i)
+ start_cell_i = i;
+ console.log("selected start cell:", i);
break
}
}
- IPython.notebook.select(start_cell_i)
+ IPython.notebook.select(start_cell_i);
if (cell.metadata.selected == true) {
- var el = $('
'
- else:
- img = '`
+
+If you run `nbconvert` to generate a HTML file, this image will remain outside of the html file. You can embedd all images by calling `nbconvert` with the option `--post=embed.EmbedPostProcessor`. The file `embed.py`, located in the same directory of this extension needs to be in `PYTHONPATH` to be found.
\ No newline at end of file
diff --git a/nbextensions/usability/execute_time/ExecuteTime.js b/nbextensions/usability/execute_time/ExecuteTime.js
index 82fd407..20485a0 100755
--- a/nbextensions/usability/execute_time/ExecuteTime.js
+++ b/nbextensions/usability/execute_time/ExecuteTime.js
@@ -18,7 +18,7 @@ define(["require", "jquery", "base/js/namespace", "base/js/events"], function (r
var patchCodecellExecute = function() {
console.log('patching codecell to trigger ExecuteCell.ExecuteTime');
- IPython.CodeCell.prototype.old_execute = IPython.CodeCell.prototype.execute
+ IPython.CodeCell.prototype.old_execute = IPython.CodeCell.prototype.execute;
IPython.CodeCell.prototype.execute = function () {
this.old_execute(arguments);
@@ -165,14 +165,18 @@ define(["require", "jquery", "base/js/namespace", "base/js/events"], function (r
}
};
+ var load_ipython_extension = function() {
+ patchCodecellExecute();
- patchCodecellExecute();
+ events.on('ExecuteCell.ExecuteTime', executionStartTime);
+ events.on('kernel_idle.Kernel', executionEndTime);
- events.on('ExecuteCell.ExecuteTime',executionStartTime);
- events.on('kernel_idle.Kernel', executionEndTime);
+ $("head").append($(""));
+ create_menu();
+ };
- $("head").append($(""));
- create_menu();
-
- console.log('Execute Timings loaded');
+ var extension = {
+ load_ipython_extension : load_ipython_extension
+ };
+ return extension;
});
diff --git a/nbextensions/usability/execute_time/ExecuteTime.yaml b/nbextensions/usability/execute_time/ExecuteTime.yaml
index 36baf93..6df3cda 100644
--- a/nbextensions/usability/execute_time/ExecuteTime.yaml
+++ b/nbextensions/usability/execute_time/ExecuteTime.yaml
@@ -1,7 +1,7 @@
# IPython Notebook Extension Description
Name: ExecuteTime
Description: Display when each cell has been executed and how long it took
-Link: https://github.com/ipython-contrib/IPython-notebook-extensions/wiki/execute_timings
+Link: readme.md
Icon: icon.png
Main: main.js
-Compatibility: 3.x
+Compatibility: 4.x
diff --git a/nbextensions/usability/execute_time/execution-timings-box.png b/nbextensions/usability/execute_time/execution-timings-box.png
deleted file mode 100644
index 401edc0..0000000
Binary files a/nbextensions/usability/execute_time/execution-timings-box.png and /dev/null differ
diff --git a/nbextensions/usability/execute_time/execution-timings-menu.png b/nbextensions/usability/execute_time/execution-timings-menu.png
deleted file mode 100644
index fa129d3..0000000
Binary files a/nbextensions/usability/execute_time/execution-timings-menu.png and /dev/null differ
diff --git a/nbextensions/usability/execute_time/readme.md b/nbextensions/usability/execute_time/readme.md
new file mode 100644
index 0000000..7611119
--- /dev/null
+++ b/nbextensions/usability/execute_time/readme.md
@@ -0,0 +1,28 @@
+This extension displays when the last execution of a cell occurred and how long it took.
+
+## Display
+
+Every executed cell is extended with a new area, attached at the bottom of the input area, that displays when the user started the last execution of this cell. When the kernel finishes to execute a cell, this area is update with the duration.
+
+
+
+## Toggling
+
+The timings area can be hide by double clicking on it or using the option in the cell menu. The menu toggle timings->All hides (resp. shows) all the possible timings area if the first cell is displayed (resp. hidden).
+
+
+
+## Internals
+To be sure that the kernel is run intentionally by executing a codecell, codecell.prototype.execute() is overloaded and a new event 'ExecuteCell.ExecuteTime' is fired, that this extension catches to display the start time. We use the event 'status_idle.Kernel' to know when the kernel finished the execution of the cell.
+
+## Installation
+Copy `ExecuteTime.{js,css}`, and add `require(['/static/custom/ExecuteTime.js'])` to `custom.js` in your profile's `/static/custom` directory, so it looks like this:
+```javascript
+$([IPython.events]).on('app_initialized.NotebookApp', function(){
+ //...
+ require(['/static/custom/ExecuteTime.js'])
+});
+```
+
+## TODO
+The timings information could be stored into the notebook and displayed when it is loaded. Where these information should be stored is still to be decided (maybe in the metadata).
diff --git a/nbextensions/usability/exercise/exercise.yaml b/nbextensions/usability/exercise/exercise.yaml
new file mode 100644
index 0000000..e62ead7
--- /dev/null
+++ b/nbextensions/usability/exercise/exercise.yaml
@@ -0,0 +1,7 @@
+Type: IPython Notebook Extension
+Name: Exercise
+Description: Exercise TEST
+Link: https://github.com/ipython-contrib/IPython-notebook-extensions/wiki/
+Icon: icon.png
+Main: main.js
+Compatibility: 3.x
diff --git a/nbextensions/usability/exercise/icon.png b/nbextensions/usability/exercise/icon.png
new file mode 100644
index 0000000..4acc18f
Binary files /dev/null and b/nbextensions/usability/exercise/icon.png differ
diff --git a/nbextensions/usability/exercise/main.js b/nbextensions/usability/exercise/main.js
index cf387d9..9862eab 100644
--- a/nbextensions/usability/exercise/main.js
+++ b/nbextensions/usability/exercise/main.js
@@ -1,14 +1,15 @@
-// Hide or diplay solutions in a notebook
+// Copyright (c) IPython-Contrib Team.
+// Distributed under the terms of the Modified BSD License.
-// To define a solution, select all cells of a solution using shift button and mouse
-// All cells will be hidden, except the first one
-// A hide/unhide symbol will be displayed. Click on it and the solution will be displayed/hidden
+// Hide or diplay solutions in a notebook
define([
'base/js/namespace',
'jquery',
- "base/js/events",
-], function(IPython, $, events) {
+ 'require',
+ 'base/js/events',
+ 'nbextensions/usability/rubberband/main'
+], function(IPython, $, require, events, rubberband) {
"use strict";
/**
@@ -18,21 +19,21 @@ define([
* @param ev {Event} jquery event
*/
function click_solution_lock(ev) {
- var cell=IPython.notebook.get_selected_cell()
- var is_locked = cell.element.find('#lock').hasClass('fa-plus-square-o')
+ var cell=IPython.notebook.get_selected_cell();
+ var is_locked = cell.element.find('#lock').hasClass('fa-plus-square-o');
if (is_locked == true) {
- cell.element.find('#lock').removeClass('fa-plus-square-o')
- cell.element.find('#lock').addClass('fa-minus-square-o')
+ cell.element.find('#lock').removeClass('fa-plus-square-o');
+ cell.element.find('#lock').addClass('fa-minus-square-o');
while (cell.metadata.solution == true) {
IPython.notebook.select_next();
cell.element.show();
cell = IPython.notebook.get_selected_cell()
}
} else {
- cell.element.find('#lock').removeClass('fa-minus-square-o')
- cell.element.find('#lock').addClass('fa-plus-square-o')
+ cell.element.find('#lock').removeClass('fa-minus-square-o');
+ cell.element.find('#lock').addClass('fa-plus-square-o');
IPython.notebook.select_next();
- cell = IPython.notebook.get_selected_cell()
+ cell = IPython.notebook.get_selected_cell();
while (cell.metadata.solution == true) {
cell.element.hide();
IPython.notebook.select_next();
@@ -49,48 +50,48 @@ define([
*/
function hide_solutions() {
// first check if lock symbol is already present in selected cell, if yes, remove it
- var cell=IPython.notebook.get_selected_cell()
- var has_lock = cell.element.find('#lock').is('div')
+ var cell=IPython.notebook.get_selected_cell();
+ var has_lock = cell.element.find('#lock').is('div');
if (has_lock === true) {
- cell.element.find('#lock').remove()
+ cell.element.find('#lock').remove();
while (cell.metadata.solution == true) {
- delete cell.metadata.solution
- cell.element.show()
- IPython.notebook.select_next()
+ delete cell.metadata.solution;
+ cell.element.show();
+ IPython.notebook.select_next();
cell = IPython.notebook.get_selected_cell()
}
} else {
// find first cell with solution
- var start_cell_i // = undefined
- var cells = IPython.notebook.get_cells()
+ var start_cell_i; // = undefined
+ var cells = IPython.notebook.get_cells();
for(var i in cells){
- var cell = cells[i]
+ var cell = cells[i];
if (typeof cell.metadata.selected != undefined && cell.metadata.selected === true) {
- start_cell_i = i
- console.log("selected start cell:",i)
+ start_cell_i = i;
+ console.log("selected start cell:", i);
break
}
}
- IPython.notebook.select(start_cell_i)
+ IPython.notebook.select(start_cell_i);
if (cell.metadata.selected == true) {
- var el = $('')
- cell.element.prepend(el)
- cell.metadata.solution = true
+ var el = $('
');
+ cell.element.prepend(el);
+ cell.metadata.solution = true;
cell.element.css({"background-color": "#ffffff"});
- delete cell.metadata.selected
+ delete cell.metadata.selected;
- el.click(click_solution_lock)
+ el.click(click_solution_lock);
IPython.notebook.select_next();
- cell = IPython.notebook.get_selected_cell()
- console.log("new cell:", IPython.notebook.get_selected_index())
+ cell = IPython.notebook.get_selected_cell();
+ console.log("new cell:", IPython.notebook.get_selected_index());
while (cell.metadata.selected == true) {
cell.element.css({"background-color": "#ffffff"});
- delete cell.metadata.selected
+ delete cell.metadata.selected;
cell.element.hide();
- cell.metadata.solution = true
+ cell.metadata.solution = true;
IPython.notebook.select_next();
- cell = IPython.notebook.get_selected_cell()
+ cell = IPython.notebook.get_selected_cell();
console.log("new cell(i):",IPython.notebook.get_selected_index())
}
}
@@ -105,7 +106,7 @@ define([
callback : function () {
hide_solutions();
}
- },
+ }
]);
/**
@@ -120,22 +121,21 @@ define([
link.type = "text/css";
link.rel = "stylesheet";
link.href = require.toUrl(name);
- console.log(link);
document.getElementsByTagName("head")[0].appendChild(link);
};
- load_css('/nbextensions/testing/exercise/main.css');
- var exercise_wrapper = $('')
- $("#header").append(exercise_wrapper)
+ load_css('./main.css');
+ var exercise_wrapper = $('');
+ $("#header").append(exercise_wrapper);
/**
* Display existing solutions at startup
*
*/
- var cells = IPython.notebook.get_cells()
- var found_solution = false
+ var cells = IPython.notebook.get_cells();
+ var found_solution = false;
for(var i in cells){
- var cell = cells[i]
+ var cell = cells[i];
if (found_solution == true && typeof cell.metadata.solution != undefined && cell.metadata.solution === true) {
cell.element.hide()
} else {
@@ -143,10 +143,11 @@ define([
}
if (found_solution == false && typeof cell.metadata.solution != undefined && cell.metadata.solution === true) {
// hide solution
- var el = $('
')
- cell.element.prepend(el)
- el.click( click_solution_lock)
+ var el = $('
' +
');
+ cell.element.prepend(el);
+ el.click( click_solution_lock);
found_solution = true
}
+ rubberband.load_ipython_extension()
}
-})
+});
diff --git a/nbextensions/usability/hide_input/hide_input.tpl b/nbextensions/usability/hide_input/hide_input.tpl
new file mode 100644
index 0000000..044b0f0
--- /dev/null
+++ b/nbextensions/usability/hide_input/hide_input.tpl
@@ -0,0 +1,20 @@
+{%- extends 'slides_reveal.tpl' -%}
+
+{% block input_group %}
+{%- if cell.metadata.input_collapsed -%}
+{%- else -%}
+ }}`. It then executes the expression and replaces it with the result returned from Python, embedded in a `` tag.
+Additionally, the result is saved in the metadata of the markdown cell, i.e. `cell.metadata.variables[varname]`. This stored value is displayed when reloading the notebook and used for the nbconvert preprocesser.
+
+The preprocessor `pymdpreprocessor.PyMarkdownPreprocessor` allows `nbconvert` to display the computed variables when converting the notebook to an output file format.
+
diff --git a/nbextensions/usability/rubberband/readme.md b/nbextensions/usability/rubberband/readme.md
new file mode 100644
index 0000000..842712a
--- /dev/null
+++ b/nbextensions/usability/rubberband/readme.md
@@ -0,0 +1,31 @@
+Multi-Cell selection using a rubberband. This extension is only available for IPython version 3.x.
+
+Description
+===========
+The *rubberband* extension allows selecting multiple cells. Cells are selected by pressing `shift` or `ctrl`+`shift` + left mouse button click and dragging the rubber band over the cells.
+
+* `shift` + left mouse button : select cells that are currently touched by the rubberband
+* `ctrl` + `shift` + left mouse button : select cells that were touched by the rubberband
+
+The `ctrl`+`shift` action is useful when scrolling inside the notebook. Scrolling is activated when the mouse reaches the upper or lower boundary of the notebook area. For now, the mouse has to be moved to achieve continuous scrolling.
+
+A short video demonstrating the rubberband extension can be found here:
+[](http://youtu.be/TOPfWhqa3oI)
+
+
+Two other extensions make use of this feature: exercise and chrome_clipboard.
+
+Installation
+============
+Copy the `rubberband` directory to a new `/nbextensions/usability/rubberband` directory of your user's IPython directory and add
+```javascript
+IPython.load_extensions('usability/rubberband/main')
+```
+to your `custom.js` file. Take a look at the general installation instructions in the Wiki if you are unsure how to proceed.
+
+Internals
+=========
+
+New metadata element added to each cell:
+* `cell.metadata.selected` - means this cell is selected
+
diff --git a/nbextensions/usability/rubberband/rubberband.yaml b/nbextensions/usability/rubberband/rubberband.yaml
index 14319e3..643a505 100644
--- a/nbextensions/usability/rubberband/rubberband.yaml
+++ b/nbextensions/usability/rubberband/rubberband.yaml
@@ -1,7 +1,7 @@
Type: IPython Notebook Extension
Name: Rubberband
Description: The rubberband extension allows selecting multiple cells
-Link: https://github.com/ipython-contrib/IPython-notebook-extensions/wiki/Rubberband
+Link: readme.md
Icon: icon.png
Main: main.js
Compatibility: 4.x
diff --git a/nbextensions/usability/ruler/readme.md b/nbextensions/usability/ruler/readme.md
new file mode 100644
index 0000000..52e1b50
--- /dev/null
+++ b/nbextensions/usability/ruler/readme.md
@@ -0,0 +1 @@
+Display a rulter
diff --git a/nbextensions/usability/ruler/ruler.yaml b/nbextensions/usability/ruler/ruler.yaml
index 0c7083d..ad31919 100644
--- a/nbextensions/usability/ruler/ruler.yaml
+++ b/nbextensions/usability/ruler/ruler.yaml
@@ -1,9 +1,12 @@
Type: IPython Notebook Extension
Name: Ruler
Description: This extension enables the Ruler CodeMirror feature
-Link: https://github.com/ipython-contrib/IPython-notebook-extensions/wiki
+Link: readme.md
Icon: icon.png
Main: main.js
Compatibility: 4.x
-Parameter: ruler_column
-ParameterDescription: Column where ruler is displayed
+Parameters:
+ ruler_column:
+ input_type: number
+ description: Column where ruler is displayed
+ default: 78
diff --git a/nbextensions/usability/runtools/readme.md b/nbextensions/usability/runtools/readme.md
new file mode 100644
index 0000000..8ad3124
--- /dev/null
+++ b/nbextensions/usability/runtools/readme.md
@@ -0,0 +1,50 @@
+Runtools provide a number of additional functions for working with code cells in the IPython notebook:
+
+Code Cell Execution
+---
+* Execute a single cell
+* Execute from top cell to currently selected cell
+* Execute from currently selected cell to bottom cell
+* Execute all cells
+* Execute all cells, ignore exceptions (requires https://github.com/ipython/ipython/pull/6521)
+* Execute marked code cells (cells with green gutter area are marked)
+* Stop execution (duplicate to standard toolbar button)
+
+Code Cell Marking
+---
+* Mark one or more code cell
+
+Code Cell Display
+---
+* Hide or show input (i.e. the source code) of marked code cells
+* Hide or show output of marked code cells
+
+Description
+===========
+The *runtools* extension adds a button to turn on/off a floating toolbar:
+
+
+This adds Code execution buttons:
+
+
+Codecells can be marked by clicking on the gutter of a codecell or by clicking on the markers toolbar:
+
+
+A IPython notebook with marked cells looks like this:
+
+
+Installation
+============
+Copy the `runtools` directory to a new `/nbextensions/usability/runtools` directory of your user's IPython directory and add
+```javascript
+IPython.load_extensions('usability/runtools/main.js')
+```
+to your `custom.js` file. Take a look at the general installation instructions in the Wiki if you are unsure how to proceed.
+
+Internals
+=========
+
+New metadata elements added to each cell:
+* `cell.metadata.hide_input` - hide input field of the cell
+* `cell.metadata.hide_output` - hide output field of the cell
+* `cell.metadata.run_control.marked` - mark a codecell
diff --git a/nbextensions/usability/runtools/runtools.yaml b/nbextensions/usability/runtools/runtools.yaml
index 0ca0675..bb42a4f 100644
--- a/nbextensions/usability/runtools/runtools.yaml
+++ b/nbextensions/usability/runtools/runtools.yaml
@@ -1,7 +1,7 @@
Type: IPython Notebook Extension
Name: Runtools
Description: Runtools provide a number of additional functions for working with code cells in the IPython notebook
-Link: https://github.com/ipython-contrib/IPython-notebook-extensions/wiki/Runtools
+Link: readme.md
Icon: icon.png
Main: main.js
Compatibility: 4.x
diff --git a/nbextensions/usability/runtools/toggle_codecells.png b/nbextensions/usability/runtools/toggle_codecells.png
deleted file mode 100644
index 1457de9..0000000
Binary files a/nbextensions/usability/runtools/toggle_codecells.png and /dev/null differ
diff --git a/nbextensions/usability/search-replace/readme.md b/nbextensions/usability/search-replace/readme.md
new file mode 100644
index 0000000..5e106e0
--- /dev/null
+++ b/nbextensions/usability/search-replace/readme.md
@@ -0,0 +1,8 @@
+This extension provides a notebook-wide search&replace toolbar.
+
+
+
+It uses the codemirror `search` and `searchcursor` add ons.
+
+## Installation
+Install the master version of the IPython-notebook-extensions repository as explained on the main wiki page.
diff --git a/nbextensions/usability/search-replace/search-replace.yaml b/nbextensions/usability/search-replace/search-replace.yaml
index 9319e0b..f5b9126 100644
--- a/nbextensions/usability/search-replace/search-replace.yaml
+++ b/nbextensions/usability/search-replace/search-replace.yaml
@@ -1,7 +1,7 @@
Type: IPython Notebook Extension
Name: Search-Replace
Description: Search and replace
-Link: https://github.com/ipython-contrib/IPython-notebook-extensions/wiki
+Link: readme.md
Icon: icon.png
Main: main.js
-Compatibility: 3.x
+Compatibility: 4.x
diff --git a/templates/nbextensions.html b/templates/nbextensions.html
index e80c369..fa518a4 100644
--- a/templates/nbextensions.html
+++ b/templates/nbextensions.html
@@ -15,8 +15,18 @@ data-extension-list='{{extension_list}}'
{% block headercontainer %}
-
+{{ super() }}
+
+{%- endif -%}
+{% endblock input_group %}
+
+{% block output %}
+
+{%- if cell.metadata.input_collapsed -%}
+ {{ super() | strip_output_prompt }}
+{%- else -%}
+ {{ super() }}
+{%- endif -%}
+
+{% endblock output %}
diff --git a/nbextensions/usability/hide_input/hide_input_all_hide.png b/nbextensions/usability/hide_input/hide_input_all_hide.png
deleted file mode 100644
index a15486a..0000000
Binary files a/nbextensions/usability/hide_input/hide_input_all_hide.png and /dev/null differ
diff --git a/nbextensions/usability/hide_input/hide_input_all_show.png b/nbextensions/usability/hide_input/hide_input_all_show.png
deleted file mode 100644
index 8d7e030..0000000
Binary files a/nbextensions/usability/hide_input/hide_input_all_show.png and /dev/null differ
diff --git a/nbextensions/usability/hide_input/ipython_nbconvert_config.py b/nbextensions/usability/hide_input/ipython_nbconvert_config.py
new file mode 100644
index 0000000..396edd1
--- /dev/null
+++ b/nbextensions/usability/hide_input/ipython_nbconvert_config.py
@@ -0,0 +1,7 @@
+c = get_config()
+
+#Export all the notebooks in the current directory to the sphinx_howto format.
+c.NbConvertApp.notebooks = ['*.ipynb']
+c.NbConvertApp.export_format = 'slides'
+c.Exporter.template_file = 'hide_input'
+c.Exporter.filters = {'strip_output_prompt': 'strip_output_prompt.strip_output_prompt'}
diff --git a/nbextensions/usability/limit_output/limit-output.yaml b/nbextensions/usability/limit_output/limit-output.yaml
index b20700f..4f2dd4c 100644
--- a/nbextensions/usability/limit_output/limit-output.yaml
+++ b/nbextensions/usability/limit_output/limit-output.yaml
@@ -1,9 +1,14 @@
Type: IPython Notebook Extension
Name: Limit Output
Description: This extension limits the number of charactrs that can be printed below a codecell
-Link: https://github.com/ipython-contrib/IPython-notebook-extensions/wiki/limit-output
+Link: readme.md
Icon: icon.png
Main: main.js
Compatibility: 4.x
-Parameter: limit_output
-ParameterDescription: Number of characters to limit output to
+Parameters:
+ limit_output:
+ description: Number of characters to limit output to
+ input_type: number
+ default: 10000
+ step: 1
+ min: 0
diff --git a/nbextensions/usability/limit_output/readme.md b/nbextensions/usability/limit_output/readme.md
new file mode 100644
index 0000000..61406dc
--- /dev/null
+++ b/nbextensions/usability/limit_output/readme.md
@@ -0,0 +1,11 @@
+This extension limits the number of characters a codecell can output as text. This also allows to interrupt endless loops.
+
+[](https://youtu.be/U26ujuPXf00)
+
+You can set the number of characters using the ConfigManager:
+```Python
+from IPython.html.services.config import ConfigManager
+ip = get_ipython()
+cm = ConfigManager(parent=ip, profile_dir=ip.profile_dir.location)
+cm.update('notebook', {"limit_output": 1000})
+```
diff --git a/nbextensions/usability/navigation-hotkeys/hotkeys.yaml b/nbextensions/usability/navigation-hotkeys/hotkeys.yaml
index 0f58db8..75acd8a 100644
--- a/nbextensions/usability/navigation-hotkeys/hotkeys.yaml
+++ b/nbextensions/usability/navigation-hotkeys/hotkeys.yaml
@@ -1,7 +1,7 @@
Type: IPython Notebook Extension
Name: Navigation-Hotkeys
Description: Additional hotkeys for easier navigation in the notebook
-Link: https://github.com/ipython-contrib/IPython-notebook-extensions/wiki/navigation_hotkeys
+Link: readme.md
Icon: icon.png
Main: main.js
-Compatibility: 3.x
+Compatibility: 4.x
diff --git a/nbextensions/usability/navigation-hotkeys/main.js b/nbextensions/usability/navigation-hotkeys/main.js
index 82bd9ad..3261460 100644
--- a/nbextensions/usability/navigation-hotkeys/main.js
+++ b/nbextensions/usability/navigation-hotkeys/main.js
@@ -1,206 +1,236 @@
// add custom shortcuts
-"use strict";
+define([
+ 'base/js/namespace',
+ 'jquery'
+], function(IPython, $) {
+ "use strict";
-var add_command_shortcuts = {
- 'esc' : {
- help : 'edit mode',
- help_index : 'aa',
- handler : function (event) {
- IPython.notebook.edit_mode();
- return false;
- }
- },
-
- 'home' : {
- help : 'go to top',
- help_index : 'ga',
- handler : function (event) {
- IPython.notebook.select(0);
- IPython.notebook.scroll_to_top()
- return false;
- }
- },
-
- 'end' : {
- help : 'go to bottom',
- help_index : 'ga',
- handler : function (event) {
- var ncells = IPython.notebook.ncells();
- IPython.notebook.select(ncells-1);
- IPython.notebook.scroll_to_bottom()
- return false;
- }
- },
-
- 'pageup' : {
- help : 'page up',
- help_index : 'aa',
- handler : function (event) {
- var wh = 0.6 * $(window).height();
- var cell = IPython.notebook.get_selected_cell();
- var h = 0;
- /* loop until we have enough cells to span the size of the notebook window (= one page) */
- do {
- h += cell.element.height();
- IPython.notebook.select_prev();
- cell = IPython.notebook.get_selected_cell();
- } while ( h < wh )
- var cp = cell.element.position();
- var sp = $('body').scrollTop();
- if ( cp.top < sp) {
- IPython.notebook.scroll_to_cell(IPython.notebook.get_selected_index());
- }
- cell.focus_cell();
- return false;
- }
- },
-
- 'pagedown' : {
- help : 'page down',
- help_index : 'aa',
- handler : function (event) {
-
- /* jump to bottom if we are already in the last cell */
- var ncells = IPython.notebook.ncells();
- if ( IPython.notebook.get_selected_index()+1 == ncells) {
- IPython.notebook.scroll_to_bottom();
- return false;
- }
-
- var wh = 0.6*$(window).height();
- var cell = IPython.notebook.get_selected_cell();
- var h = 0;
-
- /* loop until we have enough cells to span the size of the notebook window (= one page) */
- do {
- h += cell.element.height();
- IPython.notebook.select_next();
- cell = IPython.notebook.get_selected_cell();
- } while ( h < wh )
- cell.focus_cell();
- return false;
- }
- },
- };
-
-IPython.keyboard_manager.command_shortcuts.add_shortcuts(add_command_shortcuts);
-
-var add_edit_shortcuts = {
- 'Alt-add' : {
- help : 'split cell',
- help_index : 'eb',
- handler : function (event) {
- IPython.notebook.split_cell();
- IPython.notebook.edit_mode();
- return false;
- }
- },
- 'alt-subtract' : {
- help : 'merge cell',
- help_index : 'eb',
- handler : function (event) {
- var i = IPython.notebook.get_selected_index();
- if (i > 0) {
- var c = IPython.notebook.get_cell(i-1);
- var l = c.code_mirror.lineCount();
- IPython.notebook.merge_cell_above();
- var c = IPython.notebook.get_selected_cell();
- c.code_mirror.setCursor(l,0);
- }
- }
- },
- 'shift-enter' : {
- help : 'run cell, select next codecell',
- help_index : 'bb',
- handler : function (event) {
- IPython.notebook.execute_cell_and_select_below();
- var rendered = IPython.notebook.get_selected_cell().rendered;
- var ccell = IPython.notebook.get_selected_cell().cell_type;
- if (rendered === false || ccell === 'code') IPython.notebook.edit_mode();
- return false;
- }
- },
- 'ctrl-enter' : {
- help : 'run cell',
- help_index : 'bb',
- handler : function (event) {
- var cell = event.notebook.get_selected_cell();
- var mode = cell.mode;
- cell.execute();
- if (mode === "edit") IPython.notebook.edit_mode();
- return false;
- }
- },
- 'alt-n' : {
- help : 'toggle line numbers',
- help_index : 'xy',
- handler : function (event) {
- var cell = IPython.notebook.get_selected_cell();
- cell.toggle_line_numbers();
- return false;
- }
- },
- 'pagedown' : {
- help : 'page down',
- help_index : 'xy',
- handler : function (event) {
-
- var ic = IPython.notebook.get_selected_index();
- var cells = IPython.notebook.get_cells();
- var i, h=0;
- for (i=0; i < ic; i ++) {
- var cell=cells[i];
- h += cell.element.height();
- }
- var cell = cells[ic];
- var cur =cell.code_mirror.getCursor();
- h += cell.code_mirror.defaultTextHeight() * cur.line;
- IPython.notebook.element.animate({scrollTop:h}, 0);
- return false;
- }
- },
- 'pageup' : {
- help : 'page down',
- help_index : 'xy',
- handler : function (event) {
-
- var ic = IPython.notebook.get_selected_index();
- var cells = IPython.notebook.get_cells();
- var i, h=0;
- for (i=0; i < ic; i ++) {
- var cell=cells[i];
- h += cell.element.height();
- }
- var cell = cells[ic];
- var cur =cell.code_mirror.getCursor();
- h += cell.code_mirror.defaultTextHeight() * cur.line;
- IPython.notebook.element.animate({scrollTop:h}, 0);
- return false;
- }
- },
- 'ctrl-y' : {
- help : 'toggle markdown/code',
- handler : function (event) {
- var cell = IPython.notebook.get_selected_cell();
- if (cell.cell_type == 'code') {
- var cur = cell.code_mirror.getCursor();
- IPython.notebook.command_mode();
- IPython.notebook.to_markdown();
+ var add_command_shortcuts = {
+ 'esc' : {
+ help : 'edit mode',
+ help_index : 'aa',
+ handler : function() {
IPython.notebook.edit_mode();
- cell = IPython.notebook.get_selected_cell();
- cell.code_mirror.setCursor(cur);
- } else if (cell.cell_type == 'markdown') {
- var cur = cell.code_mirror.getCursor();
- IPython.notebook.command_mode();
- IPython.notebook.to_code();
- IPython.notebook.edit_mode();
- cell = IPython.notebook.get_selected_cell();
- cell.code_mirror.setCursor(cur);
+ return false;
}
- return false;
- }
- },
- };
+ },
-IPython.keyboard_manager.edit_shortcuts.add_shortcuts(add_edit_shortcuts);
+ 'home' : {
+ help : 'go to top',
+ help_index : 'ga',
+ handler : function() {
+ IPython.notebook.select(0);
+ IPython.notebook.scroll_to_top();
+ return false;
+ }
+ },
+
+ 'end' : {
+ help : 'go to bottom',
+ help_index : 'ga',
+ handler : function() {
+ var ncells = IPython.notebook.ncells();
+ IPython.notebook.select(ncells-1);
+ IPython.notebook.scroll_to_bottom();
+ return false;
+ }
+ },
+
+ 'pageup' : {
+ help : 'page up',
+ help_index : 'aa',
+ handler : function() {
+ var wh = 0.6 * $(window).height();
+ var cell = IPython.notebook.get_selected_cell();
+ var h = 0;
+ /* loop until we have enough cells to span the size of the notebook window (= one page) */
+ do {
+ h += cell.element.height();
+ IPython.notebook.select_prev();
+ cell = IPython.notebook.get_selected_cell();
+ } while ( h < wh );
+ var cp = cell.element.position();
+ var sp = $('body').scrollTop();
+ if ( cp.top < sp) {
+ IPython.notebook.scroll_to_cell(IPython.notebook.get_selected_index(), 0);
+ }
+ cell.focus_cell();
+ return false;
+ }
+ },
+
+ 'pagedown' : {
+ help : 'page down',
+ help_index : 'aa',
+ handler : function() {
+
+ /* jump to bottom if we are already in the last cell */
+ var ncells = IPython.notebook.ncells();
+ if ( IPython.notebook.get_selected_index()+1 == ncells) {
+ IPython.notebook.scroll_to_bottom();
+ return false;
+ }
+
+ var wh = 0.6*$(window).height();
+ var cell = IPython.notebook.get_selected_cell();
+ var h = 0;
+
+ /* loop until we have enough cells to span the size of the notebook window (= one page) */
+ do {
+ h += cell.element.height();
+ IPython.notebook.select_next();
+ cell = IPython.notebook.get_selected_cell();
+ } while ( h < wh );
+ cell.focus_cell();
+ return false;
+ }
+ },
+
+ 'shift-down': {
+ help : 'shift down',
+ help_index : 'aa',
+ handler : function() {
+ var index = IPython.notebook.get_selected_index();
+ if (index !== (IPython.notebook.ncells()-1) && index !== null) {
+ IPython.notebook.extend_selection('down');
+ IPython.notebook.focus_cell();
+ }
+ return false;
+ }
+ },
+
+ 'shift-up': {
+ help : 'shift down',
+ help_index : 'aa',
+ handler : function() {
+ var index = IPython.notebook.get_selected_index();
+ if (index !== 0 && index !== null) {
+ IPython.notebook.extend_selection('up');
+ IPython.notebook.focus_cell();
+ }
+ return false;
+ }
+ }
+
+ };
+
+ var add_edit_shortcuts = {
+ 'alt-add' : {
+ help : 'split cell',
+ help_index : 'eb',
+ handler : function() {
+ IPython.notebook.split_cell();
+ IPython.notebook.edit_mode();
+ return false;
+ }
+ },
+ 'alt-subtract' : {
+ help : 'merge cell',
+ help_index : 'eb',
+ handler : function() {
+ var i = IPython.notebook.get_selected_index();
+ if (i > 0) {
+ var l = IPython.notebook.get_cell(i-1).code_mirror.lineCount();
+ IPython.notebook.merge_cell_above();
+ IPython.notebook.get_selected_cell().code_mirror.setCursor(l,0);
+ }
+ }
+ },
+ 'shift-enter' : {
+ help : 'run cell, select next codecell',
+ help_index : 'bb',
+ handler : function() {
+ IPython.notebook.execute_cell_and_select_below();
+ var rendered = IPython.notebook.get_selected_cell().rendered;
+ var ccell = IPython.notebook.get_selected_cell().cell_type;
+ if (rendered === false || ccell === 'code') IPython.notebook.edit_mode();
+ return false;
+ }
+ },
+ 'ctrl-enter' : {
+ help : 'run cell',
+ help_index : 'bb',
+ handler : function() {
+ var cell = IPython.notebook.get_selected_cell();
+ var mode = cell.mode;
+ cell.execute();
+ if (mode === "edit") IPython.notebook.edit_mode();
+ return false;
+ }
+ },
+ 'alt-n' : {
+ help : 'toggle line numbers',
+ help_index : 'xy',
+ handler : function() {
+ var cell = IPython.notebook.get_selected_cell();
+ cell.toggle_line_numbers();
+ return false;
+ }
+ },
+ 'pagedown' : {
+ help : 'page down',
+ help_index : 'xy',
+ handler : function() {
+
+ var ic = IPython.notebook.get_selected_index();
+ var cells = IPython.notebook.get_cells();
+ var i, h=0;
+ for (i=0; i < ic; i ++) {
+ h += cells[i].element.height();
+ }
+ var cur = cells[ic].code_mirror.getCursor();
+ h += cells[ic].code_mirror.defaultTextHeight() * cur.line;
+ IPython.notebook.element.animate({scrollTop:h}, 0);
+ return false;
+ }
+ },
+ 'pageup' : {
+ help : 'page down',
+ help_index : 'xy',
+ handler : function() {
+
+ var ic = IPython.notebook.get_selected_index();
+ var cells = IPython.notebook.get_cells();
+ var i, h=0;
+ for (i=0; i < ic; i ++) {
+ h += cells[i].element.height();
+ }
+ var cur =cells[ic].code_mirror.getCursor();
+ h += cells[ic].code_mirror.defaultTextHeight() * cur.line;
+ IPython.notebook.element.animate({scrollTop:h}, 0);
+ return false;
+ }
+ },
+ 'ctrl-y' : {
+ help : 'toggle markdown/code',
+ handler : function() {
+ var cell = IPython.notebook.get_selected_cell();
+ var cur = cell.code_mirror.getCursor();
+ if (cell.cell_type == 'code') {
+ IPython.notebook.command_mode();
+ IPython.notebook.to_markdown();
+ IPython.notebook.edit_mode();
+ cell = IPython.notebook.get_selected_cell();
+ cell.code_mirror.setCursor(cur);
+ } else if (cell.cell_type == 'markdown') {
+ IPython.notebook.command_mode();
+ IPython.notebook.to_code();
+ IPython.notebook.edit_mode();
+ cell = IPython.notebook.get_selected_cell();
+ cell.code_mirror.setCursor(cur);
+ }
+ return false;
+ }
+ }
+ };
+
+ var load_ipython_extension = function() {
+ IPython.keyboard_manager.edit_shortcuts.add_shortcuts(add_edit_shortcuts);
+ IPython.keyboard_manager.command_shortcuts.add_shortcuts(add_command_shortcuts);
+ };
+ var extension = {
+ load_ipython_extension : load_ipython_extension
+ };
+ return extension;
+});
diff --git a/nbextensions/usability/navigation-hotkeys/readme.md b/nbextensions/usability/navigation-hotkeys/readme.md
new file mode 100644
index 0000000..cf6cc27
--- /dev/null
+++ b/nbextensions/usability/navigation-hotkeys/readme.md
@@ -0,0 +1,24 @@
+Hotkeys in
+
+## Edit Mode
+
+| Hotkey | Description |
+|------------|-------------|
+| `pageup` | scroll page up |
+| `pagedown` | scroll page down |
+| `Alt`- `+` | Split cell and keep cursor position |
+| `Alt`- `-` | Combine cell and keep cursor position |
+| `Alt`-`n` | Toggle line number display in current codecell |
+| `Shift`-`Enter` | Execute cell, goto next cell and stay in edit mode if next cell is a code cell or unredered markdown cell |
+| `Ctrl`-`Enter` | Execute cell and stay in edit mode if cell is a code cell |
+| `Ctrl`-`y` | toggle celltype between markdown and code |
+
+## Command Mode
+
+| Hotkey | Description |
+|------------|-------------|
+| `esc` | toggle to edit mode |
+| `home` | Go to top of notebook |
+| `end` | Go to bottom of notebook |
+| `pageup` | scroll page up |
+| `pagedown` | scroll page down |
diff --git a/nbextensions/usability/python-markdown/main.js b/nbextensions/usability/python-markdown/main.js
index 2c71564..507a707 100644
--- a/nbextensions/usability/python-markdown/main.js
+++ b/nbextensions/usability/python-markdown/main.js
@@ -17,10 +17,6 @@ define([
'notebook/js/textcell'
], function(IPython, $, cell, security, marked, events,textcell) {
"use strict";
- if (IPython.version[0] < 3) {
- console.log("This extension requires IPython 3.x");
- return
- }
/*
* Find Python expression enclosed in {{ }}, execute and add to text as
diff --git a/nbextensions/usability/python-markdown/python-markdown-post.png b/nbextensions/usability/python-markdown/python-markdown-post.png
deleted file mode 100644
index 3c95198..0000000
Binary files a/nbextensions/usability/python-markdown/python-markdown-post.png and /dev/null differ
diff --git a/nbextensions/usability/python-markdown/python-markdown-pre.png b/nbextensions/usability/python-markdown/python-markdown-pre.png
deleted file mode 100644
index 5226d95..0000000
Binary files a/nbextensions/usability/python-markdown/python-markdown-pre.png and /dev/null differ
diff --git a/nbextensions/usability/python-markdown/python-markdown.yaml b/nbextensions/usability/python-markdown/python-markdown.yaml
index 2d81b79..19d8e81 100644
--- a/nbextensions/usability/python-markdown/python-markdown.yaml
+++ b/nbextensions/usability/python-markdown/python-markdown.yaml
@@ -1,7 +1,7 @@
Type: IPython Notebook Extension
Name: Python Markdown
Description: Allows embedding Python-code in markdown cells
-Link: https://github.com/ipython-contrib/IPython-notebook-extensions/wiki/python-markdown
+Link: readme.md
Icon: python-markdown.png
Main: main.js
Preprocessor: pymdpreprocessor.py
diff --git a/nbextensions/usability/python-markdown/readme.md b/nbextensions/usability/python-markdown/readme.md
new file mode 100644
index 0000000..40e84e7
--- /dev/null
+++ b/nbextensions/usability/python-markdown/readme.md
@@ -0,0 +1,48 @@
+This extension allows dynamically displaying Python variables in markdown cells.
+Example:
+If you set variable `a` in Python
+```Python
+a = 1.23
+```
+and write the following line in a markdown cell:
+```Markdown
+a = {{a}}
+```
+It will be displayed as:
+```Markdown
+a = 1.23
+```
+
+[](https://youtu.be/_wLwLsgkExc)
+
+## Further examples
+Before rendering the markdown cell:
+
+
+After rendering the markdown cell:
+
+
+Python code is only executed when the notebook is trusted. So if your original Python code is still shown in rendered markdown output, please make sure your notebook is trusted.
+
+**Caution:** There is no restriction in the expression you can embedd in `{{ }}`. Be careful as you might crash your browser if you return too large datasets.
+
+Also, images in markdown will be removed due to the HTML sanitizer after a reload.
+
+## Installation
+Install the master version of the IPython-notebook-extensions repository as explained on the main wiki page.
+
+Then load the extension from within the IPyton notebook:
+```javascript
+%%javascript
+IPython.load_extensions('IPython-notebook-extensions-master/usability/python-markdown/main');
+```
+
+In order to have `nbconvert` show the preprocessed output, copy the `pymdpreprocessor.py` file to a location in your `PYTHONPATH`and add or extend the following line to your `ipython_nbconvert_config.py` configuration file:
+`c.Exporter.preprocessors = [ 'pymdpreprocessor.PyMarkdownPreprocessor' ]`
+
+## Internals
+The extension overrides the `textcell.MarkdownCell.prototype.render` function and searches for a Python expression enclosed in double curly braced `{{ {{page_title}}
' +
+
+
+
+
{% endblock %}
{% block header %}
@@ -25,7 +35,7 @@ data-extension-list='{{extension_list}}'
{% block site %}
-
+
{% endblock %}
@@ -33,5 +43,5 @@ data-extension-list='{{extension_list}}'
{{super()}}
-
+
{% endblock %}
diff --git a/templates/rendermd.html b/templates/rendermd.html
index 7644f27..91b74a4 100755
--- a/templates/rendermd.html
+++ b/templates/rendermd.html
@@ -33,5 +33,5 @@ data-md-url='{{render_url}}'
{{super()}}
-
+
{% endblock %}
diff --git a/tests/test-postprocessors.py b/tests/test-postprocessors.py
new file mode 100644
index 0000000..e69de29