From ed330c4008a65e4428bf98d83520fe8a125303ee Mon Sep 17 00:00:00 2001 From: Rene Pietzsch Date: Thu, 20 Apr 2023 23:15:05 +0200 Subject: [PATCH 1/2] closing #60 --- .../dataintegration/plugin-reference/index.md | 7 +++---- docs/explore-and-author/graph-exploration/index.md | 14 +++++++++++--- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/docs/deploy-and-configure/configuration/dataintegration/plugin-reference/index.md b/docs/deploy-and-configure/configuration/dataintegration/plugin-reference/index.md index cf017aa0..2d437ab6 100644 --- a/docs/deploy-and-configure/configuration/dataintegration/plugin-reference/index.md +++ b/docs/deploy-and-configure/configuration/dataintegration/plugin-reference/index.md @@ -254,8 +254,6 @@ The identifier for this plugin is `SparkFunction`. It can be found in the package `com.eccenca.di.spark.operator`. - - #### Evaluate template Evaluates a template on a sequence of entities. Can be used after a transformation or directly after datasets that output a single table, such as CSV or Excel. For each input entity, a output entity is generated that provides a single output attribute, which contains the evaluated template. @@ -275,8 +273,9 @@ It can be found in the package `com.eccenca.di.templating.operators`. The template operator supports the Jinja templating language. Documentation about Jinja can be found in the official [Template Designer Documentation](https://jinja.palletsprojects.com/en/2.11.x/templates/). Currently, the template operator does have the following limitations: -- As Jinja does not support special characters, such as colons, in variable names, RDF properties cannot be accessed. For this reason, the transformation that precedes the template operator needs to make sure that it generates attributes that are valid Jinja variable names. -- Accessing nested paths is not supported. If the preceding transformation contains hierarchical mappings, only the attributes from the root mapping can be accessed. + +- As Jinja does not support special characters, such as colons, in variable names, RDF properties cannot be accessed. For this reason, the transformation that precedes the template operator needs to make sure that it generates attributes that are valid Jinja variable names. +- Accessing nested paths is not supported. If the preceding transformation contains hierarchical mappings, only the attributes from the root mapping can be accessed. #### Unpivot diff --git a/docs/explore-and-author/graph-exploration/index.md b/docs/explore-and-author/graph-exploration/index.md index 3e699ba2..4baedf00 100644 --- a/docs/explore-and-author/graph-exploration/index.md +++ b/docs/explore-and-author/graph-exploration/index.md @@ -15,14 +15,22 @@ To open the Explore module, click **:eccenca-application-explore: Knowledge G The user interface of the Explore module shows the following main areas:
-- the header area, showing selected elements, possible actions (e.g. **:eccenca-item-add-artefact: create** or **:eccenca-item-remove: remove resource**), a **:eccenca-module-search: Go to resource** input field, and a **:eccenca-application-useraccount: user menu** -- the navigation area, showing the [Graphs](#graphs) and the [Navigation](#navigation) structures, (1) -- the main area, providing multiple views, depending on which resource has been selected. +- the header area, showing: + - selected elements, + - possible actions (e.g. **:eccenca-item-add-artefact: create** or **:eccenca-item-remove: remove resource**), + - a **:eccenca-module-search: Go to resource** (2) input field, + - and a **:eccenca-application-useraccount: user menu** +- the navigation area, showing the [Graphs](#graphs) and the [Navigation](#navigation) structures, (1) +- the main area, providing multiple views, depending on which resource has been selected.
1. If necessary, you can toggle the navigation area by using the :eccenca-toggler-moveleft: (hide) and :eccenca-toggler-tree: (show) buttons. +2. _Go to resource_ is not a search field. + It is used with an IRI to open the resource details page directly. + You can try to search for a keyword, which might or might not be doing what you intended. + ## Graphs The Graphs box shows lists of graphs you have access to. From 59baa9e5bb3b2e29cf01c7a9ec2bf1b3952f280e Mon Sep 17 00:00:00 2001 From: Rene Pietzsch Date: Thu, 20 Apr 2023 23:20:03 +0200 Subject: [PATCH 2/2] rephrase --- .../graph-exploration/index.md | 47 +++++++++---------- 1 file changed, 22 insertions(+), 25 deletions(-) diff --git a/docs/explore-and-author/graph-exploration/index.md b/docs/explore-and-author/graph-exploration/index.md index 4baedf00..41524aca 100644 --- a/docs/explore-and-author/graph-exploration/index.md +++ b/docs/explore-and-author/graph-exploration/index.md @@ -27,8 +27,8 @@ The user interface of the Explore module shows the following main areas: 1. If necessary, you can toggle the navigation area by using the :eccenca-toggler-moveleft: (hide) and :eccenca-toggler-tree: (show) buttons. -2. _Go to resource_ is not a search field. - It is used with an IRI to open the resource details page directly. +2. _Go to resource_ is used with an IRI to open the resource details page directly. + It is not a search field. You can try to search for a keyword, which might or might not be doing what you intended. ## Graphs @@ -56,24 +56,23 @@ You can search for a specific graph with **:eccenca-module-search: Search**. To add a new graph to the Graphs list: - -- Click **:eccenca-item-add-artefact: Add new graph**. A dialog appears. -- Select a graph type. (1) -- Provide a name and enter the graph URI (e.g. `https://ns.eccenca.com`). -- Click **Next** and provide metadata (different types, require different metadata to enter). -- Click **Save** to create the new graph. +- Click **:eccenca-item-add-artefact: Add new graph**. A dialog appears. +- Select a graph type. (1) +- Provide a name and enter the graph URI (e.g. `https://ns.eccenca.com`). +- Click **Next** and provide metadata (different types, require different metadata to enter). +- Click **Save** to create the new graph. -1. More concrete, you select a shape here. - This can be configured in the workspace configuration as well. +1. More concrete, you select a shape here. + This can be configured in the workspace configuration as well. ### :eccenca-item-download: Downloading a graph To download a graph from the Graphs list: -- In the **Graphs** list, click **:eccenca-item-download: Download graph** on the graph you want to download. -- A message box appears, stating that downloading can take a long time. -- Click **Download**. +- In the **Graphs** list, click **:eccenca-item-download: Download graph** on the graph you want to download. +- A message box appears, stating that downloading can take a long time. +- Click **Download**. ### :eccenca-item-edit: Managing a graph @@ -82,16 +81,16 @@ Use this function to add or replace data in the a graph. To update or replace data of a graph:
-- In the **Graphs** box, select **:eccenca-item-download: Manage graph** on the graph you want to update or replace. -- A dialog box appears. -- Click **Choose file** to upload a file containing the new or updated data. (1) -- Choose one of the following options: - - **Update**: add uploaded data to Graph. - - **Replace**: clear Graph and add uploaded data. -- Click **Update** to start the upload process. +- In the **Graphs** box, select **:eccenca-item-download: Manage graph** on the graph you want to update or replace. +- A dialog box appears. +- Click **Choose file** to upload a file containing the new or updated data. (1) +- Choose one of the following options: + - **Update**: add uploaded data to Graph. + - **Replace**: clear Graph and add uploaded data. +- Click **Update** to start the upload process.
-1. You can upload one of the following file formats: Turtle, N-Triples, RDF/XML, or JSON-LD. +1. You can upload one of the following file formats: Turtle, N-Triples, RDF/XML, or JSON-LD. To delete a graph, select **:eccenca-item-remove: Remove graph** on the graph you want to remove and confirm deletion process. @@ -161,7 +160,6 @@ The Statistics tab indicates the number of classes, properties, entities and t ![](./statictics.png) - #### Graph !!! note inline end @@ -194,8 +192,7 @@ This tab shows all resources that link back to the selected resource. This tab shows the turtle RDF representation of the raw data representing the resource. You can use this tab to edit the selected resource: -- Enter your changes in turtle. -- Click **UPDATE** to save your changes. +- Enter your changes in turtle. +- Click **UPDATE** to save your changes. Deleting the entire turtle representation deletes the resource. -