Accueil > Configuration basée sur SHACL
Configuration basée sur SHACL
Sparnatural peut être configuré en utilisant une spécification SHACL des entités et propriétés à afficher dans l’interface utilisateur.
Profil de configuration SHACL de Sparnatural
La spécification formelle du sous-ensemble de SHACL à utiliser, en combinaison avec quelques propriétés d’autres ontologies, est définie dans le Profil de configuration SHACL de Sparnatural, disponible en tant que documentation HTML, un tableur en ligne, ou un fichier SHACL technique.
Référence du profil de configuration SHACL de Sparnatural
Espaces de noms
Préfixe | Espaces de noms |
---|---|
config-core | http://data.sparna.fr/ontologies/sparnatural-config-core# |
dash | http://datashapes.org/dash# |
ds | http://data.sparna.fr/ontologies/sparnatural-config-datasources# |
sh | http://www.w3.org/ns/shacl# |
volipi | http://data.sparna.fr/ontologies/volipi# |
Référence de configuration des formes de nœud
Nom de la propriété | URI | Valeur attendue | Card. | Description |
---|---|---|---|---|
type | rdf:type |
sh:NodeShape |
1..*
|
Classe. La valeur doit toujours être sh:NodeShape. |
label | rdfs:label |
rdf:langString ou xsd:string |
0..*
|
Le libellé de l'entité à afficher dans Sparnatural. Les libellés sont multilingues et peuvent fournir plusieurs libellés dans différentes langues. Le libellé dans la langue de l'utilisateur actuel est affiché; Si aucun libellé n'est donné, la partie locale de l'URI est utilisée. |
order | sh:order |
xsd:decimal |
0..*
|
L'ordre de cette entité dans la liste déroulante de sélection des entités. |
tooltip 1 | volipi:message |
rdf:langString ou xsd:string |
0..*
|
Le tooltip préféré qui sera affiché lorsque cette entité est survolée. Cela peut contenir du balisage HTML. Les tooltips sont également multilingues, vous pouvez fournir un tooltip par langue, et le tooltip dans la langue de l'utilisateur actuel est utilisé. |
tooltip 2 | sh:description |
rdf:langString ou xsd:string |
0..*
|
Un tooltip qui sera affiché lorsque cette entité est survolée, si aucun tooltip préféré n'est fourni. Cela peut contenir du balisage HTML. |
code icône fontawesome | volipi:iconName |
xsd:string |
0..1
|
Le code d'icône fontawesome qui sera affiché par Sparnatural, par exemple "fa-solid fa-user" |
URL de l'icône | volipi:icon |
IRI |
0..1
|
Une référence à une URL d'icône qui sera affichée sur Sparnatural. L'utilisation de ceci est déconseillée, préférez volipi:iconName |
classe cible | sh:targetClass |
Classe cible |
0..*
|
L'URI réelle de la classe à laquelle cette forme correspond, qui sera insérée dans les requêtes SPARQL. Les NodeShapes peuvent avoir sh:targetClass ou être rdf:type rdfs:Class, auquel cas l'URI du NodeShape est supposée être l'URI de la classe elle-même. |
type de nœud | sh:nodeKind |
IRI |
0..1
|
Si utilisé sur un NodeShape avec la valeur sh:Literal, alors Sparnatural traitera cette forme comme un littéral et ne générera pas un triple rdf:type dans la requête SPARQL. |
datatype | sh:datatype |
IRI |
0..1
|
Si utilisé sur un NodeShape, alors Sparnatural traitera cette forme comme un littéral et ne générera pas un triple rdf:type dans la requête SPARQL. |
langue dans | sh:languageIn |
BlankNode |
0..1
|
Si utilisé sur un NodeShape, alors Sparnatural traitera cette forme comme un littéral et ne générera pas un triple rdf:type dans la requête SPARQL. |
langue unique | sh:uniqueLang |
xsd:boolean |
0..1
|
Si utilisé sur un NodeShape, alors Sparnatural traitera cette forme comme un littéral et ne générera pas un triple rdf:type dans la requête SPARQL. |
désactivé | sh:deactivated |
xsd:boolean |
0..1
|
Si marqué avec sh:deactivated, une forme sera filtrée de la liste initiale des classes |
ou | sh:or |
BlankNode |
0..*
|
|
sous-classe de | rdfs:subClassOf |
Classe cible |
0..*
|
Si le NodeShape est également une classe, il peut avoir une référence subClassOf à la(les) classe(s) à partir de laquelle il héritera des propriétés |
Référence de configuration des PropertyShapes
Nom de la propriété | URI | Valeur attendue | Card. | Description |
---|---|---|---|---|
entité / forme | ^sh:property |
Entité Sparnatural |
1..*
|
L'entité de la configuration à laquelle la propriété est attachée. Notez que cela est exprimé comme une propriété inverse sur les PropertyShapes, pour faciliter l'utilisation lors de la définition des configurations SHACL dans les tableaux Excel. |
propriété | sh:path |
BlankNodeOrIRI |
1..1
|
L'IRI de la propriété, ou le chemin de propriété SHACL que cette forme de propriété contraint. |
ordre | sh:order |
xsd:decimal |
0..1
|
L'ordre de cette propriété dans la sélection de propriétés déroulante. |
nom | sh:name |
rdf:langString ou xsd:string |
0..*
|
Le nom de la propriété à afficher. Les libellés sont multilingues et peuvent fournir plusieurs libellés dans différentes langues. Le libellé dans la langue de l'utilisateur actuel est affiché ; Si aucun libellé n'est donné, la partie locale de l'URI est utilisée. |
info-bulle 1 | volipi:message |
rdf:langString ou xsd:string |
0..*
|
L'info-bulle préférée qui sera affichée lorsque cette entité est survolée. Cela peut contenir du balisage HTML. Les info-bulles sont également multilingues, vous pouvez fournir une info-bulle par langue, et l' info-bulle dans la langue de l'utilisateur actuel est utilisée. |
info-bulle 2 | sh:description |
rdf:langString ou xsd:string |
0..*
|
Une info-bulle qui sera affichée lorsque cette entité est survolée, si aucune info-bulle préférée n'est fournie. Cela peut contenir du balisage HTML. |
info-bulle 3 | sh:path/skos:definition |
rdf:langString ou xsd:string |
0..*
|
La définition de la propriété, qui peut être utilisée comme info-bulle, si aucune info-bulle n'est fournie sur la forme |
info-bulle 4 | sh:path/rdfs:comment |
rdf:langString ou xsd:string |
0..*
|
Un commentaire sur la propriété, qui peut être utilisé comme info-bulle, si aucune info-bulle n'est fournie sur la forme, et s'il n'y a pas de définition sur la propriété |
widget de recherche | dash:searchWidget |
IRI (config-core:SearchProperty, config-core:ListProperty, config-core:AutocompleteProperty, config-core:BooleanProperty, config-core:MapProperty, config-core:StringEqualsProperty, config-core:TimeProperty-Date, config-core:TimeProperty-Year, config-core:TimeProperty-Period, config-core:TreeProperty, config-core:NumberProperty) |
0..1
|
Un widget de recherche explicite à utiliser pour cette propriété. Si aucun widget de recherche explicite n'est spécifié, un widget par défaut est déterminé en fonction du sh:datatype et d'autres caractéristiques de la forme de propriété. |
rôle de la propriété (propriété d'étiquette par défaut) | dash:propertyRole |
dash:LabelRole |
0..1
|
Si utilisé avec la valeur dash:LabelRole, indique que cette forme de propriété décrit l'étiquette principale des entités auxquelles elle est attachée. Cela est utilisé pour récupérer automatiquement cette propriété dans les requêtes SPARQL générées, et pour peupler automatiquement les listes déroulantes et la recherche d'autocomplétion avec cette propriété. |
classe (de la valeur de la propriété) | sh:class |
IRI |
0..1
|
Définit l'entité dans la configuration qui est la valeur de cette propriété. Référence l'URI d'une classe qui est elle-même référencée par un sh:targetClass d'un NodeShape. |
forme de nœud (de la valeur de la propriété) | sh:node |
IRI |
0..1
|
Définit l'entité dans la configuration qui est la valeur de cette propriété. Référence une NodeShape qui décrit l'entité cible de la propriété. Si aucun sh:class ou sh:node n'est trouvé, alors un comportement par défaut est proposé |
désactivé | sh:deactivated |
xsd:boolean |
0..1
|
Dans le cas où une forme de propriété est marquée comme désactivée, elle ne sera pas affichée dans l'interface |
source de données (pour les listes et l'autocomplétion) | config-datasources:datasource |
BlankNodeOrIRI |
0..1
|
La source de données pour peupler le widget de la propriété. Si non fournie, une source de données par défaut est utilisée. |
sh:in | sh:in |
BlankNode |
0..1
|
Si sh:in est utilisé sur la forme de propriété, son widget par défaut sera une liste déroulante et le contenu de la liste sera lu à partir de la configuration au lieu d'être lu à partir d'une requête SPARQL |
source de données (pour les enfants d'arbre) | config-datasources:treeChildrenDatasource |
BlankNodeOrIRI |
0..1
|
La source de données pour peupler les nœuds enfants d'un nœud dans un widget d'arbre |
source de données (pour les racines d'arbre) | config-datasources:treeRootsDatasource |
BlankNodeOrIRI |
0..1
|
La source de données pour peupler les nœuds racines d'un widget d'arbre |
ou | sh:or |
BlankNodeOrIRI |
0..1
|
Indique des alternatives pour plusieurs types de données (par exemple xsd:string ou xsd:dateTime), ou plusieurs sh:class/sh:node, ou différents types de nœuds (par exemple IRI ou Literal). Les valeurs attendues sont des nœuds avec soit un sh:datatype, soit un sh:class, soit un sh:node, soit un sh:nodeKind. 2 niveaux de sh:or sont pris en charge pour traiter les propriétés qui peuvent être soit des IRI soit des littéraux, et indiquer ensuite les sh:class(es) de la forme IRI, et les sh:datatype(s) de la forme littérale. La valeur de liste réelle de sh:or peut être soit un nœud vide soit un IRI. | ```html Exemple : propriété avec 2 types de données : ([sh:datatype xsd:string][sh:datatype xsd:dateTime]), Exemple : propriété soit IRI soit littéral ([sh:nodeKind sh:IRI; sh:class ex:class1][sh:nodeKind sh:Literal sh:or([sh:datatype xsd:string][sh:datatype xsd:date])])</td>
Référence de configuration des classes
rdfs:subClassOf
est lu sur les classes pour hériter des propriétés des superclasses, ainsi que des libellés et des définitions pour l’affichage UI.
Nom de la propriété | URI | Valeur attendue | Card. | Description |
---|---|---|---|---|
subClassOf | rdfs:subClassOf |
Classe cible |
0..*
|
Indique la superclasse ou les superclasses de cette classe, à partir desquelles cette forme de nœud hérite. Lorsqu'une classe est sélectionnée dans Sparnatural, les propriétés de ses superclasses seront proposées. |
est la cible de | ^sh:targetClass |
Entité Sparnatural |
0..*
|
Une classe cible peut être référencée par une NodeShape via sh:targetClass, ou elle peut être elle-même une sh:NodeShape. Les propriétés de la NodeShape sont héritées par les sous-classes. |
définition | skos:definition |
rdf:langString ou xsd:string |
0..*
|
La définition de la classe, qui peut être utilisée comme info-bulle |
commentaire | rdfs:comment |
rdf:langString ou xsd:string |
0..*
|
Un commentaire sur la classe, qui peut être utilisé comme info-bulle |
étiquette | rdfs:label |
rdf:langString ou xsd:string |
0..*
|
L'étiquette de la classe, à utiliser si aucun rdfs:label n'est trouvé sur la forme de nœud |
```
I’m ready to translate. Please provide the Markdown content for Sparnatural.