Skip to content
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

Conneg Definitions #1014

Merged
merged 4 commits into from Jul 29, 2019
Merged

Conneg Definitions #1014

merged 4 commits into from Jul 29, 2019

Conversation

nicholascar
Copy link
Contributor

As requested by the Plenary session, here are the new definitions added to the Conneg doc. I have worked up some of the text around the definitions and also added some usage notes, as indicated to Plenary, to ensure compatibility with terminology.

Copy link
Contributor

@larsgsvensson larsgsvensson left a comment

Choose a reason for hiding this comment

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

Minor nitpick: In line 111 it should probably read 'In this document, these, and "data profiles", are referred to as just "profiles".' (there's one "just" too many...)

@nicholascar nicholascar changed the title data specification & data profile definitions updated conneg-definitions Jul 25, 2019
@nicholascar nicholascar changed the title conneg-definitions Conneg Definitions Jul 25, 2019
Copy link
Contributor

@kcoyle kcoyle left a comment

Choose a reason for hiding this comment

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

It appears that line 99

<dt><dfn data-lt="specification">data specification</dfn>

contradicts lines 102-104

 This document refers to both "data specifications" and also the more general "specifications". When the latter general case is referenced, its definition is taken
      to be that of the DCMI Metadata Terms [[DCTERMS]]'s definition for a <em>Standard</em>, which is "A basis for comparison; a reference point against which other things
      can be evaluated."

because the dfn data-lt points to specification, not data specification, yet "specification" has a different meaning from "data specification". I believe that the data-lt line should read:

<dt><dfn data-lt="data specification">data specification</dfn>

@rob-metalinkage
Copy link
Contributor

it doesnt actually contradict - as a data specification is a specialised form of specification fully consistent with the more general dct:Standard definition. Either way would be actually correct, but it doesnt hurt to use the more specific term "data specification" when we are talking about the data profiles being negotiated, not the conneg-by-ap specification itself, or its implementable functional profiles.

@nicholascar
Copy link
Contributor Author

@kcoyle are you ok with me leaving it as-is following @rob-metalinkage ‘s suggestion?

Or would you prefer me to add in a new definition for “specification”:

specification as per the current DC-inspired text, as well as the existing data specification? If I were to just change it as you suggest and not add in anything for just “specification”, then any references to the general specification will be left hanging (they will have a definition in text but not in a linkable definition list form).

@kcoyle
Copy link
Contributor

kcoyle commented Jul 26, 2019

The document as it is states that there is a distinction between "specification" and "data specification". This definition is only for "data specification" and "specification" is given a different definition in lines 102-104. Yet this definition will be linked from any uses of "specification". That seems to be inaccurate. Either "specification" is given the DC Terms definition and is separate from data definition, OR it is a substitute for "data specification" within this document. I don't see how it can be both.

You could either do:

<dt><dfn data-lt="specification">data specification</dfn>

on line 99, or you could change 102-104 to say something like:

"Within this document we use "specification" and "data specification" interchangeably, with the same meaning as given in the definition for "data specification".

With that latter you could leave the dfn statement as it is now.

Do you see the difference?

@nicholascar
Copy link
Contributor Author

I have added the DCT definition of "specification" to the list of definitions and ensured all links to definitions are correct.

@nicholascar nicholascar requested a review from kcoyle July 27, 2019 05:16
@nicholascar nicholascar dismissed larsgsvensson’s stale review July 29, 2019 01:27

Minor change made as requested

@nicholascar nicholascar merged commit 807d2fe into gh-pages Jul 29, 2019
@nicholascar nicholascar deleted the conneg-definitions branch July 29, 2019 01:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants