Skip to content

Add a section on using HTML documents for contexts (and frames). #167

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

Merged
merged 4 commits into from
May 1, 2019

Conversation

gkellogg
Copy link
Member

@gkellogg gkellogg commented Apr 25, 2019

@gkellogg
Copy link
Member Author

SpecGen is having some problems, you can find a preview here, sorry, no diffs, but changes are mostly in the "Using an HTML document as a Context" section and a paragraph at the end of "Framed Document Form".

Copy link
Member

@iherman iherman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For a first-time reader of that section it is not explicitly said in the text that a frame document is also a bona fide JSON-LD document. This is implicit by the fact that the two sections at the end (the new one and the previous one) refers to the JSON-LD profile; I think it should make it explicit in the text.

Obviously, this is not a comment on the new paragraph, but on the section as a whole. I am fine with the changes proper.

@deniak
Copy link
Member

deniak commented Apr 26, 2019

spec-generator is indeed timing out on large documents. I submitted a PR to increase the timeout:
w3c/spec-generator#210
Will deploy after Marcos reviews it.

@deniak
Copy link
Member

deniak commented Apr 26, 2019

It's now merged and deployed.

@gkellogg
Copy link
Member Author

@iherman, I put the Processor Levels section within Conformance, which I think is appropriate.

@gkellogg gkellogg merged commit e79cc8e into master May 1, 2019
@gkellogg gkellogg deleted the issue-66-html-context branch May 1, 2019 16:53
@pchampin
Copy link
Contributor

pchampin commented May 1, 2019

Isn't it a bit risky to have two normative definitions of the same terms live in two different files? I think we should at least have a comment in both files to remind our future selves (and future editors) that any update in one of the files should be reflected in the other... WDYT?

@gkellogg
Copy link
Member Author

gkellogg commented May 1, 2019

I can update the definitions in the context to reference the definitions in the syntax document easily enough. Doesn't change the way the text reads, but dereferences will go the the syntax versions.

@gkellogg
Copy link
Member Author

gkellogg commented May 1, 2019

See w3c/json-ld-api#84.

@BigBlueHat
Copy link
Member

@gkellogg sorry I missed reviewing this before the merge. I'm still concerned that we explain @context string values as de-reference-able URLs (vs. IRIs, URIs, identifiers which may or may not be dereferenced remotely). I realize this sections "overhead" is all about content negotiation and dealing with a non-JSON-LD media type...but if we could rephrase sentences like "This string is interpreted as a URL to an external document from which the context is loaded" to something that states that @context contains an "identifier which may be derefenerced" we may avoid continued criticism that we're 100% network dependent.

@gkellogg
Copy link
Member Author

gkellogg commented May 2, 2019

I was also thinking to beef up the Document Loader section and move most of the logic there, having the document loader return the JSON structure resulting from dereferencing the document. This also provides a means of describing other ways a custom document loader might handle IRIs without actual dereference.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants