Add some issue markers to the Framing spec
authorMarkus Lanthaler <mark_lanthaler@gmx.net>
Wed, 29 Aug 2012 14:24:38 +0200
changeset 850 0b9b6fde3841
parent 849 41fef7ed5622
child 851 07ed35df8100
Add some issue markers to the Framing spec

This addresses #110, #118, and #119.
spec/latest/json-ld-framing/index.html
--- a/spec/latest/json-ld-framing/index.html	Wed Aug 29 14:05:58 2012 +0200
+++ b/spec/latest/json-ld-framing/index.html	Wed Aug 29 14:24:38 2012 +0200
@@ -175,6 +175,8 @@
           // it is recommended that the respec.css stylesheet be kept
           // extraCSS: [],
 
+          issueBase: "https://github.com/json-ld/json-ld.org/issues/",
+
           // editors, add as many as you like
           // only "name" is required
           editors:  [
@@ -687,9 +689,15 @@
 <section>
 <h3>Framing Algorithm</h3>
 
-<p class="issue">This algorithm is a work in progress. Presently, it only works
+<p class="issue" data-number="118">This algorithm is a work in progress. Presently, it only works
   for documents without named graphs.</p>
 
+<p class="issue" data-number="110">Currently, framing allows just to select subject definitions based
+  on <code>@type</code> matching or duck typing for included properties. It allows value properties to
+  be explicitly matched based on defining the property and excluding things that are undefined, but it
+  does not allow to be more specific about the types of values selected. Allowing this is currently
+  being discussed.</p>
+
 <p>The framing algorithm takes an <tref>JSON-LD input</tref> (<strong>expanded input</strong>)
   and an <tref>input frame</tref> (<strong>expanded frame</strong>) that have been expanded
   according to the <a href="../json-ld-api/index.html#expansion-algorithm">Expansion Algorithm</a>,
@@ -845,9 +853,6 @@
   after replacement, an array contains only the value <tref>null</tref> remove the value, leaving
   an empty array. The resulting value is the final <tref>JSON-LD output</tref>.</p>
 
-<p class="issue">The algorithm needs to be updated to consider <code>@graph</code>. See
-  <a href="https://github.com/json-ld/json-ld.org/issues/118">ISSUE-118</a> for details.</p>
-
 </section>
 
 <section id="remove-embed">
@@ -855,8 +860,11 @@
 <p>This algorithm replaces an already embedded <tref>subject definition</tref> with a
   <tref>subject reference</tref>. It then recursively removes any entries in the
   <tref>map of embeds</tref> that had the removed <tref>subject definition</tref> in
-  their parent chain.
-  <div class="issue">About as clear as mud</div></p>
+  their parent chain.</p>
+<p class="issue">About as clear as mud</p>
+<p class="issue" data-number="119">The current behaviour avoids embedding the same data
+  multiple times in the result makes it difficult to work with the output. A proposal
+  to change this to "agressive re-embedding" is currently being discussed.</p>
 <p>The algorithm is invoked with a <tref>framing context</tref> and subject id <em>id</em>.</p>
 <ol class="algorithm">
   <li>Find <em>embed</em> from <tref>map of embeds</tref> for <em>id</em>.</li>