Merge branch 'data-editing-section'

TriplyDB · Nov 14, 2024 · bd7bfda · bd7bfda
2 parents e0e1601 + 1457bc0
commit bd7bfda
Show file tree

Hide file tree

Showing 14 changed files with 133 additions and 7 deletions.
diff --git a/docs/assets/choice-menu-content-status.png b/docs/assets/choice-menu-content-status.png
diff --git a/docs/assets/choice-menu-pattern-search.png b/docs/assets/choice-menu-pattern-search.png
diff --git a/docs/assets/choose-class.png b/docs/assets/choose-class.png
diff --git a/docs/assets/editing-the-data-model.png b/docs/assets/editing-the-data-model.png
diff --git a/docs/assets/groups-and-order.png b/docs/assets/groups-and-order.png
diff --git a/docs/assets/groups-choice-list.png b/docs/assets/groups-choice-list.png
diff --git a/docs/assets/name-IRI.png b/docs/assets/name-IRI.png
diff --git a/docs/assets/open-the-editor.png b/docs/assets/open-the-editor.png
diff --git a/docs/assets/use-of-order.png b/docs/assets/use-of-order.png
diff --git a/docs/triply-db-getting-started/data-stories/index.md b/docs/triply-db-getting-started/data-stories/index.md
@@ -15,10 +15,13 @@ In this form, you can fill in the title and set the access level for a data stor
 ## Editing a data story
 
 As shown in the image below, in the top right corner of the page, there is a menu button. Here you will find the following:
+
 - **Story settings**: Here you can change the title and the access level of your story.
 - **Change banner**: Here you can change the banner, just choose an image that you want as your banner (wide images work best).
-- **Transfer**: To transfer the story to a different user or organization.
 - **Copy**: To copy the story to a different user or organization.
+- **Transfer**: To transfer the story to a different user or organization.
+- **Embed**: HTML to embed the story in a web page using an iFrame.
+- **Print**: Dialog and print options to print the story.
 - **Delete**: To delete the story.
 
 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.

diff --git a/docs/triply-db-getting-started/editing-data/index.md b/docs/triply-db-getting-started/editing-data/index.md
@@ -0,0 +1,95 @@
+[TOC]
+
+# Editing Data
+
+In specific instances of TriplyDB, a SKOS editor is available that enables the editing of SKOS instance data based on a specified Data Model. The Editing Data section provides basic instructions for using the SKOS Editor to create and adapt new data instances. Although the Data Editor is currently limited to SKOS, future editions will enable more types of editing. 
+
+In order to open the Editor, select the Dataset that you want to work with. If your instance provides the feature, you will see `Editor` on the left-hand side.
+
+![Open the editor](../../assets/open-the-editor.png)
+
+## Choosing a Class
+
+When searching for a class, you can type any unique character combination contained in the name into the search box. You don't need to press return in order to see all the class names that contain the pattern anywhere in the class name.
+
+![Example substring pattern filter](../../assets/choose-class.png)
+
+## IRI Naming
+
+When you create a class, you can define the IRI (Internationalized Resource Identifier) naming conventions to uniquely identify the class.
+
+![Create class dialog](../../assets/name-IRI.png)
+
+## Input Fields
+
+Fields can be added by clicking on the plus symbol on the right side of the list of fields. Required fields are marked by an asterisk. In the image, you can see a drop-down choice menu for the *required* value of the `heeft contentstatus` field. When you click on the downward pointing triangle on the right side of the search field, it points upwards and a list unfolds to reveal a set of choices for possible values. If you want free-form entry, you can click on the `x` that is revealed when the mouse is over the arrow. You can remove a field by clicking on the garbage can symbol on the right.
+
+![Content status choice menu](../../assets/choice-menu-content-status.png)
+
+It is also possible to search such menus with pattern search.
+![Content status choice menu](../../assets/choice-menu-pattern-search.png)
+
+## Groups and Order
+
+Once you've selected a Dataset, you can go to the Data Model editor on the left side of the screen.
+
+![Data Model](../../assets/editing-the-data-model.png)
+
+When adding a new property, you are able to specify groups of properties and set the order in which properties should appear.
+
+![Groups and order](../../assets/groups-and-order.png)
+
+The group choice menu can be used or the `+` can be used to add a new property group.
+
+![Groups choice list](../../assets/groups-choice-list.png)
+
+An integer assigned to the property in the `Order` field will be used to order it against the value of `order` in other properties in the SKOS Editor. In the image, you can see the `heeft voorkeurslabel` has Order of 1 and `heeft creatiedatum` has Order of 2, so it will come after the first one in the Property sheets of the editor.
+
+![Use of Order](../../assets/use-of-order.png)
+
+## Workflow
+
+The workflow provides a structured process for data entry and review, enabling seamless transitions between stages.
+
+The workflow consists of the following stages:
+
+```mermaid
+flowchart LR
+  Start(( )) -- Create --> Draft
+  Draft -- Stage --> Staged
+  Draft -- Delete --> Start
+  Draft -- Edit --> Draft
+  Staged -- Accept --> Accepted
+  Staged -- Reject --> Draft
+  Accepted -- Revoke --> Deprecated
+  Accepted -- Edit --> Draft
+  Deprecated -- Edit --> Draft
+```
+
+### Editing (Draft)
+
+The initial phase where data can be created or modified in draft form.
+
+### Submit for Review (Staged)
+
+After drafting, the data can be submitted for review to ensure accuracy and completeness.
+
+### Accept (Accepted)
+
+Once reviewed and approved, the data entry moves to the accepted stage, making it an official part of the dataset. Content status is set to `active`. *Note: the reviewer must be a different person than the one who made the last edit.*
+
+### Revoke (Deprecated)
+
+If data becomes outdated or invalid, it can be moved to the deprecated status, effectively removing it from active use. Content status is set to `inactive`.
+
+## SKOS Support
+
+Support for SKOS (Simple Knowledge Organization System) allows for hierarchical and conceptual data organization.
+
+### SKOS Hierarchy
+
+Define and manage hierarchical relationships between data entries within SKOS.
+
+### SKOS Concept Schemas
+
+This section allows for the creation and use of SKOS concept schemas, aiding in the classification and linking of related data concepts.
diff --git a/docs/triply-db-getting-started/index.md b/docs/triply-db-getting-started/index.md
@@ -2,12 +2,12 @@
 
 # TriplyDB Overview
 
-TriplyDB allows you to store, publish, and use linked data knowledge graphs. TriplyDB makes it easy to upload linked data and expose it through various APIs, including SPARQL, GraphQL, Elasticsearch, Linked Data Fragments, and REST.
+TriplyDB allows you to store, share, and use linked data knowledge graphs. TriplyDB makes it easy to upload linked data and expose it through various APIs, including SPARQL, GraphQL, Elasticsearch, Linked Data Fragments, and REST.
 
 Learn more about the following features:
 
 - [Uploading data](./uploading-data/index.md)
-- [Publishing data](./publishing-data/index.md)
+- [Sharing data](./publishing-data/index.md)
 - [Viewing data](./viewing-data/index.md)
 - [Exporting data](./exporting-data/index.md)
 - [Saved queries](./saved-queries/index.md)

diff --git a/docs/triply-db-getting-started/publishing-data/index.md b/docs/triply-db-getting-started/publishing-data/index.md
@@ -1,12 +1,12 @@
 [TOC]
 
-# Publishing data
+# Sharing data
 
 With TriplyDB you can easily make your data available to the outside world.
 
-## Publishing your dataset
+## Sharing your dataset
 
-You can publish your dataset by setting the visibility to “Public” in
+You can share your dataset by setting the visibility to “Public” in
 the dataset settings menu. Making a dataset public in TriplyDB has
 the following consequences:
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -10,7 +10,8 @@ nav:
       - Getting started:
           - Overview: triply-db-getting-started/index.md
           - Uploading Data: triply-db-getting-started/uploading-data/index.md
-          - Publishing Data: triply-db-getting-started/publishing-data/index.md
+          - Editing (SKOS) Data: triply-db-getting-started/editing-data/index.md
+          - Sharing Data: triply-db-getting-started/publishing-data/index.md
           - Viewing Data: triply-db-getting-started/viewing-data/index.md
           - Exporting Data: triply-db-getting-started/exporting-data/index.md
           - Saved Queries: triply-db-getting-started/saved-queries/index.md