Explorar o código

Add prefix information to README

Arkadiusz Ryś %!s(int64=2) %!d(string=hai) anos
pai
achega
82c76042f0
Modificáronse 1 ficheiros con 114 adicións e 2 borrados
  1. 114 2
      README.rst

+ 114 - 2
README.rst

@@ -6,12 +6,123 @@ Graph Exploring Tool
    :alt: Screenshot of the user interface
 
 Virtual Knowledge Graph exploration tool built for use with a graph based on the FTG+PM concept.
+We add prefix translation for general concepts and the (SDO2L vocabulary)[https://msdl.uantwerpen.be/git/lucasalbertins/DTDesign/src/joeri/examples/oml/SystemDesignOntology2Layers].
+The translated prefixes can be extended:
+
+.. code-block:: toml
+
+   # Functions and services
+   [[prefixes]]
+   name = "dtf"
+   namespace = "https://ontology.rys.app/dt/function/"
+   # Generic
+   [[prefixes]]
+   name = "owl"
+   namespace = "http://www.w3.org/2002/07/owl#"
+   [[prefixes]]
+   name = "rdf"
+   namespace = "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   [[prefixes]]
+   name = "xsd"
+   namespace = "http://www.w3.org/2001/XMLSchema#"
+   [[prefixes]]
+   name = "rdfs"
+   namespace = "http://www.w3.org/2000/01/rdf-schema#"
+   [[prefixes]]
+   name = "dc"
+   namespace = "http://purl.org/dc/elements/1.1/"
+   [[prefixes]]
+   name = "vim4"
+   namespace = "http://bipm.org/jcgm/vim4#"
+   [[prefixes]]
+   name = "swrl"
+   namespace = "http://www.w3.org/2003/11/swrl#"
+   # Digital Twin Design
+   ## Drivetrain
+   [[prefixes]]
+   name = "dart"
+   namespace = "http://ua.be/drivetrain/description/artifacts/artifacts#"
+   [[prefixes]]
+   name = "dftg"
+   namespace = "http://ua.be/drivetrain/description/ftg#"
+   ## SDO2L
+   [[prefixes]]
+   name = "acyclic"
+   namespace = "http://ua.be/sdo2l/vocabulary/base/acyclic#"
+   [[prefixes]]
+   name = "base"
+   namespace = "http://ua.be/sdo2l/vocabulary/base/base#"
+   [[prefixes]]
+   name = "file"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/file#"
+   [[prefixes]]
+   name = "ftg"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/ftg#"
+   [[prefixes]]
+   name = "traces"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/processtraces#"
+   [[prefixes]]
+   name = "shaclproperty"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/shaclproperty#"
+   [[prefixes]]
+   name = "system"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/system#"
+   [[prefixes]]
+   name = "violation"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/violation#"
+   [[prefixes]]
+   name = "code"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/code#"
+   [[prefixes]]
+   name = "component"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/component#"
+   [[prefixes]]
+   name = "csas"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/cs_as#"
+   [[prefixes]]
+   name = "dict"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/dict#"
+   [[prefixes]]
+   name = "drawio"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/drawio#"
+   [[prefixes]]
+   name = "object_diagram"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/object_diagram#"
+   [[prefixes]]
+   name = "pm"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/pm#"
+   [[prefixes]]
+   name = "requirement"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/requirement#"
+   [[prefixes]]
+   name = "richtext"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/richtext#"
+   [[prefixes]]
+   name = "script"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/script#"
+   [[prefixes]]
+   name = "tabular"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/tabular#"
+   [[prefixes]]
+   name = "text"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/text#"
+   [[prefixes]]
+   name = "traceability_model"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/traceability_model#"
+   [[prefixes]]
+   name = "xopp"
+   namespace = "http://ua.be/sdo2l/vocabulary/formalisms/xopp#"
+   [[prefixes]]
+   name = "federation"
+   namespace = "http://ua.be/sdo2l/vocabulary/federation#"
+
+The :ref:`Modifying settings` section goes into more detail on this file.
 
 Why?
 ----
 
-TODO Explain what problem is solved.
-
+This tool allows a user to explore the knowledge graph using predefined SPARQL queries.
+Therefore, SPARQL knowledge requirements are minimized while still allowing service invoking and data extraction.
 
 Installation
 ------------
@@ -93,6 +204,7 @@ You can now use these results to further query the graph.
 Advanced usage
 --------------
 
+.. _Modifying settings:
 Modifying settings
 ~~~~~~~~~~~~~~~~~~