Skip to content
Snippets Groups Projects
Unverified Commit 50053977 authored by Kaiyiccc's avatar Kaiyiccc Committed by GitHub
Browse files

DOC: Update cell tag metadata image (#1602)

parent 8f3174a2
No related branches found
No related tags found
No related merge requests found
...@@ -22,16 +22,20 @@ There are two straightforward ways to add metadata to cells: ...@@ -22,16 +22,20 @@ There are two straightforward ways to add metadata to cells:
To enable the cell tag editor, click `View -> Cell Toolbar -> Tags`. This To enable the cell tag editor, click `View -> Cell Toolbar -> Tags`. This
will enable the tags UI. Here's what the menu looks like. will enable the tags UI. Here's what the menu looks like.
![tags_notebook](../images/tags_notebook.png) ```{figure} ../images/tags_notebook.png
The Jupyter Notebook interface for adding tags to a cell.
```
2. **Use the JupyterLab Cell Tags plugin**. JupyterLab is an IDE-like Jupyter 2. **Use the JupyterLab Cell Tags plugin**. JupyterLab is an IDE-like Jupyter
environment that runs in your browser. It has a "cell tags" plugin built-in, environment that runs in your browser. It has a "cell tags" plugin built-in,
which exposes a user interface that lets you quickly insert cell tags. which exposes a user interface that lets you quickly insert cell tags.
You'll find tags under the "wrench" menu section. Edit tags under the "Property Inspector" menu with the gears icon ({fa}`cog`) at the top-right corner.
Here's what the tags UI in JupyterLab looks like. Here's what the tags UI in JupyterLab looks like.
![tags_jupyterlab](../images/tags_jupyterlab.png) ```{figure} ../images/tags_jupyterlab.jpg
The Jupyter Lab interface for adding tags to a cell.
```
Tags are actually just a special section of cell level metadata. Tags are actually just a special section of cell level metadata.
There are three levels of metadata: There are three levels of metadata:
...@@ -40,7 +44,9 @@ There are three levels of metadata: ...@@ -40,7 +44,9 @@ There are three levels of metadata:
* For cell level: in the Jupyter Notebook Toolbar go to `View -> Cell Toolbar -> Edit Metadata` and a button will appear above each cell. * For cell level: in the Jupyter Notebook Toolbar go to `View -> Cell Toolbar -> Edit Metadata` and a button will appear above each cell.
* For output level: using e.g. `IPython.display.display(obj,metadata={"tags": [])`, you can set metadata specific to a certain output (but Jupyter Book does not utilize this just yet). * For output level: using e.g. `IPython.display.display(obj,metadata={"tags": [])`, you can set metadata specific to a certain output (but Jupyter Book does not utilize this just yet).
![NB Metadata GIF](../images/metadata_edit.*) ```{figure} ../images/metadata_edit.*
Toggling the cell metadata UI in the Jupyter Notebook Interface.
```
### Add tags using MyST Markdown notebooks ### Add tags using MyST Markdown notebooks
......
docs/images/tags_jupyterlab.jpg

18.9 KiB

docs/images/tags_jupyterlab.png

14.5 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment