Merge pull request #160 from elf-pavlik/partials

extracted parts which bikeshed can reuse across the specs
solid · Mar 2, 2023 · 5a46828 · 5a46828
2 parents 2654140 + 0cd416d
commit 5a46828
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 94 deletions.
diff --git a/biblio.json b/biblio.json
@@ -0,0 +1,37 @@
+{
+    "Solid.Protocol": {
+        "authors": [
+            "Sarven Capadisli",
+            "Tim Berners-Lee",
+            "Ruben Verborgh",
+            "Kjetil Kjernsmo"
+        ],
+        "href": "https://solidproject.org/TR/protocol",
+        "title": "Solid Protocol",
+        "publisher": "W3C Solid Community Group"
+    },
+    "Solid.Notifications.Protocol": {
+        "editors": [
+            "Sarven Capadisli"
+        ],                
+        "authors": [
+            "Aaron Coburn",
+            "Sarven Capadisli",
+            "elf Pavlik",
+            "Rahul Gupta"
+        ],
+        "href": "https://solidproject.org/TR/notifications-protocol",
+        "title": "Solid Notifications Protocol",
+        "publisher": "W3C Solid Community Group"
+    },
+    "Solid.OIDC": {
+        "authors": [
+            "Aaron Coburn",
+            "elf Pavlik",
+            "Dmitri Zagidulin"
+        ],
+        "href": "https://solidproject.org/TR/oidc",
+        "title": "Solid-OIDC",
+        "publisher": "W3C Solid Community Group"
+    }
+}
diff --git a/partials/terminology.bs b/partials/terminology.bs
@@ -0,0 +1,6 @@
+## Terminology ## {#terminology}
+
+**This section is non-normative.**
+
+This specification uses terms from the [[!Solid.Notifications.Protocol]] specification.
+When Solid Notifications Protocol terminology is used it is linked directly to that specification.
diff --git a/streaming-http-channel-2023.bs b/streaming-http-channel-2023.bs
@@ -53,15 +53,9 @@ This specification is for:
 * Resource server developers who wish to enable clients to listen for updates to particular resources.
 * Application developers who wish to implement a client to listen for updates to particular resources.
 
-## Terminology ## {#terminology}
-
-**This section is non-normative.**
-
-This document uses terminology from the Solid Notification Protocol, including "subscription API", "gateway API".
-This document also uses terms from The OAuth 2.0 Authorization Framework specification,
-including "resource server", "authorization server", "access token", and "client",
-as well as terms from the WebSub specification, including "topic".
-
+<pre class=include>
+path: partials/terminology.bs
+</pre>
 
 # StreamingHTTPChannel2023 Type # {#channel-type}
 
@@ -176,43 +170,3 @@ sections on Authentication and Authorization [[!Solid.Protocol]].
 
 It is beyond the scope of this document to describe how a client fetches an access token.
 Solid-OIDC is one example of an authentication mechanism that could be used with Solid Notifications [[!Solid.OIDC]].
-
-<pre class=biblio>
-{
-    "Solid.Protocol": {
-        "authors": [
-            "Sarven Capadisli",
-            "Tim Berners-Lee",
-            "Ruben Verborgh",
-            "Kjetil Kjernsmo"
-        ],
-        "href": "https://solidproject.org/TR/protocol",
-        "title": "Solid Protocol",
-        "publisher": "W3C Solid Community Group"
-    },
-    "Solid.Notifications.Protocol": {
-        "editors": [
-            "Sarven Capadisli"
-        ],                
-        "authors": [
-            "Aaron Coburn",
-            "Sarven Capadisli",
-            "elf Pavlik",
-            "Rahul Gupta"
-        ],
-        "href": "https://solidproject.org/TR/notifications-protocol",
-        "title": "Solid Notifications Protocol",
-        "publisher": "W3C Solid Community Group"
-    },
-    "Solid.OIDC": {
-        "authors": [
-            "Aaron Coburn",
-            "elf Pavlik",
-            "Dmitri Zagidulin"
-        ],
-        "href": "https://solidproject.org/TR/oidc",
-        "title": "Solid-OIDC",
-        "publisher": "W3C Solid Community Group"
-    }
-}
-</pre>
diff --git a/webhook-channel-2023.bs b/webhook-channel-2023.bs
@@ -60,11 +60,9 @@ Issue(155):
 
 Issue(145):
 
-## Terminology ## {#terminology}
-
-**This section is non-normative.**
-
-This specification uses the terms from the [[!Solid.Notifications.Protocol]] specification.
+<pre class=include>
+path: partials/terminology.bs
+</pre>
 
 # WebhookChannel2023 Type # {#channel-type}
 
@@ -155,43 +153,3 @@ sections on Authentication and Authorization [[!Solid.Protocol]].
 
 It is beyond the scope of this document to describe how a client fetches an access token.
 Solid-OIDC is one example of an authentication mechanism that could be used with Solid Notifications [[!Solid.OIDC]].
-
-<pre class=biblio>
-{
-    "Solid.Protocol": {
-        "authors": [
-            "Sarven Capadisli",
-            "Tim Berners-Lee",
-            "Ruben Verborgh",
-            "Kjetil Kjernsmo"
-        ],
-        "href": "https://solidproject.org/TR/protocol",
-        "title": "Solid Protocol",
-        "publisher": "W3C Solid Community Group"
-    },
-    "Solid.Notifications.Protocol": {
-        "editors": [
-            "Sarven Capadisli"
-        ],                
-        "authors": [
-            "Aaron Coburn",
-            "Sarven Capadisli",
-            "elf Pavlik",
-            "Rahul Gupta"
-        ],
-        "href": "https://solid.github.io/notifications/protocol",
-        "title": "Solid Notifications Protocol",
-        "publisher": "W3C Solid Community Group"
-    },
-    "Solid.OIDC": {
-        "authors": [
-            "Aaron Coburn",
-            "elf Pavlik",
-            "Dmitri Zagidulin"
-        ],
-        "href": "https://solid.github.io/solid-oidc",
-        "title": "Solid-OIDC",
-        "publisher": "W3C Solid Community Group"
-    }
-}
-</pre>