Means to amend documentation

mih commented

2025-02-01 13:32:11 +00:00

(Migrated from hub.datalad.org)

Whenever someone sees the need to adjust the description of class properties, or a class itself, for the purpose of provided context-specific hints for annotation they appear to have to create a derived class. This seems overly complicated.

Use case: For TRR379 Person records, I'd want to say that the URL of a contributor page on the main website is a suitable (and preferred) dlthings:id. There is no other change in semantics, property composition or otherwise. I'd have to subclass, just for being able to leave a usage hint.

It would be beneficial to inform shacl-vue about class(-property) specific "hints". Those should be displayed in a dedicate place/fashion, separate from sh:name or sh:description. It would make sense to me that such hints come from a different document (not the schema), and are shacl-vue instance specific.

Whenever someone sees the need to adjust the description of class properties, or a class itself, for the purpose of provided context-specific hints for annotation they appear to have to create a derived class. This seems overly complicated. Use case: For TRR379 `Person` records, I'd want to say that the URL of a contributor page on the main website is a suitable (and preferred) `dlthings:id`. There is no other change in semantics, property composition or otherwise. I'd have to subclass, just for being able to leave a usage hint. It would be beneficial to inform shacl-vue about class(-property) specific "hints". Those should be displayed in a dedicate place/fashion, separate from `sh:name` or `sh:description`. It would make sense to me that such hints come from a different document (not the schema), and are shacl-vue instance specific.

jsheunis commented

2025-02-01 14:47:34 +00:00

(Migrated from hub.datalad.org)

I agree this would be a useful functionality to have. From a shacl-vue perspective it would fit into the overall design to have this in SHACL format as well. I browsed around a bit and remembered this vocabulary: https://datashapes.org/propertyroles.html#example. I'm wondering whether it's feasible to have a separate linkml document that specifies such roles for a given property, then generate the SHACL from that and feed that into shacl-vue as well, in parallel to any particular schema. One thing that I need to consider in more depth is the fact that a given property could have a different purpose or presentation within a different context; this is exemplified by slot_usage in linkml, and I need to check how this manifests in SHACL (specific sh:PropertyShapes are defined in the context of specific sh:NodeShapes). It wouldn't be useful, like you say, to have to subclass the whole class or multiple classes just to add annotations, or in this case roles.

But yes, even without approaching it in this suggested way, this is a useful and needed feature.

I agree this would be a useful functionality to have. From a `shacl-vue` perspective it would fit into the overall design to have this in SHACL format as well. I browsed around a bit and remembered this vocabulary: https://datashapes.org/propertyroles.html#example. I'm wondering whether it's feasible to have a separate linkml document that specifies such roles for a given property, then generate the SHACL from that and feed that into shacl-vue as well, in parallel to any particular schema. One thing that I need to consider in more depth is the fact that a given property could have a different purpose or presentation within a different context; this is exemplified by `slot_usage` in linkml, and I need to check how this manifests in SHACL (specific `sh:PropertyShape`s are defined in the context of specific `sh:NodeShape`s). It wouldn't be useful, like you say, to have to subclass the whole class or multiple classes just to add annotations, or in this case roles. But yes, even without approaching it in this suggested way, this is a useful and needed feature.

jsheunis commented

2025-02-01 21:00:35 +00:00

(Migrated from hub.datalad.org)

Some further reading brought me to this https://datashapes.org/reification.html, which provides a means to make statements about property shapes. I'll dig some more.

Rows
Columns

Means to amend documentation #9