Skip to content

Commit

Permalink
edit doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@muddymudskipper
muddymudskipper committed Dec 3, 2024
1 parent 6149745 commit e0c30e3
Show file tree
Hide file tree
Showing 3 changed files with 196 additions and 181 deletions.
58 changes: 39 additions & 19 deletions README-public.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,26 @@ The URI of a graph containing extra ontological information. RDFS and OWL defini

If enabled, OWL inferencing expansion of the data graph is performed before validation. Options are *RDFS*, *OWLRL*, *Both*, *None*. Default value: *None*

### Advanced
### SHACL advanced features

Enable SHACL Advanced Features. Default value: *false*.

### SHACL-JS features

Enable SHACL-JS features. Default value: *false*.

### Remove graph type http://rdfs.org/ns/void#Dataset from data graph

Before validating, remove the triple `<data_graph_uri> a <http://rdfs.org/ns/void#Dataset>` from the in-memory data graph.

### Remove graph type https://vocab.eccenca.com/dsm/ThesaurusProject from data graph

Before validating, remove the triple `<data_graph_uri> a <https://vocab.eccenca.com/dsm/ThesaurusProject>` from the in-memory data graph.

### Remove graph type https://vocab.eccenca.com/shui/ShapeCatalog from data graph

Before validating, remove the triple `<data_graph_uri> a <https://vocab.eccenca.com/shui/ShapeCatalog>` from the in-memory data graph.

### Maximum evaluation depth

The maximum number of SHACL shapes "deep" that the validator can go before reaching an "endpoint" constraint (1-999). Default value: 15
Expand All @@ -89,24 +105,28 @@ The maximum number of SHACL shapes "deep" that the validator can go before reach

In order to set options via the input the following parameter names can be used:

| Option | Name |
|------------------------------------------------|------------------------|
| Data graph URI | data_graph_uri |
| SHACL graph URI | shacl_graph_uri |
| Generate validation graph | generate_graph |
| Validation graph URI | validation_graph_uri |
| Output entities | output_entities |
| Clear validation graph | clear_validation_graph |
| Resolve owl:imports | owl_imports |
| Blank node skolemization | skolemize |
| Add labels | add_labels |
| Add labels from data and SHACL graphs | include_graphs_labels |
| Add shui:conforms flag to focus node resources | add_shui_conforms |
| Meta-SHACL | meta_shacl |
| Ontology graph URI | ontology_graph_uri |
| Inference | inference |
| Advanced | advanced |
| Maximum evaluation depth | max_evaluation_depth |
| Option | Name |
|----------------------------------------------------------------------------------|---------------------------------|
| Data graph URI | data_graph_uri |
| SHACL graph URI | shacl_graph_uri |
| Generate validation graph | generate_graph |
| Validation graph URI | validation_graph_uri |
| Output entities | output_entities |
| Clear validation graph | clear_validation_graph |
| Resolve owl:imports | owl_imports |
| Blank node skolemization | skolemize |
| Add labels | add_labels |
| Add labels from data and SHACL graphs | include_graphs_labels |
| Add shui:conforms flag to focus node resources | add_shui_conforms |
| Meta-SHACL | meta_shacl |
| Ontology graph URI | ontology_graph_uri |
| Inference | inference |
| SHACL advanced features | advanced |
| SHACl-JS features | js |
| Remove graph type http://rdfs.org/ns/void#Dataset from data graph | remove_dataset_graph_type |
| Remove graph type https://vocab.eccenca.com/dsm/ThesaurusProject from data graph | remove_thesaurus_graph_type |
| Remove graph type https://vocab.eccenca.com/shui/ShapeCatalog from data graph | remove_shape_catalog_graph_type |
| Maximum evaluation depth | max_evaluation_depth |



Expand Down
22 changes: 11 additions & 11 deletions cmem_plugin_pyshacl/plugin_pyshacl.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -257,46 +257,46 @@ def langfilter(lbl: Literal) -> bool: # noqa: ARG001
PluginParameter(
param_type=BoolParameterType(),
name="advanced",
label="SHACL Advanced Features",
label="SHACL advanced features",
description="Enable SHACL advanced features.",
default_value=False,
advanced=True,
),
PluginParameter(
param_type=BoolParameterType(),
name="js",
label="SHACL-JS Features",
label="SHACL-JS features",
description="Enable SHACL-JS features.",
default_value=False,
advanced=True,
),
PluginParameter(
param_type=BoolParameterType(),
name="remove_dataset_graph_type",
label="Remove graph type <http://rdfs.org/ns/void#Dataset> from data graph",
description="Before validating, remove the triple <data_graph_uri> a "
"<http://rdfs.org/ns/void#Dataset> from the in-memory data graph.",
label="Remove graph type http://rdfs.org/ns/void#Dataset from data graph",
description="Before validating, remove the triple `<data_graph_uri> a "
"<http://rdfs.org/ns/void#Dataset>` from the in-memory data graph.",
default_value=False,
advanced=True,
),
PluginParameter(
param_type=BoolParameterType(),
name="remove_thesaurus_graph_type",
label="Remove graph type <https://vocab.eccenca.com/dsm/ThesaurusProject> "
label="Remove graph type https://vocab.eccenca.com/dsm/ThesaurusProject "
"from data graph",
description="Before validating, remove the triple <data_graph_uri> a "
"<https://vocab.eccenca.com/dsm/ThesaurusProject> from the in-memory data "
description="Before validating, remove the triple `<data_graph_uri> a "
"<https://vocab.eccenca.com/dsm/ThesaurusProject>` from the in-memory data "
"graph.",
default_value=False,
advanced=True,
),
PluginParameter(
param_type=BoolParameterType(),
name="remove_shape_catalog_graph_type",
label="Remove graph type <https://vocab.eccenca.com/shui/ShapeCatalog> "
label="Remove graph type https://vocab.eccenca.com/shui/ShapeCatalog "
"from data graph",
description="Before validating, remove the triple <data_graph_uri> a "
"<https://vocab.eccenca.com/shui/ShapeCatalog> from the in-memory data "
description="Before validating, remove the triple `<data_graph_uri> a "
"<https://vocab.eccenca.com/shui/ShapeCatalog>` from the in-memory data "
"graph.",
default_value=False,
advanced=True,
Expand Down
Loading

0 comments on commit e0c30e3

Please sign in to comment.