diff --git a/docs/generics/JSON-LD-frames.md b/docs/generics/JSON-LD-frames.md index 63c8ef0e..d5484448 100644 --- a/docs/generics/JSON-LD-frames.md +++ b/docs/generics/JSON-LD-frames.md @@ -3,6 +3,8 @@ title: "JSON-LD Framing" path: "/docs/jsonld-frames" --- +[TOC] + # Why JSON-LD Framing? SPARQL Construct and SPARQL Describe queries can return results in the JSON-LD format. Here is an example: @@ -182,5 +184,3 @@ 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) - - diff --git a/docs/generics/api-token.md b/docs/generics/api-token.md index ad75205e..0cb6aa53 100644 --- a/docs/generics/api-token.md +++ b/docs/generics/api-token.md @@ -3,6 +3,8 @@ title: "API Token" path: "/docs/api-token" --- +[TOC] + Applications (see [TriplyDB.js](/triplydb-js)) and pipelines (see [TriplyETL](/triply-etl)) often require access rights to interact with TriplyDB instances. Specifically, reading non-public data and writing any (public or non-public) data requires setting an API token. The token ensures that only users that are specifically authorized for certain datasets are able to access and/or modify those datasets. The following steps must be performed in order to create an API token: diff --git a/docs/generics/sparql-pagination.md b/docs/generics/sparql-pagination.md index 919bfc56..1b666fc0 100644 --- a/docs/generics/sparql-pagination.md +++ b/docs/generics/sparql-pagination.md @@ -3,6 +3,8 @@ title: "SPARQL pagination" path: "/docs/pagination" --- +[TOC] + This page explains how to retrieve all results from a SPARQL query using pagination. Often SPARQL queries can return more than 10.000 results, but due to limitations the result set will only consist out of the first 10.000 results. To retrieve more than 10.000 results you can use pagination. TriplyDB supports two methods to retrieve all results from a SPARQL query. Pagination with the saved query API or Pagination with TriplyDB.js. diff --git a/docs/hello-world/index.md b/docs/hello-world/index.md index 1fc0a97b..e99aa1b5 100644 --- a/docs/hello-world/index.md +++ b/docs/hello-world/index.md @@ -4,6 +4,8 @@ path: "/docs/hello" draft: true --- +[TOC] + ![](joshua-earle-234740.jpg) _Photo by [Joshua Earle](https://unsplash.com/@joshuaearle) via [Unsplash](https://unsplash.com/@joshuaearle?photo=-87JyMb9ZfU)_ diff --git a/docs/index.md b/docs/index.md index 80d815c5..0ed33d84 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,5 @@ +[TOC] + # Welcome to the Triply Documentation diff --git a/docs/triply-api/index.md b/docs/triply-api/index.md index acd84dbe..c3c5fb5f 100644 --- a/docs/triply-api/index.md +++ b/docs/triply-api/index.md @@ -3,6 +3,8 @@ title: "Triply API" path: "/docs/triply-api" --- +[TOC] + Each Triply instance has a fully RESTful API. All functionality, from managing the Triply instance to working with your data, is done through the API. This document describes the general setup of the API, contact diff --git a/docs/triply-db-getting-started/admin-settings-pages/index.md b/docs/triply-db-getting-started/admin-settings-pages/index.md index 90d42964..4f0a0c20 100644 --- a/docs/triply-db-getting-started/admin-settings-pages/index.md +++ b/docs/triply-db-getting-started/admin-settings-pages/index.md @@ -1,3 +1,5 @@ +[TOC] + # Admin settings Pages You can use the console to perform administrator tasks. The administrator tasks are performed within the admin settings page. The admin settings pages are accessible by clicking on the user menu in the top-right corner and selecting the “Admin settings” menu item. You must have administrator privileges to access these pages and perform administrator tasks. @@ -324,4 +326,4 @@ TriplyDB supports two types of mapping rules:
Regex
Regular Expression rules trigger when a resource matches a Regular Expression.
- \ No newline at end of file + diff --git a/docs/triply-db-getting-started/data-stories/index.md b/docs/triply-db-getting-started/data-stories/index.md index 265f7c46..7aa98e4f 100644 --- a/docs/triply-db-getting-started/data-stories/index.md +++ b/docs/triply-db-getting-started/data-stories/index.md @@ -1,3 +1,5 @@ +[TOC] + # Data stories A TriplyDB data story is a way of communicating information about your linked data along with explanatory text while also being able to integrate query results. @@ -45,4 +47,4 @@ Before you know it, you will have created your first data story. Congratulations 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) \ No newline at end of file +![Dialog for embedding a Data Story](data-stories-embed.png) diff --git a/docs/triply-db-getting-started/exporting-data/index.md b/docs/triply-db-getting-started/exporting-data/index.md index 685c460d..6e212746 100644 --- a/docs/triply-db-getting-started/exporting-data/index.md +++ b/docs/triply-db-getting-started/exporting-data/index.md @@ -1,3 +1,5 @@ +[TOC] + # Exporting Data This section explains how a user of TriplyDB can export linked data stored in the triple store. @@ -28,4 +30,4 @@ The process of extracting the compressed file is the same for exporting graphs a ![Extract the compressed file](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. \ No newline at end of file +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. diff --git a/docs/triply-db-getting-started/index.md b/docs/triply-db-getting-started/index.md index 5e78b7b3..030cbf2f 100644 --- a/docs/triply-db-getting-started/index.md +++ b/docs/triply-db-getting-started/index.md @@ -3,6 +3,8 @@ title: "TriplyDB" path: "/docs/triply-db-getting-started" --- +[TOC] + # Introduction TriplyDB allows you to store, publish, and use linked data Knowledge diff --git a/docs/triply-db-getting-started/publishing-data/index.md b/docs/triply-db-getting-started/publishing-data/index.md index d8bc9012..7a97e514 100644 --- a/docs/triply-db-getting-started/publishing-data/index.md +++ b/docs/triply-db-getting-started/publishing-data/index.md @@ -1,3 +1,5 @@ +[TOC] + # Publishing data With TriplyDB you can easily make your data available to the outside world. @@ -111,4 +113,4 @@ https://gitlab.example.com/api/v4/projects//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) \ No newline at end of file +![Active webhook trigger history](webhook_trigger_history.png) diff --git a/docs/triply-db-getting-started/reference/index.md b/docs/triply-db-getting-started/reference/index.md index f5e3fe00..6ef37c4c 100644 --- a/docs/triply-db-getting-started/reference/index.md +++ b/docs/triply-db-getting-started/reference/index.md @@ -1,3 +1,5 @@ +[TOC] + # Reference ## Access levels @@ -138,4 +140,4 @@ Haskell (`haskell`), Java (`java`), JavaScript (`javascript`), LaTeX (`latex`), Makefile (`makefile`), Markdown (`markdown`), Objective C (`objectivec`), Pascal (`pascal`), Perl (`perl`), Powershell (`powershell`), Prolog (`prolog`), Regular Expression (`regex`), Ruby -(`ruby`), Scala (`scala`), SQL (`sql`), Yaml (`yaml`). \ No newline at end of file +(`ruby`), Scala (`scala`), SQL (`sql`), Yaml (`yaml`). diff --git a/docs/triply-db-getting-started/saved-queries/index.md b/docs/triply-db-getting-started/saved-queries/index.md index e911768a..376c9b1c 100644 --- a/docs/triply-db-getting-started/saved-queries/index.md +++ b/docs/triply-db-getting-started/saved-queries/index.md @@ -1,3 +1,5 @@ +[TOC] + # Saved Queries A Saved Query is a versioned SPARQL query with its own URL. Using this URL, @@ -211,4 +213,4 @@ Users can specify additional metadata inside the query string, by using the GRLC #+ frequency: hourly ``` -See the [Triply API documentation](/triply-api#queries) for how to retrieve query metadata, including how to retrieve GRLC annotations. \ No newline at end of file +See the [Triply API documentation](/triply-api#queries) for how to retrieve query metadata, including how to retrieve GRLC annotations. diff --git a/docs/triply-db-getting-started/uploading-data/index.md b/docs/triply-db-getting-started/uploading-data/index.md index dbbffe04..e20e93ee 100644 --- a/docs/triply-db-getting-started/uploading-data/index.md +++ b/docs/triply-db-getting-started/uploading-data/index.md @@ -1,3 +1,5 @@ +[TOC] + # Uploading Data This section explains how to create a linked dataset in TriplyDB. @@ -124,4 +126,4 @@ standards-compliant tools start using the data. Not all data can be stored as RDF data. For example images and video files use a binary format. Such files can also be stored in TriplyDB -and can be integrated into the Knowledge Graph. \ No newline at end of file +and can be integrated into the Knowledge Graph. diff --git a/docs/triply-db-getting-started/viewing-data/index.md b/docs/triply-db-getting-started/viewing-data/index.md index a7034e1e..de1aa4a2 100644 --- a/docs/triply-db-getting-started/viewing-data/index.md +++ b/docs/triply-db-getting-started/viewing-data/index.md @@ -1,3 +1,5 @@ +[TOC] + # Viewing Data TriplyDB offers several ways to explore your datasets. diff --git a/docs/triply-etl/assert/index.md b/docs/triply-etl/assert/index.md index 742badbf..71a95c94 100644 --- a/docs/triply-etl/assert/index.md +++ b/docs/triply-etl/assert/index.md @@ -1,3 +1,5 @@ +[TOC] + # Assert The **Assert** step uses data from the Record to add linked data to the Internal Store. diff --git a/docs/triply-etl/assert/json-ld/index.md b/docs/triply-etl/assert/json-ld/index.md index 4cb41911..dd516967 100644 --- a/docs/triply-etl/assert/json-ld/index.md +++ b/docs/triply-etl/assert/json-ld/index.md @@ -1,3 +1,5 @@ +[TOC] + # JSON-LD The JSON-LD standard includes the following algorithms that allow linked data to be added to the internal store: diff --git a/docs/triply-etl/assert/ratt/statement.md b/docs/triply-etl/assert/ratt/statement.md index 4c5654d8..ff2d7263 100644 --- a/docs/triply-etl/assert/ratt/statement.md +++ b/docs/triply-etl/assert/ratt/statement.md @@ -1,3 +1,5 @@ +[TOC] + # RATT Statement Assertions [TOC] diff --git a/docs/triply-etl/assert/ratt/term.md b/docs/triply-etl/assert/ratt/term.md index 1c118079..e34cb67d 100644 --- a/docs/triply-etl/assert/ratt/term.md +++ b/docs/triply-etl/assert/ratt/term.md @@ -1,3 +1,5 @@ +[TOC] + # RATT Term Assertions The following term assertions are available: diff --git a/docs/triply-etl/changelog/index.md b/docs/triply-etl/changelog/index.md index 991dd1d2..6e021826 100644 --- a/docs/triply-etl/changelog/index.md +++ b/docs/triply-etl/changelog/index.md @@ -1,3 +1,5 @@ +[TOC] + # Changelog The current version of TriplyETL is **3.0.0** diff --git a/docs/triply-etl/cli/index.md b/docs/triply-etl/cli/index.md index 1a6960a2..c0984fd0 100644 --- a/docs/triply-etl/cli/index.md +++ b/docs/triply-etl/cli/index.md @@ -1,3 +1,5 @@ +[TOC] + # Command Line Interface (CLI) TriplyETL allows you to manually perform various tasks in a terminal application (a Command-Line Interface or CLI). diff --git a/docs/triply-etl/control/index.md b/docs/triply-etl/control/index.md index ccd5fc25..e95ac928 100644 --- a/docs/triply-etl/control/index.md +++ b/docs/triply-etl/control/index.md @@ -1,3 +1,5 @@ +[TOC] + # Control Structures This page documents how you can use control structures in your ETL configuration. diff --git a/docs/triply-etl/debug/index.md b/docs/triply-etl/debug/index.md index e8800841..94806ba4 100644 --- a/docs/triply-etl/debug/index.md +++ b/docs/triply-etl/debug/index.md @@ -1,3 +1,5 @@ +[TOC] + # Debug TriplyETL includes functions that can be used during debugging. These debug function allow you to inspect in a detailed way how data flows through your pipeline. This allows you to find problems more quickly, and allows you to determine whether data is handled correctly by your TriplyETL configuration. diff --git a/docs/triply-etl/declare/index.md b/docs/triply-etl/declare/index.md index 82c15192..badb8df4 100644 --- a/docs/triply-etl/declare/index.md +++ b/docs/triply-etl/declare/index.md @@ -1,3 +1,5 @@ +[TOC] + # Declare Declarations introduce constants that you can use in the rest of your ETL configuration. diff --git a/docs/triply-etl/enrich/index.md b/docs/triply-etl/enrich/index.md index 0764a81c..b30ae1e6 100644 --- a/docs/triply-etl/enrich/index.md +++ b/docs/triply-etl/enrich/index.md @@ -1,3 +1,5 @@ +[TOC] + # Enrich The **Enrich** step uses linked data that is asserted in the Internal Store to derive new linked data. diff --git a/docs/triply-etl/enrich/shacl/index.md b/docs/triply-etl/enrich/shacl/index.md index 1c1e3035..e7028c5b 100644 --- a/docs/triply-etl/enrich/shacl/index.md +++ b/docs/triply-etl/enrich/shacl/index.md @@ -1,3 +1,5 @@ +[TOC] + # SHACL Rules SHACL Rules allow new data to be asserted based on existing data patterns. This makes them a great approach for data enrichment. Since SHACL Rules can be defined as part of the data model, it is one of the best approaches for creating and maintaining business rules in complex domains. diff --git a/docs/triply-etl/enrich/sparql/index.md b/docs/triply-etl/enrich/sparql/index.md index 3ab5fbfd..472a1a59 100644 --- a/docs/triply-etl/enrich/sparql/index.md +++ b/docs/triply-etl/enrich/sparql/index.md @@ -1,3 +1,5 @@ +[TOC] + # SPARQL Update SPARQL Update is a powerful feature that allows you to modify and enrich linked data in the internal store. With SPARQL Update, you can generate new linked data based on existing linked data, thereby enhancing the content of the store. diff --git a/docs/triply-etl/extract/formats/index.md b/docs/triply-etl/extract/formats/index.md index ab333e9e..e1d497e5 100644 --- a/docs/triply-etl/extract/formats/index.md +++ b/docs/triply-etl/extract/formats/index.md @@ -1,3 +1,5 @@ +[TOC] + # Data Formats ## Overview diff --git a/docs/triply-etl/extract/index.md b/docs/triply-etl/extract/index.md index a7db38db..7df723e4 100644 --- a/docs/triply-etl/extract/index.md +++ b/docs/triply-etl/extract/index.md @@ -1,3 +1,5 @@ +[TOC] + # Extract The **Extract** step is the first step in any TriplyETL pipeline. It extracts data in different formats and from different source types. Examples of data formats are 'Microsoft Excel' and 'JSON'. Examples of source types are 'file' or 'URL'. Source data are represented in a uniform Record. diff --git a/docs/triply-etl/extract/record/index.md b/docs/triply-etl/extract/record/index.md index 8d6a736a..80bb284d 100644 --- a/docs/triply-etl/extract/record/index.md +++ b/docs/triply-etl/extract/record/index.md @@ -1,3 +1,5 @@ +[TOC] + # Record When a TriplyETL is connected to one of more data sources, a stream of **Records** will be generated. Records use a generic representation that is independent of the format used in the data sources. diff --git a/docs/triply-etl/extract/types/index.md b/docs/triply-etl/extract/types/index.md index 38c69aca..ae3e1c78 100644 --- a/docs/triply-etl/extract/types/index.md +++ b/docs/triply-etl/extract/types/index.md @@ -1,3 +1,5 @@ +[TOC] + # Source types ## Overview diff --git a/docs/triply-etl/getting-started/index.md b/docs/triply-etl/getting-started/index.md index 8f3a096f..ab235b67 100644 --- a/docs/triply-etl/getting-started/index.md +++ b/docs/triply-etl/getting-started/index.md @@ -1,3 +1,5 @@ +[TOC] + # Getting Started This page helps you to get started with TriplyETL. You can get started with TriplyETL in any of the following ways: diff --git a/docs/triply-etl/index.md b/docs/triply-etl/index.md index c0cc1c43..01f689cd 100644 --- a/docs/triply-etl/index.md +++ b/docs/triply-etl/index.md @@ -1,3 +1,5 @@ +[TOC] + # TriplyETL Overview TriplyETL allows you to create and maintain production-grade linked data pipelines. diff --git a/docs/triply-etl/maintenance/index.md b/docs/triply-etl/maintenance/index.md index 815b00ae..5c8f2c52 100644 --- a/docs/triply-etl/maintenance/index.md +++ b/docs/triply-etl/maintenance/index.md @@ -1,3 +1,5 @@ +[TOC] + # Maintenance Once a TriplyETL repository is configured, it goes into maintenance mode. TriplyETL contains specific functionality to support maintenance. diff --git a/docs/triply-etl/publish/index.md b/docs/triply-etl/publish/index.md index 1da2475d..26c0d08c 100644 --- a/docs/triply-etl/publish/index.md +++ b/docs/triply-etl/publish/index.md @@ -1,3 +1,5 @@ +[TOC] + # TriplyETL: Publish The **Publish** step makes the linked data that is produced by the TriplyETL pipeline available in a Triple Store for use by others. diff --git a/docs/triply-etl/tmp/automation.md b/docs/triply-etl/tmp/automation.md index 66b7c9c1..54a81a2e 100644 --- a/docs/triply-etl/tmp/automation.md +++ b/docs/triply-etl/tmp/automation.md @@ -3,6 +3,8 @@ title: "TriplyETL: Automation" path: "/docs/triply-etl/automation" --- +[TOC] + TriplyETL runs within a Gitlab CI environment ([Figure 1](#figure-1)).
diff --git a/docs/triply-etl/tmp/ci-cd.md b/docs/triply-etl/tmp/ci-cd.md index bb480866..79816f04 100644 --- a/docs/triply-etl/tmp/ci-cd.md +++ b/docs/triply-etl/tmp/ci-cd.md @@ -1,3 +1,5 @@ +[TOC] + This document explains how to maintain an ETL that runs in the gitlab CI. # How to create a TriplyETL CI pipeline? diff --git a/docs/triply-etl/tmp/context.md b/docs/triply-etl/tmp/context.md index 4c741b81..a3233b53 100644 --- a/docs/triply-etl/tmp/context.md +++ b/docs/triply-etl/tmp/context.md @@ -1,3 +1,5 @@ +[TOC] + ## Configuring the Context The TriplyETL Context is specified when the `Etl` object is instantiated. This often appears towards the start of a pipeline script. The TriplyETL Context allows the following things to be specified: diff --git a/docs/triply-etl/tmp/copy.md b/docs/triply-etl/tmp/copy.md index e4154a1d..4a7afc07 100644 --- a/docs/triply-etl/tmp/copy.md +++ b/docs/triply-etl/tmp/copy.md @@ -1,3 +1,5 @@ +[TOC] + # Copy an existing entry over to a new entry Copying is the act of creating a new thing that is based on a specific existing thing. diff --git a/docs/triply-etl/tmp/faq.md b/docs/triply-etl/tmp/faq.md index c6760ad4..3ec57fab 100644 --- a/docs/triply-etl/tmp/faq.md +++ b/docs/triply-etl/tmp/faq.md @@ -1,3 +1,5 @@ +[TOC] + # FAQ ### Why does my pipeline schedule only run an `install` job? diff --git a/docs/triply-etl/tmp/getting-started.md b/docs/triply-etl/tmp/getting-started.md index 0c2aad98..0fe43eac 100644 --- a/docs/triply-etl/tmp/getting-started.md +++ b/docs/triply-etl/tmp/getting-started.md @@ -1,3 +1,5 @@ +[TOC] + ## Transforming RDF data If you have RDF data that does not need to be transformed, see [copying source data](https://triply.cc/docs/ratt-working-with-ratt#function-direct-copying-of-source-data-to-destination). diff --git a/docs/triply-etl/tmp/main-loop.md b/docs/triply-etl/tmp/main-loop.md index b195632e..388f890d 100644 --- a/docs/triply-etl/tmp/main-loop.md +++ b/docs/triply-etl/tmp/main-loop.md @@ -1,3 +1,5 @@ +[TOC] + # The main loop The following code snippet shows the main TriplyETL loop. Every TriplyETL pipeline consists of such a loop. diff --git a/docs/triply-etl/tmp/source-destination.md b/docs/triply-etl/tmp/source-destination.md index 380b4419..618eceb7 100644 --- a/docs/triply-etl/tmp/source-destination.md +++ b/docs/triply-etl/tmp/source-destination.md @@ -1,3 +1,5 @@ +[TOC] + ##### An easier way to configure graph names and prefixes Instead of setting the graph name and the prefixes for every ETL, you can use functions for their generation: diff --git a/docs/triply-etl/tmp/static-dynamic-statements.md b/docs/triply-etl/tmp/static-dynamic-statements.md index 01a1df5e..7d8b2a71 100644 --- a/docs/triply-etl/tmp/static-dynamic-statements.md +++ b/docs/triply-etl/tmp/static-dynamic-statements.md @@ -1,3 +1,5 @@ +[TOC] + # Create dynamic statements Dynamic statements are statements that are based on some aspect of the source data. diff --git a/docs/triply-etl/tmp/tmp.md b/docs/triply-etl/tmp/tmp.md index 5ba2e0b3..5586babc 100644 --- a/docs/triply-etl/tmp/tmp.md +++ b/docs/triply-etl/tmp/tmp.md @@ -1,3 +1,5 @@ +[TOC] + ## Create statements {#create-statements} After source data is connected and transformed, the RATT Record is ready to be transformed to linked data. Linked data statements are assertions or factual statements that consist of 3 terms (triple) or 4 terms (quadruples). diff --git a/docs/triply-etl/transform/index.md b/docs/triply-etl/transform/index.md index af106e54..099e90e2 100644 --- a/docs/triply-etl/transform/index.md +++ b/docs/triply-etl/transform/index.md @@ -1,3 +1,5 @@ +[TOC] + # Transform The transform step makes changes to the Record: diff --git a/docs/triply-etl/transform/ratt/index.md b/docs/triply-etl/transform/ratt/index.md index 3402da9d..2b58ce8b 100644 --- a/docs/triply-etl/transform/ratt/index.md +++ b/docs/triply-etl/transform/ratt/index.md @@ -1,3 +1,5 @@ +[TOC] + # Transform: RATT RATT transformations are a core set of functions that are commonly used to change the content of TriplyETL Records. @@ -1518,6 +1520,3 @@ This results in the following linked data assertion: ```ttl city:Amsterdam geonames:countryCode "NL" ``` - - - diff --git a/docs/triply-etl/transform/typescript/index.md b/docs/triply-etl/transform/typescript/index.md index 23b59f25..9d9435fa 100644 --- a/docs/triply-etl/transform/typescript/index.md +++ b/docs/triply-etl/transform/typescript/index.md @@ -3,6 +3,8 @@ title: "2. Transform: TypeScript" path: "/docs/triply-etl/transform/typescript" --- +[TOC] + The vast majority of ETLs can be written with the core set of [RATT Transformations](/triply-etl/transform/ratt). But sometimes a custom transformation is necessary that cannot be handled by this core set. For such circumstances, TriplyETL allows a custom TypeScript function to be written. Notice that the use of a custom TypeScript function should be somewhat uncommon. The vast majority of real-world transformations should be supported by the core set of RATT Transformations. diff --git a/docs/triply-etl/validate/graph-comparison/index.md b/docs/triply-etl/validate/graph-comparison/index.md index c2ba38f7..fc93a68e 100644 --- a/docs/triply-etl/validate/graph-comparison/index.md +++ b/docs/triply-etl/validate/graph-comparison/index.md @@ -3,6 +3,8 @@ title: "5. Validate: Graph Comparison" path: "/docs/triply-etl/validate/graph-comparison" --- +[TOC] + Graph comparison is an approach for validating that the data produced by your TriplyETL pipeline is correct. For a limited set of key records, the linked data that is generated by the TriplyETL pipeline is compared to graphs that were created by hand. This comparison must follow certain rules that are laid out in the RDF standards. diff --git a/docs/triply-etl/validate/index.md b/docs/triply-etl/validate/index.md index 795f183b..4846f0ac 100644 --- a/docs/triply-etl/validate/index.md +++ b/docs/triply-etl/validate/index.md @@ -3,6 +3,8 @@ title: "5. TriplyETL: Validate" path: "/docs/triply-etl/validate" --- +[TOC] + The **Validate** step ensures that the linked data a pipeline produces conforms to the requirements specified in the data model. ```mermaid diff --git a/docs/triply-etl/validate/shacl/index.md b/docs/triply-etl/validate/shacl/index.md index 536ab940..5365f6cf 100644 --- a/docs/triply-etl/validate/shacl/index.md +++ b/docs/triply-etl/validate/shacl/index.md @@ -3,6 +3,8 @@ title: "5. Validate: SHACL" path: "/docs/triply-etl/validate/shacl" --- +[TOC] + This page documents how SHACL is used to validate linked data in the internal store of your ETL pipeline. diff --git a/docs/triplydb-js/account/index.md b/docs/triplydb-js/account/index.md index 244757ce..94640676 100644 --- a/docs/triplydb-js/account/index.md +++ b/docs/triplydb-js/account/index.md @@ -1,3 +1,5 @@ +[TOC] + # Account Instances of the `Account` class denote TriplyDB accounts. Accounts can be either organizations ([`Organization`](/triplydb-js/organization#organization)) or users ([`User`](/triplydb-js/user#user)). @@ -829,4 +831,4 @@ The metadata object for accounts can include the following keys:
Email address
The email address of the account.
- \ No newline at end of file + diff --git a/docs/triplydb-js/app/index.md b/docs/triplydb-js/app/index.md index 022c6a89..7c50dc93 100644 --- a/docs/triplydb-js/app/index.md +++ b/docs/triplydb-js/app/index.md @@ -1,3 +1,5 @@ +[TOC] + # App Instances of the `App` class are specific application connections that are set-up with a TriplyDB server. @@ -221,4 +223,4 @@ Succeeds if and only if the currently connected to TriplyDB server has a version ### See also -To inspect the current version of the connected-to TriplyDB server, use [`App.getInfo()`](#appgetinfo). \ No newline at end of file +To inspect the current version of the connected-to TriplyDB server, use [`App.getInfo()`](#appgetinfo). diff --git a/docs/triplydb-js/asset/index.md b/docs/triplydb-js/asset/index.md index f0987fc8..dfd0d493 100644 --- a/docs/triplydb-js/asset/index.md +++ b/docs/triplydb-js/asset/index.md @@ -1,3 +1,5 @@ +[TOC] + # Asset Not all data can be stored as RDF data. For example images and video files use a binary format. Such files can also be stored in TriplyDB as Assets and can be integrated into the Knowledge Graph. Each asset has a specific identifier that can be used in the Knowledge Graph. @@ -181,4 +183,4 @@ const user = await triply.getAccount() const dataset = await user.getDataset('my-dataset') const asset = await dataset.getAsset('my-asset') asset.toStream() -``` \ No newline at end of file +``` diff --git a/docs/triplydb-js/dataset/index.md b/docs/triplydb-js/dataset/index.md index 8cc7d008..841888a8 100644 --- a/docs/triplydb-js/dataset/index.md +++ b/docs/triplydb-js/dataset/index.md @@ -1,3 +1,5 @@ +[TOC] + # Dataset The `Dataset` class represents a TriplyDB dataset. @@ -825,4 +827,4 @@ const account = await triply.getAccount() const dataset = await account.getDataset('my-dataset') await dataset.uploadAsset('my-source-data', 'source.csv.gz') await dataset.uploadAsset('my-documentation', 'documentation.pdf') -``` \ No newline at end of file +``` diff --git a/docs/triplydb-js/faq/index.md b/docs/triplydb-js/faq/index.md index c92fa981..bd5080d5 100644 --- a/docs/triplydb-js/faq/index.md +++ b/docs/triplydb-js/faq/index.md @@ -1,3 +1,5 @@ +[TOC] + # FAQ This section includes answers to frequently asked questions. Please contact [info@triply.cc](mailto:info@triply.cc) if you have a question that does not appear in this list. @@ -165,4 +167,4 @@ TriplyDB.js returns async iterators from the following methods: - [`Dataset.getGraphs()`](/triplydb-js/dataset#datasetgetgraphs) - [`Dataset.getStatements()`](/triplydb-js/dataset#datasetgetstatementssubject-string-predicate-string-object-string-graph-string) - [`Query.results().statements()`](/triplydb-js/query#queryresultsapivariables-object-options-object) for SPARQL `construct` and `describe` queries -- [`Query.results().bindings()`](/triplydb-js/query/#queryresultsapivariables-object-options-object) for SPARQL `select` queries \ No newline at end of file +- [`Query.results().bindings()`](/triplydb-js/query/#queryresultsapivariables-object-options-object) for SPARQL `select` queries diff --git a/docs/triplydb-js/graph/index.md b/docs/triplydb-js/graph/index.md index 4675047f..82056388 100644 --- a/docs/triplydb-js/graph/index.md +++ b/docs/triplydb-js/graph/index.md @@ -1,3 +1,5 @@ +[TOC] + # Graph Each dataset with data consists out of one or more named graphs. All graphs together is thus the collection of triples of the dataset. Often the graph is used to denote a part of the dataset. For example the data model of the dataset or the metadata of the dataset. A graph has as advantage that is can partition data while at the same time keep the data in the same dataset. Reducing the overhead of having to move between datasets to traverse a graph. @@ -195,4 +197,4 @@ const stream = await graph.toStream('compressed', {extension: '.ttl'}) for await(const quad of stream.pipe(zlib.createGunzip())){ console.log((quad as Buffer).toString()) } -``` \ No newline at end of file +``` diff --git a/docs/triplydb-js/index.md b/docs/triplydb-js/index.md index 3dff864f..e6b866fc 100644 --- a/docs/triplydb-js/index.md +++ b/docs/triplydb-js/index.md @@ -3,6 +3,8 @@ title: 'TriplyDB.js' path: '/docs/triplydb-js' --- +[TOC] + **TriplyDB.js** is the official programming library for interacting with [TriplyDB](/triply-db-getting-started). TriplyDB.js allows you to automate operations that would otherwise be performed in the TriplyDB GUI. TriplyDB.js is implemented in [TypeScript](https://www.typescriptlang.org). TypeScript is a type-safe language that transpiles to [JavaScript](https://en.wikipedia.org/wiki/JavaScript). This allows you to use TriplyDB.js in web browsers as well as on servers (using [Node.js](https://nodejs.org)). TriplyDB.js is open source and its source code is published on [GitHub](https://github.com/TriplyDB/TriplyDB-JS). diff --git a/docs/triplydb-js/organization/index.md b/docs/triplydb-js/organization/index.md index efb1c1c0..24de6144 100644 --- a/docs/triplydb-js/organization/index.md +++ b/docs/triplydb-js/organization/index.md @@ -1,3 +1,5 @@ +[TOC] + # Organization Instances of class `Organization` denote organizations in TriplyDB. @@ -204,4 +206,4 @@ Inherited from [`Account.setAvatar(file: string)`](/triplydb-js/account#accounts Updates the metadata for this account. -Inherited from [`Account.update(metadata: object)`](/triplydb-js/account#accountupdatemetadata-object). \ No newline at end of file +Inherited from [`Account.update(metadata: object)`](/triplydb-js/account#accountupdatemetadata-object). diff --git a/docs/triplydb-js/query/index.md b/docs/triplydb-js/query/index.md index 3f2223d1..b0402cd8 100644 --- a/docs/triplydb-js/query/index.md +++ b/docs/triplydb-js/query/index.md @@ -1,3 +1,5 @@ +[TOC] + # Query A Saved Query is a versioned SPARQL query with its own URL. Using this URL, @@ -209,4 +211,4 @@ A saved query is saved with a version number. Each time the query or the visuali const user = await triply.getAccount('my-account') const query = await user.getQuery('my-query') const query_1 = await query.useVersion(1) -``` \ No newline at end of file +``` diff --git a/docs/triplydb-js/service/index.md b/docs/triplydb-js/service/index.md index e4dfeaee..adc56be6 100644 --- a/docs/triplydb-js/service/index.md +++ b/docs/triplydb-js/service/index.md @@ -1,3 +1,5 @@ +[TOC] + # Service Service objects describe specific functionalities that can be created over datasets in TriplyDB. @@ -126,4 +128,4 @@ const service = await dataset.getService('some-service') await service.start() // Function that checks if a service is available await service.waitUntilRunning() -``` \ No newline at end of file +``` diff --git a/docs/triplydb-js/story/index.md b/docs/triplydb-js/story/index.md index 40ca7620..5cda629e 100644 --- a/docs/triplydb-js/story/index.md +++ b/docs/triplydb-js/story/index.md @@ -1,3 +1,5 @@ +[TOC] + # Story A TriplyDB data story is a way of communicating information about your linked data along with explanatory text while also being able to integrate query results. To create Data stories with `TriplyDB.js` You can use the @@ -44,4 +46,4 @@ for (const element of (await story.getInfo()).content) { console.log(element.paragraph) } } -``` \ No newline at end of file +``` diff --git a/docs/triplydb-js/user/index.md b/docs/triplydb-js/user/index.md index 36e61ef8..cdb1e127 100644 --- a/docs/triplydb-js/user/index.md +++ b/docs/triplydb-js/user/index.md @@ -1,3 +1,5 @@ +[TOC] + # User Instances of class `User` denote users in TriplyDB. @@ -215,4 +217,4 @@ Inherited from [`Account.setAvatar(file: string)`](/triplydb-js/account#accounts Updates the metadata for this user. -Inherited from [`Account.update(metadata: object)`](/triplydb-js/account#accountupdatemetadata-object). \ No newline at end of file +Inherited from [`Account.update(metadata: object)`](/triplydb-js/account#accountupdatemetadata-object). diff --git a/docs/yasgui-api/index.md b/docs/yasgui-api/index.md index afb68f4f..e243e44e 100644 --- a/docs/yasgui-api/index.md +++ b/docs/yasgui-api/index.md @@ -3,6 +3,8 @@ title: "Yasgui API Reference" path: "/docs/yasgui-api" --- +[TOC] + Yasgui consists of three components: Yasqe (a SPARQL Query Editor), Yasr (a SPARQL result visualizer), and Yasgui which binds the former together. Here you can find documentation on ways to include, configure and extend these components as suitable to your use-case. diff --git a/docs/yasgui/index.md b/docs/yasgui/index.md index 1a8e9e31..5d83eb82 100644 --- a/docs/yasgui/index.md +++ b/docs/yasgui/index.md @@ -8,6 +8,8 @@ redirect_from: - "/docs/data-stories" --- +[TOC] + This section explains the use of SPARQL via Yasgui. Yasgui provides various advanced features for creating, sharing, and visualizing SPARQL queries and their results.