Added specification of Link attribute token #1066
Conversation
Fixed html error
Added an example
Fixed pre formatting
larsgsvensson
requested review from
RubenVerborgh,
nicholascar and
rob-metalinkage
| the attribute <code>token</code> is used to specify | ||
| the mapping between the profile URI | ||
| (specified using the <code>anchor</code> attribute) | ||
| and a <a>token</a> used as an alternative to the full profile URI. |
There was a problem hiding this comment.
Minor comment, but perhaps the "mapping" language does not need to end up in the document. We talk about this mapping in the context of this WG, but the concept itself is probably not important to the document. So it could be fine to just write that the token is a (typically shorter) string that can be used by clients as an alternative to the full profile URI.
There was a problem hiding this comment.
Are you proposing that the document just says "token is a (typically shorter) string that can be used by clients as an alternative to the full profile URI" and then examples, like the one you submitted in your earlier PR, carry the demonstration? I'd prefer this written explanation be included but perhaps I've missed what you're suggesting.
There was a problem hiding this comment.
Yes, that's what I am proposing. Along with the removal of the "mapping" language.
There was a problem hiding this comment.
Yes, that's what I am proposing. Along with the removal of the "mapping" language.
| (i. e. the resource identified by the current request URI). | ||
| Servers MAY use a larger scope for their mappings | ||
| but clients should not depend on that | ||
| unless the server documentation explicitly gives other instructions. |
There was a problem hiding this comment.
…through some other means?
There was a problem hiding this comment.
Are you asking what other means could even be possible?
Perhaps something like OAI-PMH's metadatPrefix listing where the server lists the prefixes for all profiles for all resources in one place. Very different mechanism but wrappable as Conneg-by-P I've always thought.
There was a problem hiding this comment.
I meant to explicitly say something like (verbatim) "through some other means" to emphasize that such means are not part of the spec.
| unless the server documentation explicitly gives other instructions. | ||
| </p> | ||
| <p> | ||
| The ABNF for the profile attribute's value is <code>token</code>, |
There was a problem hiding this comment.
For the token attribute value?
Is quoted-string?
Is the Web Linking RFC not more appropriate here?
| </p> | ||
| <pre id="eg-link-attribute-token" class="example nohighlight" aria-busy="false" aria-live="polite" | ||
| title="Using the Link attribute "token" to link a profile URI to a token"> | ||
| # The profile URI in the "anchor" element is linked to the token "px" |
There was a problem hiding this comment.
Just wondering whether px is a realistic name of a token. I also reused it myself, but I have no idea if this would be typical. 2 chars seem really short.
There was a problem hiding this comment.
Yes, really short. I've been using things like dcat or prov (Turtle prefixes) or well-known things like ISO + standard numbers. See examples of tokens in old view/format system in use: http://pid.geoscience.gov.au/sample/AU100?_view=alternates
There was a problem hiding this comment.
^ let's perhaps use one of these?
There was a problem hiding this comment.
Fine by me too. Some replies to @RubenVerborgh 's points inline. I've not merged already only so @larsgsvensson can read all those comments before merging.
* Removed "mapping" language * Added "through some other means" to "server gives other instructions" * The value of the "token" attribute is now `( token / quoted-string )` since that is what's used in [§3 of RFC 8288](https://tools.ietf.org/html/rfc8288#section-3) * Replaced the dummy example with one from [Nick's geoscience list](http://pid.geoscience.gov.au/sample/AU100?_view=alternates)
Fixes for the issues in #1066
Preview at https://raw.githack.com/w3c/dxwg/larsgsvensson-link-attribute-token/conneg-by-ap/index.html#link-attributes