mirror of
https://github.com/jupyter/notebook.git
synced 2024-12-15 04:00:34 +08:00
Merge pull request #907 from captainsafia/add-interface-desc-talks
Add information about names of UI element to docs
This commit is contained in:
commit
b410df0032
BIN
docs/source/_static/images/jupyter-file-editor.png
Normal file
BIN
docs/source/_static/images/jupyter-file-editor.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 262 KiB |
BIN
docs/source/_static/images/jupyter-notebook-dashboard.png
Normal file
BIN
docs/source/_static/images/jupyter-notebook-dashboard.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 66 KiB |
BIN
docs/source/_static/images/jupyter-notebook-default.png
Normal file
BIN
docs/source/_static/images/jupyter-notebook-default.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 161 KiB |
BIN
docs/source/_static/images/jupyter-notebook-edit.png
Normal file
BIN
docs/source/_static/images/jupyter-notebook-edit.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 218 KiB |
@ -22,6 +22,7 @@ The Jupyter notebook
|
||||
Installation <https://jupyter.readthedocs.org/en/latest/install.html>
|
||||
Running the Notebook <https://jupyter.readthedocs.org/en/latest/running.html>
|
||||
Migrating from IPython <https://jupyter.readthedocs.org/en/latest/migrating.html>
|
||||
ui_components
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
49
docs/source/ui_components.rst
Normal file
49
docs/source/ui_components.rst
Normal file
@ -0,0 +1,49 @@
|
||||
UI Components
|
||||
=============
|
||||
When opening bug reports or sending emails to the Jupyter mailing list, it is
|
||||
useful to know the names of different UI components so that other developers
|
||||
and users have an easier time helping you diagnose your problems. This section
|
||||
will familiarize you with the names of UI elements within the Notebook and the
|
||||
different Notebook modes.
|
||||
|
||||
Notebook Dashboard
|
||||
-------------------
|
||||
|
||||
When you launch ``jupyter notebook`` the first page that you encounter is the
|
||||
Notebook Dashboard.
|
||||
|
||||
.. image:: /_static/images/jupyter-notebook-dashboard.png
|
||||
|
||||
Notebook Editor
|
||||
---------------
|
||||
|
||||
Once you've selected a Notebook to edit, the Notebook will open in the Notebook
|
||||
Editor.
|
||||
|
||||
.. image:: /_static/images/jupyter-notebook-default.png
|
||||
|
||||
Interactive User Interface Tour of the Notebook
|
||||
-----------------------------------------------
|
||||
|
||||
If you would like to learn more about the specific elements within the Notebook
|
||||
Editor, you can go through the User Interface Tour by selecting Help in the
|
||||
menubar then selecting User Interface Tour.
|
||||
|
||||
Edit Mode and Notebook Editor
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
When a cell is in edit mode, the Cell Mode Indicator will change to reflect
|
||||
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.
|
||||
|
||||
.. image:: /_static/images/jupyter-notebook-edit.png
|
||||
|
||||
File Editor
|
||||
-----------
|
||||
|
||||
Now let's say that you've chosen to open a Markdown file instead of a Notebook
|
||||
file whilst in the Notebook Dashboard. If so, the file will be opened in the
|
||||
File Editor.
|
||||
|
||||
.. image:: /_static/images/jupyter-file-editor.png
|
Loading…
Reference in New Issue
Block a user