notebook/docs/source/ui_components.rst

51 lines
1.6 KiB
ReStructuredText
Raw Normal View History

2018-04-30 23:21:18 +08:00
User interface components
=========================
2016-01-01 09:18:26 +08:00
When opening bug reports or sending emails to the Jupyter mailing list, it is
2016-01-05 06:15:17 +08:00
useful to know the names of different UI components so that other developers
2016-01-01 09:18:26 +08:00
and users have an easier time helping you diagnose your problems. This section
2016-01-05 06:15:17 +08:00
will familiarize you with the names of UI elements within the Notebook and the
different Notebook modes.
Notebook Dashboard
-------------------
2016-01-01 09:18:26 +08:00
When you launch ``jupyter notebook`` the first page that you encounter is the
Notebook Dashboard.
2016-02-05 05:02:03 +08:00
.. image:: ./_static/images/jupyter-notebook-dashboard.png
2016-01-01 09:18:26 +08:00
2016-01-05 06:15:17 +08:00
Notebook Editor
---------------
2016-01-01 09:18:26 +08:00
Once you've selected a Notebook to edit, the Notebook will open in the Notebook
Editor.
2016-02-05 05:02:03 +08:00
.. image:: ./_static/images/jupyter-notebook-default.png
2016-01-01 09:18:26 +08:00
2016-01-05 06:15:17 +08:00
Interactive User Interface Tour of the Notebook
-----------------------------------------------
2016-01-01 09:18:26 +08:00
If you would like to learn more about the specific elements within the Notebook
2018-02-12 19:37:17 +08:00
Editor, you can go through the user interface tour by selecting *Help* in the
menubar then selecting *User Interface Tour*.
2016-01-01 09:18:26 +08:00
2016-01-05 06:15:17 +08:00
Edit Mode and Notebook Editor
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2016-01-01 09:18:26 +08:00
When a cell is in edit mode, the Cell Mode Indicator will change to reflect
2016-01-05 06:15:17 +08:00
the cell's state. This state is indicated by a small pencil icon on the
top right of the interface. When the cell is in command mode, there is no
icon in that location.
2016-01-01 09:18:26 +08:00
2016-02-05 05:02:03 +08:00
.. image:: ./_static/images/jupyter-notebook-edit.png
2016-01-01 09:18:26 +08:00
2016-01-05 06:15:17 +08:00
File Editor
-----------
2016-01-01 09:18:26 +08:00
Now let's say that you've chosen to open a Markdown file instead of a Notebook
2016-01-05 06:15:17 +08:00
file whilst in the Notebook Dashboard. If so, the file will be opened in the
2016-01-01 09:18:26 +08:00
File Editor.
2016-02-05 05:02:03 +08:00
.. image:: ./_static/images/jupyter-file-editor.png