mirror of
https://github.com/jupyter/notebook.git
synced 2025-01-24 12:05:22 +08:00
port some typos
This commit is contained in:
Matthias Bussonnier
parent
98745984c2
commit
552fd197d5
@ -11,23 +11,23 @@
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"One of the main reason that allowed us to develop the current notebook web application \n",
|
||||
"One of the main reasons why we developed the current notebook web application \n",
|
||||
"was to embrace the web technology. \n",
|
||||
"\n",
|
||||
"By being a pure web application using HTML, Javascript and CSS, the Notebook can get \n",
|
||||
"all the web technology improvement for free. Thus, as browsers support for different \n",
|
||||
"media extend, The notebook web app should be able to be compatible without modification. \n",
|
||||
"By being a pure web application using HTML, Javascript, and CSS, the Notebook can get \n",
|
||||
"all the web technology improvement for free. Thus, as browser support for different \n",
|
||||
"media extend, the notebook web app should be able to be compatible without modification. \n",
|
||||
"\n",
|
||||
"This is also true with performance of the User Interface as the speed of javascript VM increase. "
|
||||
"This is also true with performance of the User Interface as the speed of Javascript VM increases. "
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The other advantage of using only web technology is that the code of the interface is fully accessible to the end user, and modifiable live.\n",
|
||||
"The other advantage of using only web technology is that the code of the interface is fully accessible to the end user and is modifiable live.\n",
|
||||
"Even if this task is not always easy, we strive to keep our code as accessible and reusable as possible.\n",
|
||||
"This should allow with minimum effort to develop small extensions that customize the behavior of the web interface. "
|
||||
"This should allow us with minimum effort to develop small extensions that customize the behavior of the web interface. "
|
||||
]
|
||||
},
|
||||
{
|
||||
@ -41,13 +41,12 @@
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"The first tool that is available to you and that you should be aware of are browser \"developers tool\". The exact naming can change across browser, and might require the installation of extensions. But basically they can allow you to inspect/modify the DOM, and interact with the javascript code that run the frontend.\n",
|
||||
"The first tool that is available to you and that you should be aware of are browser \"developers tool\". The exact naming can change across browser and might require the installation of extensions. But basically they can allow you to inspect/modify the DOM, and interact with the javascript code that runs the frontend.\n",
|
||||
"\n",
|
||||
" - In Chrome and safari Developer tools are in the menu [Put mmenu name in english here] \n",
|
||||
" - In firefox you might need to install [Firebug](http://getfirebug.com/)\n",
|
||||
" - others ?\n",
|
||||
" - In Chrome and Safari, Developer tools are in the menu `View > Developer > Javascript Console` \n",
|
||||
" - In Firefox you might need to install [Firebug](http://getfirebug.com/)\n",
|
||||
" \n",
|
||||
"Those will be your best friends to debug and try different approach for your extensions."
|
||||
"Those will be your best friends to debug and try different approaches for your extensions."
|
||||
]
|
||||
},
|
||||
{
|
||||
@ -61,19 +60,19 @@
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"#### using magics"
|
||||
"#### Using magics"
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Above tools can be tedious to edit long javascript files. Hopefully we provide the `%%javascript` magic. This allows you to quickly inject javascript into the notebook. Still the javascript injected this way will not survive reloading. Hence it is a good tool for testing an refining a script.\n",
|
||||
"The above tools can be tedious for editing edit long JavaScript files. Therefore we provide the `%%javascript` magic. This allows you to quickly inject JavaScript into the notebook. Still the javascript injected this way will not survive reloading. Hence, it is a good tool for testing an refining a script.\n",
|
||||
"\n",
|
||||
"You might see here and there people modifying css and injecting js into notebook by reading file and publishing them into the notebook.\n",
|
||||
"Not only this often break the flow of the notebook and make the re-execution of the notebook broken, but it also mean that you need to execute those cells on all the notebook every time you need to update the code.\n",
|
||||
"You might see here and there people modifying css and injecting js into the notebook by reading file(s) and publishing them into the notebook.\n",
|
||||
"Not only does this often break the flow of the notebook and make the re-execution of the notebook broken, but it also means that you need to execute those cells in the entire notebook every time you need to update the code.\n",
|
||||
"\n",
|
||||
"This can still be useful in some cases, like the `%autosave` magic that allows to control the time between each save. But this can be replaced by a Javascript dropdown menu to select save interval."
|
||||
"This can still be useful in some cases, like the `%autosave` magic that allows to control the time between each save. But this can be replaced by a JavaScript dropdown menu to select the save interval."
|
||||
]
|
||||
},
|
||||
{
|
||||
@ -99,8 +98,8 @@
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"To inject Javascript we provide an entry point: `custom.js` that allow the user to execute and load other resources into the notebook.\n",
|
||||
"Javascript code in `custom.js` will be executed when the notebook app start and can then be used to customize almost anything in the UI and in the behavior of the notebook.\n",
|
||||
"To inject Javascript we provide an entry point: `custom.js` that allows the user to execute and load other resources into the notebook.\n",
|
||||
"Javascript code in `custom.js` will be executed when the notebook app starts and can then be used to customize almost anything in the UI and in the behavior of the notebook.\n",
|
||||
"\n",
|
||||
"`custom.js` can be found in the Jupyter dir. You can share your custom.js with others."
|
||||
]
|
||||
@ -166,14 +165,14 @@
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Note that `custom.js` is ment to be modified by user, when writing a script, you can define it in a separate file and add a line of configuration into `custom.js` that will fetch and execute the file."
|
||||
"Note that `custom.js` is meant to be modified by user. When writing a script, you can define it in a separate file and add a line of configuration into `custom.js` that will fetch and execute the file."
|
||||
]
|
||||
},
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"**Warning** : even if modification of `custom.js` take effect immediately after browser refresh (except if browser cache is aggressive), *creating* a file in `static/` directory need a **server restart**."
|
||||
"**Warning** : even if modification of `custom.js` takes effect immediately after browser refresh (except if browser cache is aggressive), *creating* a file in `static/` directory needs a **server restart**."
|
||||
]
|
||||
},
|
||||
{
|
||||
@ -214,7 +213,7 @@
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"We've seen above that you can change the autosave rate by using a magic. This is typically something I don't want to type everytime, and that I don't like to embed into my workflow and documents. (reader don't care what my autosave time is), let's build an extension that allow to do it. "
|
||||
"We've seen above that you can change the autosave rate by using a magic. This is typically something I don't want to type everytime, and that I don't like to embed into my workflow and documents. (readers don't care what my autosave time is). Let's build an extension that allows us to do it. "
|
||||
]
|
||||
},
|
||||
{
|
||||
@ -300,7 +299,7 @@
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"Sadly you will have to read the js source file (but there are lots of comments) an/or build the javascript documentation using yuidoc.\n",
|
||||
"Sadly you will have to read the js source file (but there are lots of comments) and/or build the JavaScript documentation using yuidoc.\n",
|
||||
"If you have `node` and `yui-doc` installed:"
|
||||
]
|
||||
},
|
||||
@ -341,7 +340,7 @@
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"By browsing the doc you will see that we have some convenience methods that avoid to re-invent the UI everytime :\n",
|
||||
"By browsing the docs you will see that we have some convenience methods that allows us to avoid re-inventing the UI everytime :\n",
|
||||
"```javascript\n",
|
||||
"Jupyter.toolbar.add_buttons_group([\n",
|
||||
" {\n",
|
||||
@ -373,8 +372,8 @@
|
||||
"foo": true
|
||||
},
|
||||
"source": [
|
||||
"The most requested feature is generally to be able to distinguish individual cell in the notebook, or run specific action with them.\n",
|
||||
"To do so, you can either use `Jupyter.notebook.get_selected_cell()`, or rely on `CellToolbar`. This allow you to register asset of action and graphical element that will be attached on individual cells."
|
||||
"The most requested feature is generally to be able to distinguish an individual cell in the notebook, or run a specific action with them.\n",
|
||||
"To do so, you can either use `Jupyter.notebook.get_selected_cell()`, or rely on `CellToolbar`. This allows you to register a set of actions and graphical elements that will be attached to individual cells."
|
||||
]
|
||||
},
|
||||
{
|
||||
|
||||
Loading…
Reference in New Issue
Block a user