Skip to content

Commit

Permalink
Github requires png images to be plaxced in a aspecial "assets" folde…
Browse files Browse the repository at this point in the history
…r. This commit fixes that.
  • Loading branch information
mightymax committed Oct 17, 2023
1 parent 3f7a6dd commit b65760e
Show file tree
Hide file tree
Showing 75 changed files with 67 additions and 68 deletions.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
8 changes: 4 additions & 4 deletions docs/generics/JSON-LD-frames.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,18 +170,18 @@ Another way to create a frame is by using the SPARQL editor in TriplyDB.

You can access the JSON-LD editor by clicking the three dots next to the SPARQL editor, and then selecting "To JSON-LD frame editor".

![SPARQL editor](json-ld-navigator.png)
![SPARQL editor](../assets/json-ld-navigator.png)

Afterwards, the JSON script from above should be added to the JSON-LD Frame editor.

![Ld-Frame box](json-ld-script.png)
![Ld-Frame box](../assets/json-ld-script.png)


Running the script results in the following REST-API result:

![REST-API result](json-ld-result.png)
![REST-API result](../assets/json-ld-result.png)

This can also be accessed by the generated API Link above the SPARQL editor.
Copying and pasting the generated link will direct you to a page where you can view the script:

![](json-ld-in-api.png)
![](../assets/json-ld-in-api.png)
2 changes: 1 addition & 1 deletion docs/triply-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ https://api.triplydb.com/datasets/DBpedia-association/dbpedia/describe.nt?resour
```
in your browser, the `.nt` document describing the 'Mona Lisa' instance will be automatically downloaded. You can then upload this file to a dataset and [visualize it in a graph](/yasgui/#network-triplydb-plugin). Figure 1 illustrates the retrieved graph for the ‘Mona Lisa’ instance.

![Figure 1](MonaLisaGraph.png)
![Figure 1](../assets/MonaLisaGraph.png)

The requested resource will be displayed in the center of the graph, forming an 'ego graph'. It will include all direct properties, as well as some indirect properties that are also pulled in by LD Browser. The labels for all classes and properties will be included for easy human-readable display.

Expand Down
6 changes: 3 additions & 3 deletions docs/triply-db-getting-started/admin-settings-pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ For changing the metadata follow the next steps:

2. On that page navigate to "Site metadata", it looks as follows:

![Metadata settings](metadata-settings.png)
![Metadata settings](../../assets/metadata-settings.png)

3. Here you can set the name, tag line, description and welcome text. The name of your website appears in your browser tab. The welcome text appears on the homepage of your TriplyDB instance. The tagline and description are for metadata purposes (e.g. findability and website previews).

Expand Down Expand Up @@ -158,8 +158,8 @@ The type of account can be observed based on the following icons:

| **Icon** | **Account type** |
| --------------------- | ---------------- |
| ![](organization.png) | organization |
| ![](user.png) | user |
| ![](../../assets/organization.png) | organization |
| ![](../../assets/user.png) | user |

### Create a new user

Expand Down
10 changes: 5 additions & 5 deletions docs/triply-db-getting-started/data-stories/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A TriplyDB data story is a way of communicating information about your linked da

You can create your own data story via the [stories](https://triplydb.com/me/-/stories) tab on TriplyDB. If this is your first time creating a data story, your view will look something like the image below. If you already are a proud owner of a data story, you will find it here. To create a new one, you can click the orange "Create story" button and you’ll see the same form.

![Form for adding a new story](Create-datastory-UI-2.png)
![Form for adding a new story](../../assets/Create-datastory-UI-2.png)

In this form, you can fill in the title and set the access level for a data story. When everything is set, press the "Create story" button.This will take you to a new page where you can customize the data story.

Expand All @@ -23,7 +23,7 @@ As shown in the image below, in the top right corner of the page, there is a men

In the right lower corner you see a button with a notepad. With this button, you can toggle between the edit view, which allows you to edit the story, and the reader view, which is how readers of your story will perceive this page.

![Stories interface](My-first-story-UI.png)
![Stories interface](../../assets/My-first-story-UI.png)

## Adding elements

Expand All @@ -33,18 +33,18 @@ To create your first element press "+ Add new element". This will open a new for

Let’s start by selecting a query for our data story. Maybe you have already created one, but if you haven’t, you can select one of the queries available to you. You can search in the Query search bar and select the one you want, for example "our-first-select-query". Optionally you can select the version of the query and set the caption. When everything is set, press "Create story element". And look, we have added our first element to our story!

![Form for adding a new query](Add-new-story-element-query-UI.png)
![Form for adding a new query](../../assets/Add-new-story-element-query-UI.png)

### Paragraph

Data sometimes needs accompanying text to be completely understandable. TriplyDB not only supports writing plain text, but TriplyDB paragraphs are also markdown compliant. The markdown that you’ll add in the paragraph text box will be rendered as HTML and can be previewed. TriplyDB also supports images, and even code blocks with highlighting for the most common linked data and programming languages.

![Form for adding a new paragraph](Add-new-story-element-UI.png)
![Form for adding a new paragraph](../../assets/Add-new-story-element-UI.png)

## Sharing and embedding

Before you know it, you will have created your first data story. Congratulations! Now it is time to share it with the world, but don’t forget to set the access level to “public”. Then you have two options:
1. You can simply share the URL in TriplyDB.
2. You can embed the Data Story on your own webpage. Scroll all the way to the end of your Data Story and click the “</> Embed” button. This brings up a code snippet that you can copy/paste into your own HTML web page.

![Dialog for embedding a Data Story](data-stories-embed.png)
![Dialog for embedding a Data Story](../../assets/data-stories-embed.png)
8 changes: 4 additions & 4 deletions docs/triply-db-getting-started/exporting-data/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,26 @@ This section explains how a user of TriplyDB can export linked data stored in th

The data stored on TriplyDB is stored in two different containers: datasets and graphs. Each triple contained in a dataset is part of exactly one graph. A graph is always a part of a dataset and a dataset can have multiple graphs. The following screenshot shows the dataset "Pokémon" that contains three graphs: "data" and "vocab". The graph "data" contains 28.588 triples and the graph "vocab" 185 triples. By summing up the amount of triples contained in the two graphs the dataset "Pokémon" contains 28.773 triples in total.

![Export a dataset](export-dataset.png)
![Export a dataset](../../assets/export-dataset.png)

To export the dataset users can click on the downwards facing arrow. In our example, the dataset is automatically downloaded as the file "pokemon.trig" and compressed with .gz. The name of the file is the name of the dataset. The used serialization format is ".trig" because that is the standard format to store triples that are appended to graphs.

It is also possible to export the whole dataset on the graphs interface. Select "Graphs" and "EXPORT ALL GRAPHS".

![Export all graphs](export-all-graphs.png)
![Export all graphs](../../assets/export-all-graphs.png)

## Export Graphs

To export only one graph select "Graphs" and the arrow next to the graph that should be exported.

![Export the graph https://data.netwerkdigitaalrefgoed.nl/hackalod/gvn/pkl01](export-one-graph.png)
![Export the graph https://data.netwerkdigitaalrefgoed.nl/hackalod/gvn/pkl01](../../assets/export-one-graph.png)

In this case the downloaded file "https___triplydb.com_academy_pokemon_graphs_data.trig.gz" is named after the graph and also compressed with "gz".

## Extract

The process of extracting the compressed file is the same for exporting graphs and datasets. The downloaded and compressed file is automatically stored in the "Downloads" folder. Select the file with the ending ".gz" and open it with a double click. This opens an application that looks similar to the following screenshot:

![Extract the compressed file](extract.png)
![Extract the compressed file](../../assets/extract.png)

Select the file that should be extracted. In this case select "pokemon.trig" and click on "Extract". In the following step choose the location where the extracted file should be stored.
18 changes: 9 additions & 9 deletions docs/triply-db-getting-started/publishing-data/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Metadata is entered from the dataset settings page, which is accessed
by clicking on the “Dataset settings” (cog icon) option from the
left-hand sidebar (see screenshot).

![“Dataset settings” page](cog-wheel.png) The dataset homepage looks empty without metadata. Notice the cog wheel icon, which provides access to the “Dataset settings” page.
![“Dataset settings” page](../../assets/cog-wheel.png) The dataset homepage looks empty without metadata. Notice the cog wheel icon, which provides access to the “Dataset settings” page.

The dataset settings page allows the following metadata to be entered:

Expand All @@ -38,27 +38,27 @@ The dataset settings page allows the following metadata to be entered:
- The example resources for the dataset.
- The license of the dataset.

![The dataset settings page](dataset-settings-page.png) The dataset settings page allows various forms of dataset metadata to be added.
![The dataset settings page](../../assets/dataset-settings-page.png) The dataset settings page allows various forms of dataset metadata to be added.

Within the TriplyDB instance your dataset is now more findable for users. Whenever
a user searches on one of the topics of your dataset, or types in a word that is
present in the description of your dataset, the dataset will be shown as a search
result. The metadata will allow TriplyDB to give a better impression of your dataset
when a user visits:

![The dataset home page](dataset-homepage-with-metadata.png) The dataset home page after metadata has been entered.
![The dataset home page](../../assets/dataset-homepage-with-metadata.png) The dataset home page after metadata has been entered.

Search engines and social media applications can recognize the
metadata that is entered for datasets in TriplyDB. The following
screenshot shows the widget created by the Slack chat application upon
entering a link to the dataset. Notice that the chat application
understands metadata properties like title, description, and image.

![A Slack widget](slack-widget.png) Widget created by the Slack chat application upon sharing a link to a dataset in TriplyDB.
![A Slack widget](../../assets/slack-widget.png) Widget created by the Slack chat application upon sharing a link to a dataset in TriplyDB.

## Starting services

By default, datasets in TriplyDB can be queried through [TriplyDB-js](/triplydb-js) as well as through the Linked Data Fragments API.
By default, datasets in TriplyDB can be queried through [TriplyDB-js](../../triplydb-js) as well as through the Linked Data Fragments API.

In order to allow additional query paradigms, specific services can be
started from the “Create service” page. This page is accessed by
Expand All @@ -69,7 +69,7 @@ The below screenshot shows the “Create service” page for a TriplyDB
instance that allows SPARQL, Jena SPARQL, and Elasticsearch services
to be created.

![The “Create service” page](create-service.png) Notice that three different types of services can be created.
![The “Create service” page](../../assets/create-service.png) Notice that three different types of services can be created.

It is possible to create multiple services for one dataset.

Expand All @@ -78,7 +78,7 @@ It is possible to create multiple services for one dataset.
Existing services are displayed on service widgets (see screenshot).
From these widgets, services can be created or deleted.

![An example of a service widget](service-widget.png)
![An example of a service widget](../../assets/service-widget.png)

Datasets can change whenever a graph is added, deleted or renamed. When this
happens, the data in a service is out of sync with the data in the dataset and
Expand All @@ -91,7 +91,7 @@ If you want to be notified or trigger an event when anything changes in your dat

The webhook page can be found under dataset's settings on the right, as shown in the image below.

![Webhooks settings page](webhook.png)
![Webhooks settings page](../../assets/webhook.png)

To create a webhook, you will need to provide the following information:
- `Payload target`: The URL to which the webhook message should be sent.
Expand All @@ -113,4 +113,4 @@ https://gitlab.example.com/api/v4/projects/<project_id>/trigger/pipeline?token=<
```
When your webhook is created and active, you can see every occasion the webhook was called in the webhook trigger history.

![Active webhook trigger history](webhook_trigger_history.png)
![Active webhook trigger history](../../assets/webhook_trigger_history.png)
6 changes: 3 additions & 3 deletions docs/triply-db-getting-started/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ stories.

| **Access level** | **Description** | **Icon** |
| ---------------- | ----------------------------------------------------------------------------------------- | ----------------- |
| Private | The dataset/query/story is only visible to you. | ![](private.png) |
| Internal | The dataset/query/story is only visible to people who are logged in to the same TriplyDB. | ![](internal.png) |
| Public | The dataset/query/story is visible to everybody on the Internet. | ![](public.png) |
| Private | The dataset/query/story is only visible to you. | ![](../../assets/private.png) |
| Internal | The dataset/query/story is only visible to people who are logged in to the same TriplyDB. | ![](../../assets/internal.png) |
| Public | The dataset/query/story is visible to everybody on the Internet. | ![](../../assets/public.png) |

### Access level dependencies

Expand Down
10 changes: 5 additions & 5 deletions docs/triply-db-getting-started/saved-queries/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ _You need to be logged in and have authorization rights on the dataset to use th
1. When working from the [SPARQL IDE](/triply-db-getting-started/viewing-data#sparql-ide)
2. Using the Saved Queries tab in a dataset

Creating a saved query with the SPARQL IDE is done by writing a query/visualization and hitting the save button ![The save query button highlighted](save-query-highlighted.png)
Creating a saved query with the SPARQL IDE is done by writing a query/visualization and hitting the save button ![The save query button highlighted](../../assets/save-query-highlighted.png)

## Creating a new version

Expand All @@ -25,7 +25,7 @@ Updating the saved query can be done by clicking a query in the Saved Queries ta

If you want to delete a saved query, you can do so by clicking the three dots on the top right corner of the query, as shown in the image below, and then clicking `Delete`.

![Deleting a saved query](delete-query.png)
![Deleting a saved query](../../assets/delete-query.png)

## Using a saved query

Expand Down Expand Up @@ -53,8 +53,8 @@ The result of a query can be downloaded via the TriplyDB interface. After saving
You can download results in different data format, depending on which [visualization option](/yasgui/#visualizations) you use.
For example, if you want to download the results in a `.json` format, you can choose the option `Response` and click on the download icon or scroll down and click on `Download result`.

![Download the query result via the download icon.](queryResult.png)
![Download the query result via the button `Download result`.](queryResult2.png)
![Download the query result via the download icon.](../../assets/queryResult.png)
![Download the query result via the button `Download result`.](../../assets/queryResult2.png)

The downloaded file is automatically stored in the `Downloads`-folder and has the name of the query. In our example, the file is called `timeline-cars.json`. The downloaded file contains the query result as a json-object. TriplyDB also displays the json-object when selecting the option `Response`.

Expand Down Expand Up @@ -205,7 +205,7 @@ Every Saved Query has a metadata section. This metadata section includes the fol

Users can specify a query title and description, both of which are included as metadata. The access level and version of the query are also exposed as metadata. See the following screenshot for how the metadata fields are shown in TriplyDB:

![Metadata fields for a Saved Query in TriplyDB](saved-query-metadata.png)
![Metadata fields for a Saved Query in TriplyDB](../../assets/saved-query-metadata.png)

Users can specify additional metadata inside the query string, by using the GRLC annotation format. GRLC annotations start with the hash and plus sign characters (`#+`). Visit the [GRLC project](https://github.com/CLARIAH/grlc) to learn more about this format. For example, the following GRLC annotation could indicate to a software application that the query should be repeated every hour:

Expand Down
6 changes: 3 additions & 3 deletions docs/triply-db-getting-started/uploading-data/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The following steps allow a new linked datasets to be created:
levels](/triply-db-getting-started/reference#access-levels) for more information.


![The “Add dataset” dialog](createdataset.png)
![The “Add dataset” dialog](../../assets/createdataset.png)

When datasets are Public (see [Access Levels](/triply-db-getting-started/reference#access-levels)), they
automatically expose metadata and are automatically crawled and
Expand All @@ -50,7 +50,7 @@ screenshot). In this view data can be added in three ways:
</dl>

![The “Add data” view. The three ways in which data can be added are
displayed on top of one another.](add-data.png)
displayed on top of one another.](../../assets/add-data.png)

The “Add data” view is also available for existing datasets:

Expand Down Expand Up @@ -115,7 +115,7 @@ TriplyDB will show an error message that indicates which part of the
RDF data is malformed (see screenshot). If such malformed data is
encountered, the RDF file must first be corrected and uploaded again.

![Screenshot of an error message indicating syntactically malformed RDF data](upload-error.png)
![Screenshot of an error message indicating syntactically malformed RDF data](../../assets/upload-error.png)

TriplyDB follows the linked data standards strictly. Many triple
stores allow incorrect RDF data to be added. This may seem convenient
Expand Down
Loading

0 comments on commit b65760e

Please sign in to comment.