##// END OF EJS Templates
fix a few markup issues and inaccuracies
MinRK -
Show More
@@ -59,6 +59,7 b' The currently supported export formats are the following:'
59 59
60 60 .. _Sphinx: http://sphinx-doc.org/
61 61 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
62 .. _Markdown: http://daringfireball.net/projects/markdown/syntax
62 63
63 64 * Python:
64 65
@@ -38,7 +38,7 b' The IPython Notebook combines two components:'
38 38
39 39 Since the similarity in names can lead to some confusion, in this
40 40 documentation we will use capitalization of the word "notebook" to
41 distinguish the *N*otebook app and *n*otebook documents, thinking of the
41 distinguish the Notebook app and notebook documents, thinking of the
42 42 Notebook app as being a proper noun. We will also always refer to the
43 43 "Notebook app" when we are referring to the browser-based interface,
44 44 and usually to "notebook documents", instead of "notebooks", for added
@@ -52,7 +52,7 b' The Notebook app automatically saves, at certain intervals, the contents of'
52 52 the notebook space to a notebook document stored on disk, with the same name
53 53 as the title of the notebook space, and the file extension ``.ipynb``. For
54 54 this reason, there is no confusion about using the same word "notebook" for
55 both the notebook space and the corresonding notebook document, since they are
55 both the notebook space and the corresponding notebook document, since they are
56 56 really one and the same concept (we could say that they are "isomorphic").
57 57
58 58
@@ -85,35 +85,32 b' The main features of the IPython Notebook app include:'
85 85 Notebook documents
86 86 ~~~~~~~~~~~~~~~~~~
87 87
88 Notebook document files are just standard, ASCII-coded text files with the
89 extension ``.ipynb``, stored in the working directory on your computer.
90 Since the contents of the files are just plain text, they can be easily
91 version-controlled and shared with colleagues.
92
93 Internally, notebook document files use the JSON_ format, allowing them to
94 store a *complete*, *reproducible*, *one-to-one* copy of the state of the
88 Notebook document files are simple JSON_ files with the
89 extension ``.ipynb``.
90 Since JSON is just plain text, they can be easily version-controlled and shared with colleagues.
91 The notebook stores a *complete*, *reproducible*, *one-to-one* copy of the state of the
95 92 computational state as it is inside the Notebook app. All computations
96 93 carried out, and the corresponding results obtained, can be combined in
97 94 a literate way, interleaving executable code with rich text, mathematics,
98 and HTML 5 representations of objects.
95 and rich representations of objects.
99 96
100 97 .. _JSON: http://en.wikipedia.org/wiki/JSON
101 98
102 99 Notebooks may easily be exported to a range of static formats, including
103 HTML (for example, for blog posts), PDF and slide shows, via the
104 newly-included `nbconvert script`_ functionality.
100 HTML (for example, for blog posts), PDF and slide shows,
101 via the new nbconvert_ command.
105 102
106 Furthermore, any ``.ipynb`` notebook document with a publicly-available
107 URL can be shared via the `IPython Notebook Viewer`_ service. This service
108 loads the notebook document from the URL which will
109 provide it as a static web page. The results may thus be shared with a
103 Furthermore, any ``.ipynb`` notebook document available from a public
104 URL can be shared via the `IPython Notebook Viewer <nbviewer>`_ service.
105 This service loads the notebook document from the URL and will
106 render it as a static web page. The results may thus be shared with a
110 107 colleague, or as a public blog post, without other users needing to install
111 IPython themselves.
108 IPython themselves. NbViewer is simply NbConvert as a simple heroku webservice.
112 109
113 110 See the :ref:`installation documentation <install_index>` for directions on
114 111 how to install the notebook and its dependencies.
115 112
116 .. _`Ipython Notebook Viewer`: http://nbviewer.ipython.org
113 .. _nbviewer: http://nbviewer.ipython.org
117 114
118 115 .. note::
119 116
@@ -137,8 +134,8 b' You can start running the Notebook web app using the following command::'
137 134 (Here, and in the sequel, the initial ``$`` represents the shell prompt,
138 135 indicating that the command is to be run from the command line in a shell.)
139 136
140 The landing page of the IPython Notebook application, the *dashboard*, shows
141 the notebooks currently available in the *working directory* (the directory
137 The landing page of the IPython Notebook application, the *dashboard*, shows
138 the notebooks currently available in the *notebook directory* (By default, the directory
142 139 from which the notebook was started).
143 140 You can create new notebooks from the dashboard with the ``New Notebook``
144 141 button, or open existing ones by clicking on their name.
@@ -155,7 +152,7 b' The `.ipynb` extension is assumed if no extension is given.'
155 152
156 153 The `File | Open...` menu option will open the dashboard in a new browser tab,
157 154 to allow you to select a current notebook
158 from the working directory or to create a new notebook
155 from the notebook directory or to create a new notebook.
159 156
160 157
161 158
@@ -189,7 +186,7 b' Creating a new notebook document'
189 186
190 187 A new notebook space/document may be created at any time, either from the
191 188 dashboard, or using the `File | New` menu option from within an active
192 notebook. The new notebook is created within the same working directory and
189 notebook. The new notebook is created within the same directory and
193 190 will open in a new browser tab. It will also be reflected as a new entry in
194 191 the notebook list on the dashboard.
195 192
@@ -267,9 +264,9 b' way, using standard LaTeX notation: ``$...$`` for inline mathematics and'
267 264 ``$$...$$`` for displayed mathematics. When the Markdown cell is executed,
268 265 the LaTeX portions are automatically rendered in the HTML output as equations
269 266 with high quality typography. This is made possible by MathJax_, which
270 supports a `large subset`_ of LaTeX functionality
267 supports a `large subset <mathjax_tex>`_ of LaTeX functionality
271 268
272 .. _`large subset`: http://docs.mathjax.org/en/latest/tex.html
269 .. _mathjax_tex: http://docs.mathjax.org/en/latest/tex.html
273 270
274 271 Standard mathematics environments defined by LaTeX and AMS-LaTeX (the
275 272 `amsmath` package) also work, such as
@@ -278,18 +275,20 b' New LaTeX macros may be defined using standard methods,'
278 275 such as ``\newcommand``, by placing them anywhere *between math delimiters* in
279 276 a Markdown cell. These definitions are then available throughout the rest of
280 277 the IPython session. (Note, however, that more care must be taken when using
281 the `nbconvert script`_ to output to LaTeX).
278 nbconvert_ to output to LaTeX).
282 279
283 280 Raw input cells
284 281 ~~~~~~~~~~~~~~~
285 *Raw* input cells provide a place in which you can put additional information
286 which you do not want to evaluated by the Notebook. This can be used, for
287 example, to include extra information that is needed when exporting to a
288 certain format. The output after evaluating a raw cell is just a verbatim copy
289 of the input.
282
283 *Raw* input cells provide a place in which you can write *output* directly.
284 Raw cells are not evaluated by the Notebook, and have no output.
285 When passed through nbconvert, Raw cells arrive in the destination format unmodified,
286 allowing you to type full latex into a raw cell, which will only be rendered
287 by latex after conversion by nbconvert.
290 288
291 289 Heading cells
292 290 ~~~~~~~~~~~~~
291
293 292 You can provide a conceptual structure for your computational document as a
294 293 whole using different levels of headings; there are 6 levels available, from
295 294 level 1 (top level) down to level 6 (paragraph). These can be used later for
@@ -301,6 +300,7 b' rendering of the heading when the cell is executed.'
301 300
302 301 Basic workflow
303 302 --------------
303
304 304 The normal workflow in a notebook is, then, quite similar to a standard
305 305 IPython session, with the difference that you can edit cells in-place multiple
306 306 times until you obtain the desired results, rather than having to
@@ -548,7 +548,7 b' Importing `.py` files'
548 548
549 549
550 550 ``.py`` files will be imported into the IPython Notebook as a notebook with
551 the same basename, but an ``.ipynb`` extension, located in the working
551 the same basename, but an ``.ipynb`` extension, located in the notebook
552 552 directory. The notebook created will have just one cell, which will contain
553 553 all the code in the ``.py`` file. You can later manually partition this into
554 554 individual cells using the ``Edit | Split Cell`` menu option, or the
@@ -559,6 +559,3 b' nbformat>2</nbformat>`` at the start of the file, and then add separators for'
559 559 text and code cells, to get a cleaner import with the file already broken into
560 560 individual cells.
561 561
562
563
564 .. _Markdown: http://daringfireball.net/projects/markdown/basics
General Comments 0
You need to be logged in to leave comments. Login now