Skip to content

Commit e4146d2

Browse files
committed
Minor editorial changes before finalizing the text for publication
1 parent 385cf34 commit e4146d2

File tree

1 file changed

+39
-44
lines changed

1 file changed

+39
-44
lines changed

serialization-html-note/index-turtle-not-highlight.html

Lines changed: 39 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
<script class='remove'>
4343
var respecConfig = {
4444
specStatus: "WG-NOTE",
45-
shortName: "html-web-annotations",
45+
shortName: "annotation-html",
4646
errata: "https://www.w3.org/annotation/errata/",
4747
editors: [
4848
{ name: "Timothy W. Cole",
@@ -163,7 +163,7 @@
163163
rawDate: "2016-04-26",
164164
status: "Unofficial Draft"
165165
},
166-
"selector-note": {
166+
"selectors-states": {
167167
"authors": [
168168
"Ivan Herman",
169169
"Robert Sanderson",
@@ -204,7 +204,7 @@
204204
<p>This Note describes and illustrates potential approaches for including annotations
205205
within HTML documents. Examples also are included illustrating the use within an HTML document
206206
of annotation Selectors as fragment identifiers. (The Working Group's Selectors and States Reference
207-
Note [[selector-note]] defines the syntax used for Selectors as fragment identifiers.)</p>
207+
Note [[selectors-states]] defines the syntax used for Selectors as fragment identifiers.)</p>
208208

209209
<p>The approaches described in this document are incomplete and preliminary. They do not exhaust the full range of feasible options.
210210
The approaches discussed in this note have emerged from Working Group discussions and should be considered no more
@@ -241,14 +241,14 @@ <h2>Introduction</h2>
241241
that references a segment of an HTML document might usefully be embedded within the same or another HTML document.
242242
In addition to text embedded within the DOM, HTML documents often reference external resources such as
243243
images that are meant to be considered integral parts of an HTML Document when viewed on the Web,
244-
e.g., through the use of the HTML <code>&lt;img&gt;</code> element's src attribute. Approaches discussed in this Note
244+
e.g., through the use of the HTML <code>&lt;img&gt;</code> element's <code>src</code> attribute. Approaches discussed in this Note
245245
would facilitate embedding in HTML an annotation targeting (in the context or scope of a Web page) an image
246246
or other similar Web page component resource external to an HTML document. </p>
247247

248248
<section>
249249
<h3>Scope</h3>
250250
<p>Pending further experimentation, use-case development, incubation and broader collaborative efforts,
251-
this Note stops short of proposing any new, annotation-specific extensions to HTML 5 [[html]].
251+
this Note stops short of proposing any new, annotation-specific extensions to HTML [[html]].
252252
Nor does it propose any new, annotation-specific HTML elements or attributes. To address specific
253253
use cases, possible extensions of HTML have been discussed within the Web Annotation Working Group
254254
and elsewhere, e.g., an informal proposal for new note, notegroup, and noteref HTML elements to better handle
@@ -304,7 +304,7 @@ <h3>Motivation</h3>
304304

305305
<section>
306306
<h3 id="embed-json-ld">Annotations Embedded as JSON-LD</h3>
307-
<p>JSON-LD [[json-ld]] is the serialization format specified in the Web Annotation Data Model [[annotation-model]].
307+
<p>JSON-LD [[json-ld]] is the serialization format used in the Web Annotation Data Model [[annotation-model]].
308308
HTML can accommodate this serialization format directly via the use of the HTML <code>&lt;script&gt;</code> element with its
309309
<code>type</code> attribute assigned the media type for a Web Annotation:
310310
<code>application/ld+json;profile="http://www.w3.org/ns/anno.jsonld"</code>.
@@ -319,13 +319,13 @@ <h3 id="embed-json-ld">Annotations Embedded as JSON-LD</h3>
319319
<section>
320320
<h3>Annotating an HTML <code>&lt;div&gt;</code></h3>
321321
<p><span style="font-weight:bold">Use case for Example 1:</span> Mara wants to annotate the transcription of the emblem motto
322-
with its Latin translation. The target of the annotation is the
322+
with its Latin translation. The target of the annotation is the
323323
<code>&lt;div&gt;</code> node of the HTML document that has an <code>id</code> attribute
324324
with the value <code>"mottoTranscription"</code>.
325-
Because the target of the annotation is
326-
a node which has an id attribute, a CSS Selector is appropriate.
327-
The body of the annotation is the plain text of the Latin translation. To embed the body in the annotation, a TextualBody is used.
328-
To identify the annotation itself, an IRI [[rfc3987]] is provided as the value of the annotation's id property.
325+
Because the target of the annotation is
326+
a node which has an <code>id</code> attribute, a CSS Selector is appropriate.
327+
The body of the annotation is the plain text of the Latin translation. To embed the body in the annotation, a <code>TextualBody</code> is used.
328+
To identify the annotation itself, an IRI [[rfc3987]] is provided as the value of the annotation's <code>id</code> property.
329329
It is not required that this IRI be dereferenceable.
330330
</p>
331331

@@ -362,21 +362,21 @@ <h4>JSON-LD Example 1</h4>
362362
}
363363
&lt;/script&gt;
364364
</pre>
365-
366-
<p class="note"> While an HTML <code>&lt;script&gt;</code> node may itself have an <code>id</code>
367-
attribute, implementers are discouraged from using an HTML URL with fragment identifier to identify an annotation.
365+
366+
<p class="note"> While an HTML <code>&lt;script&gt;</code> node may itself have an <code>id</code>
367+
attribute, implementers are discouraged from using an HTML URL with fragment identifier to identify an annotation.
368368
An HTML fragment identifier is only intended to indicate and help navigate to a specific DOM node in an HTML document
369-
(see HTML5 Recommendation [[html5]] Section 5.6.9, "Navigating to a fragment identifier").
370-
A fragment identifier does not unambiguously identify the contents of this node as a separate resource.
371-
</p>
369+
(see HTML5 Recommendation [[html5]] Section 5.6.9, "Navigating to a fragment identifier").
370+
A fragment identifier does not unambiguously identify the contents of this node as a separate resource.
371+
</p>
372372
</section>
373373

374374
<section>
375375
<h3>Annotating a Web page image</h3>
376376
<p><span style="font-weight:bold">Use case for Example 2</span>: Tim wants to tag the emblem image linked from the
377377
HTML document with an Iconclass descriptor. (Iconclass [[iconclass]] is a linked open data friendly, multilingual classification
378378
system for cultural content.) The body of this annotation is therefore an External Web Resource. To make clear that the image is
379-
being annotated within the context of the Web page describing the emblem, a SpecificResource with a scope property is used
379+
being annotated within the context of the Web page describing the emblem, a <code>SpecificResource</code> with a <code>scope</code> property is used
380380
to express the target of the annotation.
381381
</p>
382382

@@ -409,12 +409,12 @@ <h4>JSON-LD Example 2</h4>
409409

410410
<section>
411411
<h3>Annotating the <code>&lt;body&gt;</code> of an HTML document</h3>
412-
<p><span style="font-weight:bold">Use case for Example 3</span>: Myung-Ja wants to link
413-
the description of this emblem with another digitized emblem at the University of Illinois.
414-
The other emblem, an external Web resource, is the body of the annotation.
415-
The motivation of the annotation is "linking".
412+
<p><span style="font-weight:bold">Use case for Example 3</span>: Myung-Ja wants to link
413+
the description of this emblem with another digitized emblem at the University of Illinois.
414+
The other emblem, an external Web resource, is the body of the annotation.
415+
The motivation of the annotation is "linking".
416416
The entire <code>&lt;body&gt;</code> node of the HTML document serves as the target of this annotation.
417-
As with Example 1, a CSS Selector is used to express the target.
417+
As with Example 1, a CSS Selector is used to express the target.
418418
</p>
419419
<h4>JSON-LD Example 3</h4>
420420
<pre class="example highlight" title="Annotating the body of a Web page">
@@ -445,11 +445,11 @@ <h4>JSON-LD Example 3</h4>
445445
&lt;/script&gt;
446446
</pre>
447447
<p class="note">While HTML <code>&lt;script&gt;</code> elements
448-
are allowed in both the <code>&lt;head&gt;</code> node and the <code>&lt;body&gt;</code> node, it is suggested to
449-
add embedded annotations to the <code>&lt;head&gt;</code> node when targeting the whole
450-
of the <code>&lt;body&gt;</code> node of an HTML document; this avoids any potential ambiguity
451-
that might arise from an annotation targeting itself.
452-
</p>
448+
are allowed in both the <code>&lt;head&gt;</code> and the <code>&lt;body&gt;</code> elements, it is suggested to
449+
add embedded annotations to the <code>&lt;head&gt;</code> element when targeting the whole
450+
of the <code>&lt;body&gt;</code> element of an HTML document; this avoids any potential ambiguity
451+
that might arise from an annotation targeting itself.
452+
</p>
453453
</section>
454454
</section>
455455

@@ -460,13 +460,13 @@ <h3>Annotations Embedded as RDFa</h3>
460460
Instead point to the application...</p>
461461
<p>TODO: Summarize comparitive advantages of this approach, e.g., markup of the target with attributes, etc. ...</p> -->
462462

463-
<p>Another approach of embedding annotations into HTML is to use RDFa [[rdfa-primer]]. The advantage of using RDFa is that the annotation features are mixed with the core HTML content, meaning that, for example, the text in the HTML source can be also re-used as an annotation textual body. In other words, a single resource may become both human visible as well as machine-readable. On the other hand, RDFa is an RDF serialization syntax: the RDF vocabulary described in [[annotation-vocab]] must thefore be used instead of the JSON-LD encoding used in the [[annotation-model]] document. This requirement may be problematic for some users.</p>
463+
<p>Another approach of embedding annotations into HTML is to use RDFa [[rdfa-primer]]. The advantage of using RDFa is that the annotation terms are mixed with the core HTML content, meaning that, for example, the text in the HTML source can be also re-used as an annotation textual body. In other words, a single resource may become both human visible as well as machine-readable. On the other hand, RDFa is an RDF serialization syntax: the RDF vocabulary described in [[annotation-vocab]] must thefore be used instead of the JSON-LD encoding used in the [[annotation-model]] document. This requirement may be problematic for some users.</p>
464464

465465
<h4>Example</h4>
466466

467-
<p>This example is a significantly simplified version of a more complex application that uses an RDFa encoding of annotations within a framework for decentralised article authoring and annotation (see <a href="https://dokie.li/"> for further details</a>). The example shows one of the advantages of RDFa: the “Communities have various…” text, while readable when the corresponding HTML page is displayed, automatically provides the textual body of the annotation. However, the relative complexity of mixing complex RDFa structures with HTML makes it more suitable for automatic code generation (e.g., through authoring systems) rather than manual editing.</p>
467+
<p>This example is a significantly simplified version of a more complex application that uses an RDFa encoding of annotations within a framework for decentralised article authoring and annotation (see <a href="https://dokie.li/"> for further details</a>). The example shows one of the advantages of RDFa: the “Communities have various…” text, while readable when the corresponding HTML page is displayed, automatically provides the textual body of the annotation. The relative complexity of mixing complex RDFa structures with HTML makes it more suitable for automatic code generation (e.g., through authoring systems) rather than manual editing.</p>
468468

469-
<p class="note">The example below assumes that RDFa parsers use the <a href="https://www.w3.org/2011/rdfa-context/rdfa-1.1">RDFa Core Initial Context</a> to understand the predefined prefixes.</p>
469+
<p class="note">The example below relies on the fact that RDFa parsers use the <a href="https://www.w3.org/2011/rdfa-context/rdfa-1.1">RDFa Core Initial Context</a> to understand the predefined prefixes.</p>
470470

471471
<pre id="dokieli-example" class="example" title="Simplified dokieli example">&lt;article resource="" typeof="oa:Annotation"&gt;
472472
&lt;h1 property="schema:name"&gt;Sarven Capadisli &lt;span property="oa:motivatedBy"
@@ -501,15 +501,12 @@ <h4>Example</h4>
501501
&lt;/section&gt;
502502
&lt;/article&gt;</pre>
503503

504-
<p>This yields, in [[turtle]]:</p>
504+
<p>Interpreting this HTML content yields, in [[turtle]]:</p>
505505

506506
<pre id="dokieli-example-turtle" class="example nohighlight turtle" title="dokieli example in Turtle">
507507
@prefix oa: &lt;http://www.w3.org/ns/oa#&gt; .
508508
@prefix schema: &lt;http://schema.org/&gt; .
509509
@prefix rdf: &lt;http://www.w3.org/1999/02/22-rdf-syntax-ns#&gt; .
510-
@prefix rdfs: &lt;http://www.w3.org/2000/01/rdf-schema#&gt; .
511-
@prefix xml: &lt;http://www.w3.org/XML/1998/namespace&gt; .
512-
@prefix xsd: &lt;http://www.w3.org/2001/XMLSchema#&gt; .
513510

514511
&lt;https://example.org/art&gt; a oa:Annotation ;
515512
schema:name "Sarven Capadisli comments" ;
@@ -535,12 +532,10 @@ <h4>Example</h4>
535532
oa:renderedVia &lt;https://dokie.li/&gt; .
536533
</pre>
537534

538-
<p>Care should be taken, however, that the exact specification of what it means to mix both RDFa and embedded contents within the same HTML file is not (yet) formally specified. Tools that do understand this type </p>
539-
540535
<section>
541536
<h4>Mixing RDFa with embedded RDF content</h4>
542537

543-
<p>The approach used in <a href="#embed-json-ld"></a> can be combined, within the same HTML content, with the usage of RDFa. It is also possible to use the same approach (i.e., a <code>&lt;script&gt;</code> element with an appropriate media type) to include RDF using other serializations, most notably Turtle (see <a href="https://www.w3.org/TR/turtle/#in-html">Appendix A</a> of the [[turtle]] specification for more details). I.e, it is possible to modify the <a href="#dokieli-example">dokieli example</a> above as follows:</p>
538+
<p>The approach used in <a href="#embed-json-ld"></a> can be combined, within the same HTML content, with the usage of RDFa. It is also possible to use the same approach (namely using a <code>&lt;script&gt;</code> element with an appropriate media type) to include RDF using other serializations, for exaple Turtle (see <a href="https://www.w3.org/TR/turtle/#in-html">Appendix A</a> of the [[turtle]] specification for more details). I.e, it is possible to modify the <a href="#dokieli-example">dokieli example</a> above as follows:</p>
544539

545540
<pre id="dokieli-example-modified" class="example" title="Simplified dokieli example with embedded turtle">&lt;script type="text/turtle"&gt;
546541
@prefix oa: &lt;http://www.w3.org/ns/oa#&gt; .
@@ -579,16 +574,16 @@ <h4>Mixing RDFa with embedded RDF content</h4>
579574
&lt;/section&gt;
580575
&lt;/article&gt;</pre>
581576

582-
<p>With an appropriate tools, understanding both RDFa and the embedded Turtle, the results would be identical to <a href="#dokieli-example-turtle">Example 5</a>.</p>
577+
<p>With an appropriate tools that understand both RDFa and the embedded Turtle the results is identical to <a href="#dokieli-example-turtle">Example 5</a>.</p>
583578

584-
<p>Care should be taken, however, that the exact details of what it means to mix both RDFa and embedded contents within the same HTML file is not (yet) formally specified. Tools that do understand this type of mix usually parse the various syntaxes into separate RDF Graphs (see [[rdf11-concepts]]) which are then merged following the rules described in the RDF Semantics document&nbsp;[[rdf11-mt]]. This means that, for example, blank nodes are not shared, nor are namespace declarations among the different serializations.</p>
579+
<p>Care should be taken, however, that the exact details of what it means to mix both RDFa and embedded RDF contents within the same HTML file is not (yet) formally specified. Tools that do understand this type of mix usually parse the various syntaxes into separate RDF Graphs (see [[rdf11-concepts]]) which are then merged following the rules described in the RDF Semantics document&nbsp;[[rdf11-mt]]. This means that, for example, blank nodes are not shared, nor are namespace declarations among the different serializations.</p>
585580
</section>
586581
</section>
587582

588583
<section>
589584
<h3>Web Annotation-based Citation URLs</h3>
590-
<p>The Selectors and States Note [[selector-note]] published by the Web Annotation Working Group includes information on encoding
591-
<a data-cite="selector-note#frags">Web Annotation Selectors and State classes as IRI Fragment Identifiers</a>. The following
585+
<p>The Selectors and States Note [[selectors-states]] published by the Web Annotation Working Group includes information on encoding
586+
<a data-cite="selectors-states#frags">Web Annotation Selectors and State classes as IRI Fragment Identifiers</a>. The following
592587
examples show how these URLs could be used to reference portions of a Specific Resource on the Web via IRIs:
593588
</p>
594589
<section>
@@ -616,7 +611,7 @@ <h3>Example using <code>&lt;blockquote&gt;</code> and <code>&lt;q&gt;</code> tag
616611
all of the quotations (within the <code>&lt;q&gt;</code> tags) exist within the <code>#introduction</code> section referenced
617612
by the surrounding <code>&lt;blockquote&gt;</code>.
618613

619-
<p>The Selectors and States Note [[selector-note]] explains that fragment identifiers are technically defined when the media
614+
<p>The Selectors and States Note [[selectors-states]] explains that fragment identifiers are technically defined when the media
620615
type is specified. However in practice the utilization of fragment identifiers by publishers and developers ranges from
621616
browser state handling to anchoring highlights of quotations (as seen here).</p>
622617

@@ -625,7 +620,7 @@ <h3>Example using <code>&lt;blockquote&gt;</code> and <code>&lt;q&gt;</code> tag
625620
browser, server, and JavaScript developers may take advantage of these citations identifiers for re-anchoring selection
626621
or extracting (and verifying) quotations made within an HTML document which uses this method.</p>
627622
</section>
628-
<section>
623+
<section>
629624
<h3>Example using an <code>&lt;a&gt;</code> tag</h3>
630625

631626
<p>Using the same methods described above, <code>&lt;a&gt;</code> tags may also be used to express a desired highlight or reference. However,

0 commit comments

Comments
 (0)