Skip to content

UCR boilerplate #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 29, 2022
Merged

UCR boilerplate #26

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d028d4e
Update document boilerplate.
gkellogg Jun 22, 2022
49ce69f
Use case for issue #5.
gkellogg Jun 22, 2022
26925cf
Use case for issue #6.
gkellogg Jun 22, 2022
31ffade
Use Markdown for the first use case.
gkellogg Jun 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 51 additions & 20 deletions UCR/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<html>
<html lang="en">
<head>
<meta charset='utf-8'>
<title>YAML-LD Use Cases and Requirements</title>

<script src='https://www.w3.org/Tools/respec/respec-w3c' async class='remove'></script>
<script class='remove'>
var respecConfig = {
specStatus: "unofficial",
specStatus: "CG-DRAFT",
editors: [{
name: "JSON-LD Community"
}],
Expand All @@ -24,9 +24,8 @@
</head>

<body>
<h1>YAML-LD Use Cases and Requirements</h1>
<section id='abstract'>
<p>
<p class="ednote">
This document describes use cases that justify the extension of RDF in the current work in RDF star
community group. It is collaborative work and is a non-normative part of this group output.
</p>
Expand All @@ -42,31 +41,63 @@ <h2>Introduction</h2>
<p>
This document collects together use cases and requirments for YAML-LD.
These use case were provided by members of the
<a href="https://www.w3.org/community/rdf-dev/">W3C RDF Community Group</a>
<a href="https://www.w3.org/community/json-ld/">W3C JSON-LD Community Group</a>
on the <a href="https://lists.w3.org/Archives/Public/public-json-ld/"
>JSON-LD CG mailing list</a>
and <a href="https://github.com/json-ld/yaml-ld/issues?q=is%3Aissue+is%3Aopen+label%3Aucr">issues</a>
of the community's GitHub repository.
</section>

<section>
<h2>Contributing Use Cases and Requirements</h2>
<p>
<a href="https://github.com/json-ld/yaml-ld/issues/new?template=use-case.md">Create a GitHub issue following the dedicated template</a>. The suggested form is:
</p>
<pre>
WHO: As an &lt;actor&gt;
WHAT: I want a &lt;feature&gt;
WHY: So that &lt;benefit&gt;
</pre>
<p>
This is not mandatory.
</p>
<section>
<h2>Contributing Use Cases and Requirements</h2>
<p>
<a href="https://github.com/json-ld/yaml-ld/issues/new?template=use-case.md">Create a GitHub issue following the dedicated template</a>. The suggested form is:
</p>
<pre>
WHO: As an &lt;actor&gt;
WHAT: I want a &lt;feature&gt;
WHY: So that &lt;benefit&gt;
</pre>
<p>
This is not mandatory.
</p>
</section>
</section>

<section>
<h2>Submitted Use Cases</h2>


<section data-format="markdown" id="uc-5">
#### Compatibility with existing libraries

[Submitted Use Case](https://github.com/json-ld/yaml-ld/issues/5)

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.

<p class="note">
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.
</p>
</section>

<section id="uc-6">
<h4>Distinguish "plain" YAML-LD from "ideomatic" YAML-LD</h4>
<p><a href="https://github.com/json-ld/yaml-ld/issues/6">Submitted Use Case</a></p>
<p>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.</p>
<pre class="example">
!yaml-ld
$context: http://schema.org/
$type: Person
name: Pierre-Antoine Champin
</pre>
<div class="note">
<p>The previous example uses two such mechanisms:</p>
<ul>
<li>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).</li>
<li>The hypothetical `!yaml-ld` processing instruction</li>
</ul>
</div>
</section>
</section>
</body>
</html>