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

Definition and note of prof:hasToken #723

Closed
heidivanparys opened this issue Jan 31, 2019 · 6 comments
Closed

Definition and note of prof:hasToken #723

heidivanparys opened this issue Jan 31, 2019 · 6 comments
Labels
due for closing Issue that is going to be closed if there are no objection within 6 days feedback Issues stemming from external feedback to the WG profiles-vocabulary For discussion of profile description vocabulary
Milestone

Comments

@heidivanparys
Copy link
Contributor

The definition and note should be updated as they start with "A property..." and "This property is ...". A definition and note should define and describe the concept the property represents, not saying that "Property X represents concept X". See e.g. guideline 4 in Guidelines for writing definitions in ontologies

E.g.
definition: profile identifier for use in APIs
note: Should be used when the Profile's URI cannot be used. For potential use in content negotiation.

@andrea-perego andrea-perego added profiles-vocabulary For discussion of profile description vocabulary feedback Issues stemming from external feedback to the WG labels Jan 31, 2019
@makxdekkers
Copy link
Contributor

Very useful reference, thank you!
I commented on the style of definitions in the past (e.g. https://github.com/w3c/dxwg/issues/572 and #301). I suggested to use a common template "A something (with further clarification)", and leave statements about how, why and when to use it to usage notes.

@pwin
Copy link
Contributor

pwin commented Feb 26, 2019

ISO 11179 part 4 is another source of guidance on writing definitions of metadata standards terms:

http://metadata-standards.org/11179/#A4

@nicholascar nicholascar added this to To do in Profiles Ontology via automation Feb 26, 2019
@nicholascar nicholascar added this to the PROF 3PWD milestone Feb 26, 2019
@nicholascar
Copy link
Contributor

Hi @heidivanparys,

Thanks for these comments. We are now releasing the Profiles Ontology, now Profiles Vocabulary's Second Public Working Draft. I've now flagged this Issue you've raised for consideration in time for the Third Public Working Draft.

You'll see the Issue being addressed here.

Thanks,

Nick

@nicholascar
Copy link
Contributor

The definitions now in the Editor's Draft (and the 2PWD) are in line with the suggestions here although the definition has been changed to ensure the alternative-ness of the identifier, v. the URI, is indicated:

def: A preferred alternative identifier for the Profile
note: A simple lexical form of identifier that may be accepted in some circumstances, such as API arguments or in content negotiation, to reference a profile. This is a “preferred term”, since alternative identifiers may be declared and used by any implementation

@heidivanparys are you happy with these?

@nicholascar nicholascar added the due for closing Issue that is going to be closed if there are no objection within 6 days label Nov 25, 2019
@heidivanparys
Copy link
Contributor Author

@nicholascar

Yes the original issue reported (definition and note starting with "A property..." and "This property is ...") has been solved, so this issue can be closed.

Just a note: the definition in the HTML version is "The preferred identifier for the Profile, in circumstances where its URI cannot be used.", in the Turtle file it says "A preferred alternative identifier for the Profile", the same as above.

@nicholascar
Copy link
Contributor

Thanks @heidivanparys for the detailed reviewing! I have aligned all the defns in HTML and RDF now and committed that to the current Pull Requests, so this will be seen to be fixed shortly.

Profiles Ontology automation moved this from To do to Done Nov 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
due for closing Issue that is going to be closed if there are no objection within 6 days feedback Issues stemming from external feedback to the WG profiles-vocabulary For discussion of profile description vocabulary
Projects
Development

No branches or pull requests

5 participants