ULB-Darmstadt / shacl-form

HTML5 web component for editing/viewing RDF data that conform to SHACL shapes
https://ulb-darmstadt.github.io/shacl-form/
MIT License
28 stars 5 forks source link

A draft proposal handbook for updating shape-files for shacl-form #26

Open Certiman opened 1 month ago

Certiman commented 1 month ago

As our internal team struggled to understand how to complement and reorder existing shape files in order for them to be useable in shacl-form, and also as mentioned in Issue #1 and Issue #25 , I added an internal handbook for better understanding what order to respect and what sh:-properties to use where.

If this would not be needed due to ongoing work, please ignore this PR of course. I am sure the DETAILS.md file needs a rigorous review on being correct.

s-tittel commented 1 month ago

Thank you for you effort in documenting the form rendering procedure! I wasn't aware, that you struggled with the ordering of the fragments.

Just to be sure: did you see, that shacl-form (hopefully correctly) supports sh:order? I admit, I just briefly mentioned it in the example.

Certiman commented 1 month ago

You're welcome, we need a clear manual for our stakeholders (from business) to understand the design of the forms. sh:order is understood as having an impact, and indeed needs to be added to the DETAILS.md file or anything it may replace.