|
|
@@ -7,6 +7,11 @@ Graph Exploring Tool
|
|
|
|
|
|
Virtual Knowledge Graph exploration tool built for use with a graph based on the FTG+PM concept.
|
|
|
|
|
|
+Why?
|
|
|
+----
|
|
|
+
|
|
|
+TODO Explain what problem is solved.
|
|
|
+
|
|
|
|
|
|
Installation
|
|
|
------------
|
|
|
@@ -84,7 +89,36 @@ At this point you can execute the query by clicking the Query button.
|
|
|
The list of corresponding individuals will now be visible in the Results panel.
|
|
|
You can now use these results to further query the graph.
|
|
|
|
|
|
-Why?
|
|
|
-----
|
|
|
|
|
|
-TODO Explain what problem is solved.
|
|
|
+Advanced usage
|
|
|
+--------------
|
|
|
+
|
|
|
+Modifying settings
|
|
|
+~~~~~~~~~~~~~~~~~~
|
|
|
+
|
|
|
+All settings are stored in the :bash:`data/configuration.toml` file.
|
|
|
+There isn't much of value for an end user to change.
|
|
|
+The 4 settings available are:
|
|
|
+- The :bash:`endpoint_sparql`: where to send the queries.
|
|
|
+- The :bash:`example_prefix`: the initial prefix shown in the interface.
|
|
|
+- The :bash:`example_query`: the initial query shown in the interface.
|
|
|
+- A list of :bash:`prefixes` which have a :bash:`name` and :bash:`namespace`: these are used for simplifying queries.
|
|
|
+
|
|
|
+Adding templates
|
|
|
+~~~~~~~~~~~~~~~~
|
|
|
+
|
|
|
+You can add more templates by creating a :bash:`.toml` file under :bash:`data/palette/`.
|
|
|
+Each template has required fields.
|
|
|
+- A :bash:`group`: What group this template belongs to in the palette panel.
|
|
|
+- The :bash:`name`: A short identifier for the template.
|
|
|
+- The :bash:`prefix list`: A string containing the full prefix for the query.
|
|
|
+- The :bash:`query template`: The query itself. Placeholder can be defined between double curly brackets.
|
|
|
+- The :bash:`description`: A longer description for the template which will be shown as the tooltip.
|
|
|
+- Whether :bash:`visual_support` is enabled: Deprecated. Always true.
|
|
|
+- A list of :bash:`replacements` each having 3 fields: One needs to be defined for each placeholder in the query.
|
|
|
+ - The :bash:`placeholder`: Which placeholder gets replaced.
|
|
|
+ - The :bash:`suggestion`: The initial value of the replacement.
|
|
|
+ - The :bash:`description`: What should be put in the field.
|
|
|
+
|
|
|
+You need to restart the interface after you create a new file.
|
|
|
+The new template will now be available as a choice in the palette panel.
|
