From 26925cf88e9b01ac8ce44d1ca2aa432085598498 Mon Sep 17 00:00:00 2001 From: Gregg Kellogg Date: Wed, 22 Jun 2022 16:20:45 -0700 Subject: [PATCH] Use case for issue #6. --- UCR/index.html | 51 ++++++++++++++++++++++++++++++++++---------------- 1 file changed, 35 insertions(+), 16 deletions(-) diff --git a/UCR/index.html b/UCR/index.html index 19fb653..e8b67fc 100644 --- a/UCR/index.html +++ b/UCR/index.html @@ -1,5 +1,5 @@ - + YAML-LD Use Cases and Requirements @@ -47,20 +47,20 @@

Introduction

and issues of the community's GitHub repository. -
-

Contributing Use Cases and Requirements

-

- Create a GitHub issue following the dedicated template. The suggested form is: -

- 
-        WHO:  As an <actor>
-        WHAT: I want a <feature>
-        WHY:  So that <benefit>
-
-

- This is not mandatory. -

-
+
+

Contributing Use Cases and Requirements

+

+ Create a GitHub issue following the dedicated template. The suggested form is: +

+ 
+          WHO:  As an <actor>
+          WHAT: I want a <feature>
+          WHY:  So that <benefit>
+
+

+ This is not mandatory. +

+
@@ -70,12 +70,31 @@

Submitted Use Cases

Compatibility with existing libraries

Submitted Use Case

- As a developer of YAML-LD processors. I want to be able to use off-the-shelf libraries for converting between JSON-LD and YAML-LD serialization formats. So that data produced in JSON-LD can be easily represented in YAML-LD and visa-versa. + As a developer of YAML-LD processors, I want to be able to use off-the-shelf libraries for converting between JSON-LD and YAML-LD serialization formats. So that data produced in JSON-LD can be easily represented in YAML-LD and visa-versa.

There seems to be general compatibility between YAML libraries that produce equivalent results when serializing data originally parsed from JSON. This should be verified, but indicates an easy way of providing a YAML-LD serialization fully round-trippable with JSON-LD.

+ +
+

Distinguish "plain" YAML-LD from "ideomatic" YAML-LD

+

Submitted Use Case

+

As a processor. I want to easily distinguish between "plain" YAML-LD and "ideomatic" YAML-LD based on the use of local tags (or similar) which may require post-parsing processing to be interpreted using the JSON-LD processig algorithms. So that more complicated processing steps can be avoided.

+ 
+          !yaml-ld
+          $context: http://schema.org/
+          $type: Person
+          name: Pierre-Antoine Champin
+
+
+

The previous example uses two such mechanisms:

+
    +
  • The use of `$` instead of `@` to denote JSON-LD keywords. (Note, other than for `@context`, this could be done using a standardized context defining appropriate keyword aliases).
    • +
  • The hypothetical `!yaml-ld` processing instruction
    • +
+
+
\ No newline at end of file