alps-io / spec

ALPS Specification documents.
59 stars 13 forks source link

add ref to frag ids in media type definitions #65

Closed mamund closed 9 years ago

mamund commented 9 years ago

Section 4.

I think the media type registrations should reference the fragment id interpretation (sect 2.2.7.2).

/via Graham Klyne

mamund commented 9 years ago

add ref to JSON Pointer RFC6901 sec6 for frag ids in JSON flavors of ALPS: http://tools.ietf.org/html/rfc6901#section-6

add ref to XPtrFramework and Shorthand pointers for fragids in XML flavors of ALPS http://www.w3.org/TR/xptr-framework/#shorthand

additional info on defining fragids for media types: http://tools.ietf.org/html/rfc6838#section-4.11

consider refering to HTML 4.01 definition of fragment id: http://www.w3.org/TR/html401/intro/intro.html#fragment-uri

Frag-ID Best Practies http://www.w3.org/TR/fragid-best-practices/

mamund commented 9 years ago

@fosrias

in reviewing the various options for frag-id support, i've looked at JSON Pointer and XPointer as well as guidance on "best practices for implementing/supporting frag ids. while pointers are available (JSONPointer, XPointer) i propose to use only "Plain Name" frag-ids for ALPS[1]. basically, just an opaque string (e.g. "#user" -> id="user")[2] and not any pointer schemes.

sound ok?

[1] http://www.w3.org/TR/fragid-best-practices/#reserve-plain-name-fragids and http://www.w3.org/TR/fragid-best-practices/#suffixes

[2] http://www.w3.org/TR/xptr-framework/#shorthand

fosrias commented 9 years ago

Yeah. That has been my understanding from the beginning. Further, I am not sure w/r to alps there would be any point to pointing to some isolated part of a descriptor. href is sufficient to point to a specific descriptor.

So, short answer: concur

On Wednesday, March 11, 2015, Mike Amundsen notifications@github.com wrote:

@fosrias https://github.com/fosrias

in reviewing the various options for frag-id support, i've looked at JSON Pointer and XPointer as well as guidance on "best practices for implementing/supporting frag ids. while pointers are available (JSONPointer, XPointer) i propose to use only "Plain Name" frag-ids for ALPS[1]. basically, just an opaque string (e.g. "#user" -> id="user") and not any pointer schemes.

sound ok?

[1] http://www.w3.org/TR/fragid-best-practices/#reserve-plain-name-fragids

— Reply to this email directly or view it on GitHub https://github.com/alps-io/spec/issues/65#issuecomment-78408886.

mamund commented 9 years ago

there might be a call from some to also support the pointer specs. language/guidance is fuzzy there (as in, we're supposed to support the specs already established for the "suffix" media types).

i'll leave it like this and let's see how it goes.

mamund commented 9 years ago

closed per pr #72