W3C home > Mailing lists > Public > public-dxwg-wg@w3.org > September 2019

Re: [dxwg] Differentiating Functional & Data Profiling in Conneg (#1022)

From: aisaac via GitHub <sysbot+gh@w3.org>
Date: Thu, 26 Sep 2019 09:22:25 +0000
To: public-dxwg-wg@w3.org
Message-ID: <issue_comment.created-535418729-1569489744-sysbot+gh@w3.org>
Thanks a lot, @larsgsvensson ! I am happy with the changes but would still suggest some minor editorial changes to make the definitions (and the document) work even better:
- "This Content Negotiation by Profile specification concerns negotiation for data profiles, and specifies functional profiles for different ways of achieving this." could be complemented by "In this document, most occurrences of the term "profile" refer to "data profile"." (as this is just what happens: my previous idea to use "data profile" for every occurrence of that notion would cause the document to be very tedious to read!)
- "Source: deliberations of the DXWG." could be removed from the definitions of functional specification and functional profile
- I would recommend to hyperlink from "specifies functional profiles" in the definition of "profiles" to section 7.1 "#functional-profiles-definition" #functional-profiles-definition. Or to hyperlink to the definition of "functional profiles" in the same definition section, and ensure that there is an hyperlink from that definition to 7.1 (but it would be a bit trickier, i.e. adding a couple extra words to work as anchor, while the previous solution uses an anchor that already exists).

Then there are plenty small glitches and not-ideal hyperlinks, which could be fixed (sorry I'm not giving the section numbers. I guess a search for the sentences will work just as well...):
- "DTDs, XML Schema, vocabularies or other standards, specifications or profiles" should hyperlink to the definition of "data profiles" not profile.
- "What these tools call a view is analogous to a profile", ditto
- "(analogous profiles, as described in this document)" would work better as "(analogous to data profiles, as described in this document)", maybe with an hyperlink to the right definition.
- "Implementations of this Abstract Model for different environments are called Functional Profiles and to be a valid functional profile" would work better with the hyperlink to the definition put on the first occurrence of "functional profile"
- "A data model for describing the representations of a resource that conform to different profiles" would be clearer as "A data model for describing the representations of a resource that conform to different (data) profiles"
- "A client requesting the representation of a resource conforming to a profile MUST identify the resource by a Uniform Resource Identifier (URI) [RFC3986] and MUST identify the profile either by a URI or a token." should have the hyperlink to the definition of "data profile" not "profile"
- "it MUST unambiguously identify the profile" same remark. Or just remove the hyperlink, as there are already 2 in the same (short) subsection.
- "a client requests the list of URIs of profiles", "a server responds to a client with the list of URIs of the profiles", "a server responds with either a specific profile for a resource conforming to a requested profile identified by the client or it responds with a default profile", "A client wishes to know for which profiles a server", "The list profiles request MAY result in a response in one of a number of formats, provided that the profiles", "A server MUST NOT list profiles", "a resource that is claimed to conform to a profile", "one of any number of profiles" : ditto
- "Order of Precedence for Implementation Profiles" should probably be "Order of Precedence for Functional Profiles" and be moved to section 7 (at the end of it probably)?
- "if other profiles of the abstract model" should be "If other functional profiles of the abstract model"

I've stopped at the beginning of section 7. I could continue but I guess you get the idea :-)

-- 
GitHub Notification of comment by aisaac
Please view or discuss this issue at https://github.com/w3c/dxwg/issues/1022#issuecomment-535418729 using your GitHub account
Received on Thursday, 26 September 2019 09:22:26 UTC

This archive was generated by hypermail 2.3.1 : Wednesday, 30 October 2019 00:15:58 UTC