search

w3c / json-ld-framing

JSON-LD 1.1 Framing Specification
https://w3c.github.io/json-ld-framing/
Other
25 stars 20 forks source link

"Framing" is an unfortunate choice of verb #13

Closed adrianhopebailie closed 6 years ago

adrianhopebailie commented 6 years ago

In reviewing the 1.1 spec I was surprised to discover that "framing" is not the process of surrounding JSON-LD data with a "frame". In my experience this is the most common definition of framing in a technical context.

i.e. Using special delimiters or length prefixes around a chunk of data that "frames" that data and differentiates one chunk from another when streamed between processes.

This is the definition I am accustomed to and I wonder if I am alone in being surprised that JSON-LD framing appears to be used to define a structure as opposed to a frame.

gkellogg commented 6 years ago

@dlongley is there a paragraph we could add to the introduction that would motivate the use of the term "framing" to describe this process?

dlongley commented 6 years ago

Maybe something along these lines (which would also tie it into Adrian's concerns):

Using delimiters around a chunk of data is known as "framing". JSON-LD uses JSON delimiters such as { and } to separate statements about a particular subject. JSON-LD also allows subjects to reference other subjects through the use of their identifiers, expressed as strings.

However, given that JSON-LD represents a graph of information, there is more than one way to frame the statements about several related subjects into a whole document. In fact, a graph of information can be thought of as a long list of independent statements (aka "triples" or "quads") that are not bundled together in any way.

The JSON-LD Framing API enables a developer to specify exactly how they would like data to be framed, such that statements about a particular subject are bundled together, delimited via { and }, and such that the subjects they relate to "nest" into a particular tree structure that matches what their application expects.

gkellogg commented 6 years ago

Excellent text, Dave, thanks!

azaroth42 commented 6 years ago

Thanks @dlongley, @gkellogg.

Per the WG resolution, we cannot change the name at this stage, but can add text explaining why that name was chosen. This issue can thus be closed when #17 is merged.