Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Commit

Permalink
Add usage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
saulshanabrook committed Nov 11, 2019
1 parent 3db5fd7 commit 6312cff
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 9 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ This JupyterLab extension
- exposes linked data to the user as a Linked Data viewer in the Data Browser pane.
- Check out the project vision in the ["Press Release from the Future"](./press_release.md)!

![](./docs/img/screenshot.png)
## Usage

[Usage docs](./docs/usage.md)

## Contributing

Expand Down
Binary file added docs/img/interface.png
Loading
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/img/notebook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Usage

The JupyterLab Metadata extension adds a Linked Data viewer to the [Data Registry][data-registry]. To view metadata about a dataset,
find it in the data explorer and then selected the "Linked Data" view:

![](./img/interface.png)

You can also register Linked Data about entities from a notebook by outputting the `application/ld+json` MIME type:

![](./docs/notebook.png)

Third party extensions can depend on this extension to expose other linked data providers to register other metadata sources for users.

<!-- links -->

[data-registry]: https://github.com/jupyterlab/jupyterlab-data-explorer

<!-- /.links -->
16 changes: 8 additions & 8 deletions notebooks/demo.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@
"cells": [
{
"cell_type": "code",
"execution_count": 10,
"execution_count": 1,
"metadata": {},
"outputs": [],
"source": [
"import IPython.display\n"
"import IPython.display"
]
},
{
"cell_type": "code",
"execution_count": 11,
"execution_count": 2,
"metadata": {},
"outputs": [
{
"data": {
"application/ld+json": {
"@id": "style.css",
"@id": "file:///output.png",
"http://schema.org/name": "Some Name!"
}
},
Expand All @@ -28,21 +28,21 @@
"source": [
"IPython.display.publish_display_data(\n",
" {\"application/ld+json\": {\n",
" \"@id\": \"style.css\",\n",
" \"@id\": \"file:///output.png\",\n",
" \"http://schema.org/name\": \"Some Name!\"\n",
" }}\n",
")"
]
},
{
"cell_type": "code",
"execution_count": 6,
"execution_count": 3,
"metadata": {},
"outputs": [
{
"data": {
"application/x.jupyter.relative-dataset-urls+json": [
"style.css"
"file:///output.png"
]
},
"metadata": {},
Expand All @@ -51,7 +51,7 @@
],
"source": [
"IPython.display.publish_display_data(\n",
" {\"application/x.jupyter.relative-dataset-urls+json\": [\"style.css\"]}\n",
" {\"application/x.jupyter.relative-dataset-urls+json\": [\"file:///output.png\"]}\n",
")"
]
},
Expand Down

0 comments on commit 6312cff

Please sign in to comment.