Skip to content

Commit

Permalink
Backport PR #11499: Update screenshots and text for user interface do…
Browse files Browse the repository at this point in the history
…cs (#11982)

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>
  • Loading branch information
fcollonval and krassowski committed Feb 2, 2022
1 parent 1da760c commit 6d540b0
Show file tree
Hide file tree
Showing 16 changed files with 35 additions and 10 deletions.
Binary file modified docs/source/images/jupyterlab.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/source/user/commands.rst
Expand Up @@ -16,3 +16,5 @@ keyboard-driven way to search for and run JupyterLab commands:

The command palette can be accessed from the View menu or using the keyboard shortcut
``Command/Ctrl Shift C``.

The command palette can be displayed in the sidebar by adding ``'modal': false`` to the Settings.
4 changes: 2 additions & 2 deletions docs/source/user/export.rst
Expand Up @@ -8,7 +8,7 @@ into other file formats such as:

- Asciidoc ``.asciidoc``
- HTML ``.html``
- Latex ``.tex``
- LaTeX ``.tex``
- Markdown ``.md``
- PDF ``.pdf``
- ReStructured Text ``.rst``
Expand All @@ -35,7 +35,7 @@ slides, follow these steps:

1. Open a notebook by double clicking it in the
:ref:`file browser <working-with-files>`.
2. Select Cell tools in the :ref:`left sidebar <left-sidebar>`.
2. Select Property inspector in the :ref:`right sidebar <right-sidebar>`.
3. Select the slide type (Slide, Subslide, Fragment, Skip, Notes).

.. image:: images/exporting_slide_type.png
Expand Down
2 changes: 2 additions & 0 deletions docs/source/user/extensions.rst
Expand Up @@ -171,6 +171,8 @@ See :ref:`documentation on LabConfig directories <labconfig_directories>` for mo
Managing Extensions Using the Extension Manager
-----------------------------------------------

.. _extension_manager:

You can use the Extension Manager in JupyterLab to manage extensions that are
distributed as single JavaScript packages on npm.

Expand Down
Binary file modified docs/source/user/images/exporting_menu.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/user/images/exporting_slide_type.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/user/images/file_create_text_file.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/user/images/file_editor_overview.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/user/images/file_menu_left.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/user/images/file_menu_top.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/user/images/interface_jupyterlab.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/user/images/interface_left.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/user/images/interface_right.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/user/images/interface_tabs.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/user/images/notebook/notebook_ui.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 29 additions & 8 deletions docs/source/user/interface.rst
Expand Up @@ -51,33 +51,54 @@ default menus are:
:ref:`JupyterLab extensions <user_extensions>` can also create new top-level menus in the menu
bar.

.. _sidebars:

Left and Right Sidebar
----------------------

.. _left-sidebar:

Left Sidebar
------------
The left sidebar contains a number of commonly-used tabs including:

The left sidebar contains a number of commonly-used tabs, such as a file
browser, a list of running kernels and terminals, the command palette,
and a list of tabs in the main work area:
- a file browser,
- a list of tabs in the main work and of running kernels and terminals,
- the command palette (in 3.0+ moved to a modal window accessible with a :ref:`keyboard shortcut <access-palette>`),
- the :ref:`table of contents <toc>`,
- the :ref:`extension manager <extension_manager>`.

.. image:: images/interface_left.png
:align: center
:class: jp-screenshot
:alt: A screenshot of the primary JupyterLab sidebar showing a variety of files in the file browser.

.. _right-sidebar:

The right sidebar contains:

- the property inspector (active in notebooks),
- the :ref:`debugger <debugger>`.

.. image:: images/interface_right.png
:align: center
:class: jp-screenshot
:alt: A screenshot of the secondary JupyterLab sidebar showing the property inspector.

The column that allows to switch between tabs is called Activity Bar in JupyterLab.

.. _left-sidebar-toggle:

The left sidebar can be collapsed or expanded by selecting "Show Left Sidebar"
in the View menu or by clicking on the active sidebar tab:
The sidebars can be collapsed or expanded by selecting "Show Left Sidebar"
or "Show Right Sidebar" in the View menu or by clicking on the active sidebar tab:

The location of tabs can be switched between the left and the right sidebar from the :ref:`context menu <context-menus-rightclick>`.

.. raw:: html

<div class="jp-youtube-video">
<iframe src="https://www.youtube-nocookie.com/embed/PlJGecfetek?rel=0&amp;showinfo=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
</div>

JupyterLab extensions can add additional panels to the left sidebar.
JupyterLab extensions can add additional panels to the sidebars.

.. _main-area:

Expand Down

0 comments on commit 6d540b0

Please sign in to comment.