forked from kirbs-/hide_code
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhide_code.js
More file actions
336 lines (291 loc) · 11 KB
/
Copy pathhide_code.js
File metadata and controls
336 lines (291 loc) · 11 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
/* -*- coding: utf-8 -*-
* ----------------------------------------------------------------------------
* Copyright (c) 2015 - Chris Kirby
*
* Distributed under the terms of the MIT License.
*
* An IPython notebook extension to hide code inputs and prompts for presentation.
* -----------------------------------------------------------------------------
*/
define([
'jquery',
'notebook/js/celltoolbar',
'base/js/namespace'
],
function ($, celltoolbar, Jupyter){
"use strict";
const CODE = 1;
const PROMPT = 0;
const OUTPUT = 2;
var ctb = celltoolbar.CellToolbar;
function hideCodeSetter(cell, value){
if (cell.metadata.hideCode == undefined){ cell.metadata.hideCode = false }
cell.metadata.hideCode = value;
toggleHideCode(cell);
}
function hideCodeGetter(cell){
var isHidden = cell.metadata.hideCode;
toggleHideCode(cell);
return (isHidden == undefined) ? undefined : isHidden
}
/*
* Sets notebook cell's hide code metadata.
* @param {Notebook Cell} cell
* @param {Boolean} value
*/
function hidePromptSetter(cell, value){
if (cell.metadata.hidePrompt == undefined){ cell.metadata.hidePrompt = false }
cell.metadata.hidePrompt = value;
toggleHidePrompt(cell);
}
function hidePromptGetter(cell){
var isHidden = cell.metadata.hidePrompt;
toggleHidePrompt(cell);
return (isHidden == undefined) ? undefined : isHidden
}
function hideOutputSetter(cell, value){
if (cell.metadata.hideOutput == undefined){ cell.metadata.hideOutput = false }
cell.metadata.hideOutput = value;
toggleHideOutput(cell);
}
function hideOutputGetter(cell){
var isHidden = cell.metadata.hideOutput;
toggleHideOutput(cell);
return (isHidden == undefined) ? undefined : isHidden
}
function toggleHideCode(cell){
var c = $(cell.element);
if (cell.metadata.hideCode && cell.class_config.classname != 'MarkdownCell'){
c.find('.input_area').hide();
} else if(cell.class_config.classname != 'MarkdownCell') {
c.find('.input_area').show();
}
}
function toggleHidePrompt(cell){
var c = $(cell.element);
if (cell.metadata.hidePrompt && cell.class_config.classname != 'MarkdownCell'){
c.find('.prompt').css('visibility','hidden');
} else if(cell.class_config.classname != 'MarkdownCell') {
c.find('.prompt').css('visibility','visible');
}
}
function toggleHideOutput(cell){
var c = $(cell.element);
if (cell.metadata.hideOutput && cell.class_config.classname != 'MarkdownCell'){
c.find('.output_wrapper .output_subarea').css('display','none');
} else if(cell.class_config.classname != 'MarkdownCell') {
c.find('.output_wrapper .output_subarea').css('display','block');
}
}
function toggleAllPromptsAndCode(){
var all_hidden = Jupyter.notebook.metadata.hide_code_all_hidden;
if ( all_hidden == undefined ) {
all_hidden = false;
};
if ( all_hidden == false ) {
Jupyter.notebook.metadata.hide_code_all_hidden = true;
hideEach(CODE, Jupyter.notebook.get_cells(), true);
hideEach(PROMPT, Jupyter.notebook.get_cells(), true);
} else {
Jupyter.notebook.metadata.hide_code_all_hidden = false;
hideEach(CODE, Jupyter.notebook.get_cells(), false);
hideEach(PROMPT, Jupyter.notebook.get_cells(), false);
}
}
/**
* Export handlers
**/
function exportHTML(){
window.location = exportLink("html");
Jupyter.notebook.kernel.reconnect();
}
function exportPDF(){
window.location = exportLink("pdf");
Jupyter.notebook.kernel.reconnect();
}
function exportPDFLatex(){
window.location = exportLink("latexpdf");
Jupyter.notebook.kernel.reconnect();
}
/**
* Add a toolbar button to toggle visibility of all code cells, input/output prompts, and remove any highlighting for the selected cell.
**/
function addHideCodeButtonToToolbar(){
Jupyter.toolbar.add_buttons_group([
Jupyter.actions.register ({
'help': 'Toggle everything',
'icon': 'fa-code',
'handler': toggleAllPromptsAndCode
}, 'hide_code:toggle_all'),
Jupyter.actions.register ({
'help': 'Export to HTML',
'icon': 'fa-file-text-o',
'handler': exportHTML
}, 'hide_code:export_html'),
Jupyter.actions.register ({
'help': 'Export to PDF via HTML',
'icon': 'fa-file-pdf-o',
'handler': exportPDF
}, 'hide_code:export_pdf'),
Jupyter.actions.register ({
'help': 'Export to PDF via Latex',
'icon': 'fa-file-o',
'handler': exportPDFLatex
}, 'hide_code:export_pdflatex')
]);
}
function exportLink(path){
return window.location.origin + window.location.pathname + "/export/" + path;
}
var hideCodeCallback = ctb.utils.checkbox_ui_generator( 'Hide Code ', hideCodeSetter, hideCodeGetter);
var hidePromptCallback = ctb.utils.checkbox_ui_generator('Hide Prompts ', hidePromptSetter, hidePromptGetter);
var hideOutputCallback = ctb.utils.checkbox_ui_generator('Hide Outputs ', hideOutputSetter, hideOutputGetter);
function hideEach(type, cells, hidden){
$.each(cells, function(index, value){
switch(type){
case PROMPT:
hidePromptSetter(cells[index], hidden);
break;
case CODE:
hideCodeSetter(cells[index], hidden);
break;
case OUTPUT:
hideOutputSetter(cells[index], hidden);
break;
}
try{
$($(Jupyter.notebook.get_selected_cell().celltoolbar.inner_element[0]).find('input')[type]).prop('checked', hidden);
} catch(err){
//do nothing
}
});
}
/*
Keyboard shortcut handlers.
*/
var hideCodeKeyboardAction = Jupyter.keyboard_manager.actions.register({
help: 'Hides selected cell\'s code',
icon: 'fa-code',
help_index: '',
handler: function(env){
hideEach(CODE, env.notebook.get_selected_cells(), true);
},
}, 'hide_code_action','hide_code');
/**
* Keyboard short cut action to hide selected cells.
* Binds to W
**/
var showCodeKeyboardAction = Jupyter.keyboard_manager.actions.register({
help: 'Shows selected cell\'s code',
icon: 'fa-code',
help_index: '',
handler: function(env){
hideEach(CODE, env.notebook.get_selected_cells(), false);
},
}, 'show_code_action','hide_code');
var hidePromptKeyboardAction = Jupyter.keyboard_manager.actions.register({
help: 'Hides selected cell\'s prompts.',
icon: 'fa-code',
help_index: '',
handler: function(env){
hideEach(PROMPT, env.notebook.get_selected_cells(), true);
},
}, 'hide_prompt_action','hide_code');
/**
* Keyboard short cut action to hide selected cells.
* Binds to W,W
**/
var showPromptKeyboardAction = Jupyter.keyboard_manager.actions.register({
help: 'Shows selected cell\'s prompts.',
icon: 'fa-code',
help_index: '',
handler: function(env){
hideEach(PROMPT, env.notebook.get_selected_cells(), false);
},
}, 'show_prompt_action','hide_code');
var hideOutputKeyboardAction = Jupyter.keyboard_manager.actions.register({
help: 'Hides selected cell\'s prompts.',
icon: 'fa-code',
help_index: '',
handler: function(env){
hideEach(OUTPUT, env.notebook.get_selected_cells(), true);
},
}, 'hide_output_action','hide_code');
/**
* Keyboard short cut action to hide selected cells.
* Binds to W,W
**/
var showOutputKeyboardAction = Jupyter.keyboard_manager.actions.register({
help: 'Shows selected cell\'s prompts.',
icon: 'fa-code',
help_index: '',
handler: function(env){
hideEach(OUTPUT, env.notebook.get_selected_cells(), false);
},
}, 'show_output_action','hide_code');
var hidePromptsAndCodeKeyboardAction = Jupyter.keyboard_manager.actions.register({
help: 'Hides selected cell\'s prompts and code.',
icon: 'fa-code',
help_index: '',
handler: function(env){
toggleAllPromptsAndCode()
},
}, 'toggle_prompt_and_code_action','hide_code');
function addKeyboardShortcutBindings(){
Jupyter.keyboard_manager.command_shortcuts.add_shortcut('e', 'hide_code:hide_code_action', 'hide_code');
Jupyter.keyboard_manager.command_shortcuts.add_shortcut('shift-e', 'hide_code:show_code_action', 'hide_code');
Jupyter.keyboard_manager.command_shortcuts.add_shortcut('w', 'hide_code:hide_prompt_action', 'hide_code');
Jupyter.keyboard_manager.command_shortcuts.add_shortcut('shift-w', 'hide_code:show_prompt_action', 'hide_code');
Jupyter.keyboard_manager.command_shortcuts.add_shortcut('r', 'hide_code:hide_output_action', 'hide_code');
Jupyter.keyboard_manager.command_shortcuts.add_shortcut('shift-r', 'hide_code:show_output_action', 'hide_code');
Jupyter.keyboard_manager.command_shortcuts.add_shortcut('t', 'hide_code:toggle_prompt_and_code_action', 'hide_code');
}
function addHideCodeMenuItem(){
var menu = getMenuBar()
menu.append(menuItem('Hide Code','#'));
getHideCodeMenu().append(dropdownMenuItem('PDF Export (HTML)', exportLink('pdf'), 'HTML PDF exporter.'));
getHideCodeMenu().append(dropdownMenuItem('PDF Export (Latex)', exportLink('latexpdf'), 'Latex PDF exporter.'));
getHideCodeMenu().append(dropdownMenuItem('HTML Export', exportLink('html'), 'HTML exporter.'));
getHideCodeMenu().append(dropdownMenuItem('Latex Export', exportLink('latex'), 'Latex exporter.'));
getHideCodeMenu().append(dropdownMenuItem('Slides Export', exportLink('slides'), 'Slides exporter.'));
}
function getMenuBar(){
return $('#menus').find('.navbar-nav')
}
function getHideCodeMenu(){
return $('#hide_code_menu_list')
}
function dropdownMenuItem(text, url, tooltip){
var item = $('<li>', {title: tooltip, });
var link = $('<a>', {href: url, text: text});
item.append(link);
return item
}
function menuItem(text, url){
var menu_item = $('<li>', {class: 'dropdown', id: 'hide_code_menu_item'});
var link = $('<a>', {class: 'dropdown-toggle', href: url, text: text, 'data-toggle': 'dropdown'});
var dropdown_menu = $('<ul>', {id: 'hide_code_menu_list', class: 'dropdown-menu'});
menu_item.append(link);
menu_item.append(dropdown_menu);
return menu_item
}
function load_ipython_extension(){
ctb.register_callback('hide_code.hideCode', hideCodeCallback);
ctb.register_callback('hide_code.hidePrompts', hidePromptCallback);
ctb.register_callback('hide_code.hideOutputs', hideOutputCallback);
ctb.register_preset('Hide code',['hide_code.hidePrompts','hide_code.hideCode','hide_code.hideOutputs']);
addHideCodeButtonToToolbar();
addKeyboardShortcutBindings();
addHideCodeMenuItem();
$.each(Jupyter.notebook.get_cells(), function(index, cell){
toggleHidePrompt(cell);
toggleHideCode(cell);
toggleHideOutput(cell);
});
console.log('hide_code setup complete');
}
// setup();
return {
load_ipython_extension: load_ipython_extension
}
});