quickhelp.js
133 lines
| 5.1 KiB
| application/javascript
|
JavascriptLexer
|
r5023 | //---------------------------------------------------------------------------- | ||
// 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. | ||||
//---------------------------------------------------------------------------- | ||||
//============================================================================ | ||||
|
r5066 | // QuickHelp button | ||
|
r5023 | //============================================================================ | ||
var IPython = (function (IPython) { | ||||
|
r12103 | "use strict"; | ||
|
r5023 | |||
|
r5066 | var QuickHelp = function (selector) { | ||
|
r5023 | }; | ||
|
r5858 | QuickHelp.prototype.show_keyboard_shortcuts = function () { | ||
// toggles display of keyboard shortcut dialog | ||||
|
r5023 | var that = this; | ||
|
r5858 | if ( this.shortcut_dialog ){ | ||
// if dialog is already shown, close it | ||||
|
r10939 | $(this.shortcut_dialog).modal("toggle"); | ||
|
r5858 | return; | ||
} | ||||
|
r14037 | var command_shortcuts = IPython.keyboard_manager.command_shortcuts.help(); | ||
var edit_shortcuts = IPython.keyboard_manager.edit_shortcuts.help(); | ||||
var help, shortcut; | ||||
|
r14093 | var i, half, n; | ||
|
r14037 | var element = $('<div/>'); | ||
|
r14066 | // The documentation | ||
var doc = $('<div/>').addClass('alert'); | ||||
doc.append( | ||||
|
r14634 | $('<button/>').addClass('close').attr('data-dismiss','alert').html('×') | ||
|
r14066 | ).append( | ||
'The IPython Notebook has two different keyboard input modes. <b>Edit mode</b> '+ | ||||
'allow you the type code/text into a cell and is indicated by a green cell '+ | ||||
|
r14093 | 'border. <b>Command mode</b> binds the keyboard to notebook level actions '+ | ||
'and is indicated by a grey cell border.' | ||||
|
r14066 | ) | ||
element.append(doc); | ||||
|
r14037 | // Command mode | ||
|
r14096 | 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 : {} | ||||
} | ||||
}); | ||||
}; | ||||
QuickHelp.prototype.build_command_help = function () { | ||||
var command_shortcuts = IPython.keyboard_manager.command_shortcuts.help(); | ||||
var help, shortcut; | ||||
var i, half, n; | ||||
// Command mode | ||||
|
r14093 | var cmd_div = $('<div/>').append($('<h4>Command Mode (press ESC 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++) { | ||||
|
r14037 | help = command_shortcuts[i]['help']; | ||
shortcut = command_shortcuts[i]['shortcut']; | ||||
|
r14093 | cmd_col1.append($('<div>').addClass('quickhelp'). | ||
|
r14634 | append($('<span/>').addClass('shortcut_key').text(shortcut)). | ||
append($('<span/>').addClass('shortcut_descr').text(' : ' + help)) | ||||
|
r14093 | ); | ||
|
r14037 | }; | ||
|
r14093 | for (i=half; i<n; i++) { | ||
help = command_shortcuts[i]['help']; | ||||
shortcut = command_shortcuts[i]['shortcut']; | ||||
cmd_col2.append($('<div>').addClass('quickhelp'). | ||||
|
r14634 | append($('<span/>').addClass('shortcut_key').text(shortcut)). | ||
append($('<span/>').addClass('shortcut_descr').text(' : ' + help)) | ||||
|
r14093 | ); | ||
}; | ||||
cmd_sub_div.append(cmd_col1).append(cmd_col2); | ||||
cmd_div.append(cmd_sub_div); | ||||
|
r14096 | return cmd_div; | ||
} | ||||
QuickHelp.prototype.build_edit_help = function () { | ||||
var edit_shortcuts = IPython.keyboard_manager.edit_shortcuts.help(); | ||||
var help, shortcut; | ||||
var i, half, n; | ||||
|
r14037 | |||
// Edit mode | ||||
|
r14093 | var edit_div = $('<div/>').append($('<h4>Edit Mode (press ENTER 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; | ||||
half = ~~(n/2); // Truncate :) | ||||
for (i=0; i<half; i++) { | ||||
|
r14037 | help = edit_shortcuts[i]['help']; | ||
shortcut = edit_shortcuts[i]['shortcut']; | ||||
|
r14093 | edit_col1.append($('<div>').addClass('quickhelp'). | ||
|
r14634 | append($('<span/>').addClass('shortcut_key').text(shortcut)). | ||
append($('<span/>').addClass('shortcut_descr').text(' : ' + help)) | ||||
|
r14093 | ); | ||
}; | ||||
for (i=half; i<n; i++) { | ||||
help = edit_shortcuts[i]['help']; | ||||
shortcut = edit_shortcuts[i]['shortcut']; | ||||
edit_col2.append($('<div>').addClass('quickhelp'). | ||||
|
r14634 | append($('<span/>').addClass('shortcut_key').text(shortcut)). | ||
append($('<span/>').addClass('shortcut_descr').text(' : ' + help)) | ||||
|
r14093 | ); | ||
|
r5858 | }; | ||
|
r14093 | edit_sub_div.append(edit_col1).append(edit_col2); | ||
edit_div.append(edit_sub_div); | ||||
|
r14096 | return edit_div; | ||
} | ||||
|
r5023 | |||
// Set module variables | ||||
|
r5066 | IPython.QuickHelp = QuickHelp; | ||
|
r5023 | |||
return IPython; | ||||
}(IPython)); | ||||