solid / vocab

Solid Vocabularies
https://solid.github.io/vocab/
42 stars 14 forks source link

Add advisement property and class #91

Closed csarven closed 3 months ago

csarven commented 3 months ago

Add spec:advisement property (to discover advisements) and spec:Advisement class.

Advisements are similar to Requirements.

Advisements are marked in the Solid Protocol: https://solidproject.org/ED/protocol

Live SPARQL Query selecting advisement, advisementLevel, advisement statement of the above:

https://sparql.org/sparql?query=PREFIX+spec%3A+%3Chttp%3A%2F%2Fwww.w3.org%2Fns%2Fspec%23%3E%0D%0ASELECT+%3Fadvisement+%3FadvisementLevel+%3FadvisementStatement%0D%0AFROM+%3Chttp%3A%2F%2Frdf.greggkellogg.net%2Fdistiller%3Fcommand%3Dserialize%26format%3Drdfa%26output_format%3Dturtle%26url%3Dhttps%3A%252F%252Fsolidproject.org%252FED%252Fprotocol%26raw%3E%0D%0AWHERE+%7B%0D%0A%3Fs+spec%3Aadvisement+%3Fadvisement+.%0D%0A%3Fadvisement+spec%3AadvisementLevel+%3FadvisementLevel+.%0D%0A%3Fadvisement+spec%3Astatement+%3FadvisementStatement+.%0D%0A%7D&default-graph-uri=&output=xml&stylesheet=%2Fxml-to-html.xsl

Advisements in a table:

image

Advisements part of the visualisation graph of the specification:

image

kjetilk commented 3 months ago

Are advisements only for non-normative statements, or also for normative SHOULDs and MAYs?

csarven commented 3 months ago

Advisements (spec:advisement) are for non-normative statements and the terms for the levels: https://solidproject.org/ED/protocol#advisement-levels are borrowed from https://infra.spec.whatwg.org/#conformance , which are also used non-normatively.

Requirements (spec:requirement) are for normative statements and the terms for the levels: https://solidproject.org/ED/protocol#requirement-levels are from RFCs.


For the time being Spec Terms doesn't express anything about "normative" and "non-normative". The Advisement/RequirementLevel terms do not overlap, so that's also super useful as a way to distinguish statements in technical reports.

csarven commented 3 months ago

@pchampin Can you please update http://www.w3.org/ns/spec with https://raw.githubusercontent.com/solid/vocab/main/spec.ttl

pchampin commented 2 months ago

@csarven done