Skip to content

Commit

Permalink
Update doc on sending code from markdown cell to side panel. vatlab/s…
Browse files Browse the repository at this point in the history
  • Loading branch information
Bo Peng committed Mar 18, 2018
1 parent e3f2716 commit 20f0c8d
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions src/documentation/Notebook_Interface.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,13 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Please follow the instructions in [Running SoS](https://vatlab.github.io/sos-docs/#runningsos) to install `sos`, `sos-notebook`, and relevant language modules. After the installation of `sos-notebook`, you should be able to see `sos` from the output of:"
"Please follow the instructions in [Running SoS](https://vatlab.github.io/sos-docs/#runningsos) to install `sos`, `sos-notebook`, and relevant language modules. After the installation of `sos-notebook`, you should install the sos kernel to Jupyter with command\n",
"\n",
"```bash\n",
"% python -m sos_notebook.install\n",
"```\n",
"\n",
"`sos` should then appear in the output of:"
]
},
{
Expand Down Expand Up @@ -540,7 +546,7 @@
"source": [
"In addition to shortcuts defined by Jupyter (e.g. `Ctrl-Enter` to evaluate a cell and `Shift-Enter` to evaluate a cell and move next), the SoS kernel defines the following shortcuts\n",
"\n",
"1. `Ctrl-Shift-Enter` This shortcut **send selected text or current line if there is no selection to the panel cell for evaluation**, using the kernel of the current cell. This effectively allows you to evaluate content of a cell line by line.\n",
"1. `Ctrl-Shift-Enter` This shortcut **send current line or selected text to the panel cell for evaluation**. This effectively allows you to evaluate content of a cell line by line. This shortcut works for both code and markdown cells. The panel cell will switch to the kernel of the sending cell if the sending cell is a code cell. \n",
"2. `Ctrl-Shift-t` executes magic `%toc` that **displays the table of content of the current notebook** in the side panel, allowing you to easily navigate within a (long) notebook.\n",
"3. `Ctrl-Shift-O` (output) **toggles a code cell tag `show_output`** and mark the output with a gray bar to the right of the output area, or toggle a markdown cell tag `hide_output`. The tags will be rendered accordingly in HTML reports generated using sos templates.\n",
"4. `Ctrl-Shift-v` (paste-table) If you have a table copied from external sources such as HTML page or excel file and if you are inside of a markdown cell, this shortcut **pastes table as markdown code to the current cell**. This allows easy copy of tables to SoS notebook.\n",
Expand Down Expand Up @@ -4322,7 +4328,7 @@
"height": "200px",
"style": "side"
},
"version": "0.9.12.7"
"version": "0.9.12.11"
},
"toc": {
"colors": {
Expand Down

0 comments on commit 20f0c8d

Please sign in to comment.