Skip to content
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.

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

#73 How to read this document #80

Merged
merged 9 commits into from
Aug 29, 2022
68 changes: 68 additions & 0 deletions spec/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,58 @@ <h2>Introduction</h2>
to manipulate extended YAML-LD documents.
</p>

<section class="informative">
<h2>How to read this document</h2>

<p>
To understand the basics of this specification, one must be familiar with the following:
<ul>
<li>[[YAML]] data markup language, which is the underlying syntax for YAML-LD</li>
<li>basic Linked Data [[LINKED-DATA]] principles</li>
</ul>
</p>

<p>This document is intended primarily for the following two main audiences.</p>

<p>
<ul>
<li>
<strong>Software developers</strong> who want to:
anatoly-scherbakov marked this conversation as resolved.
Show resolved Hide resolved
<ul>
<li>encode Linked Data in a variety of programming languages which can use YAML,</li>
<li>convert existing YAML to YAML-LD,</li>
<li>understand the design decisions and language syntax for YAML-LD,</li>
<li>implement processors and APIs for YAML-LD,</li>
<li>generate or consume Linked Data, an RDF Graph, or an RDF Dataset in a YAML syntax.</li>
anatoly-scherbakov marked this conversation as resolved.
Show resolved Hide resolved
</ul>

<p>Among related technologies, JSON-LD familiarity would be required to
build most YAML-LD capable applications, while RDF familiarity is only
required when it is desired to convert YAML-LD to RDF graphs, or vice
versa.
</p>
</li>
<li>
<p>
<strong>IT and non-IT professionals</strong> who want to read and/or produce Linked Data documents
in YAML-LD format. Such documents can be:
anatoly-scherbakov marked this conversation as resolved.
Show resolved Hide resolved

<ul>
<li>consumed by programming systems capable of understanding YAML-LD,</li>
<li>transformed with JSON-LD framing algorithms,</li>
<li>published on the Web for human and machine consumption.</li>
anatoly-scherbakov marked this conversation as resolved.
Show resolved Hide resolved
</ul>
</p>
<p>
For these users, familiarity with JSON-LD is not required, but understanding of Linked Data principles
might be beneficial. The <a href="#primer">YAML-LD Primer</a> is meant as a gentle introduction
to the essential information necessary to use YAML-LD in practice.
</p>
</li>
</ul>
</p>
</section>

<section class="informative">
<h2>Terminology</h2>

Expand Down Expand Up @@ -1952,5 +2004,21 @@ <h2>Best Practices</h2>

<p>The applicability of this context depends on the domain and is left to the architect's best judgement.</p>
</section>

<section id="primer" class="informative">
<h2>YAML-LD Primer</h2>

<section id="primer-introduction">
<h2>Introduction</h2>

<p>
This document is meant as a gentle introduction to YAML-LD for software developers and IT
professionals as well as professionals in domains other than
computer science.
</p>
</section>


</section>
</body>
</html>