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

Harmonise property labels #534

Closed
nicholascar opened this issue Nov 6, 2018 · 9 comments
Closed

Harmonise property labels #534

nicholascar opened this issue Nov 6, 2018 · 9 comments
Assignees
Labels
due for closing Issue that is going to be closed if there are no objection within 6 days profiles-vocabulary For discussion of profile description vocabulary
Milestone

Comments

@nicholascar
Copy link
Contributor

nicholascar commented Nov 6, 2018

Some of the ontology's properties start with a has-, like hasRole, hasResource but not all do, like token and the inverse properties hasProfile and profileOf don't follow the same naming pattern. Also, in some places, like the example diagrams and the RDF ontology, property names are inconsistent.

Best practice for property naming, as exemplified by the SSN ontology, is to use has- and is- across the board for present tense properties (as PROV uses was-, had- for past tense things) so the inverse of hasProfile would be isProfileOf, not just isProfile, as it currently is, and token would be hasToken.

Renaming properties would make no difference to the ontology functioning but would better indicate the purpose and direction of properties (:Profile-X prof:hasToken :Token-Y is thought to be more intuitive according to SSN & TIME etc.

If a renaming is to be made, best it is done before use (ideally before FPWD).

@nicholascar nicholascar added the profiles-vocabulary For discussion of profile description vocabulary label Nov 6, 2018
@nicholascar nicholascar self-assigned this Nov 6, 2018
@nicholascar
Copy link
Contributor Author

I have harmonised property names across all HTML, RDF & image resources, including examples in a branch. I have prepared this pull request: #532 showing the changes.

@akuckartz
Copy link

Best practice for property naming, as exemplified by the SSN ontology, is to use has- and is- across the board for present tense properties ...

I doubt that there is consensus that this is considered a "best practice".

@rob-metalinkage
Copy link
Contributor

I see some pros and cons for this proposal:

pros:

  • there has been a lot of discussion about what defines a profile vs what properties a profile has.. and the is/has dichotomy probably helps here
  • now is the best time to make any such changes - people are looking and after it goes into the wild its harder to change
  • there is no installed base we need to keep happy yet
  • there is no change to the actual model

cons:

  • naming conventions are probably not easily identified as best practice or not
  • there is a lot of work to update ontology, diagrams, documents and examples
  • implementers need to be happy with this

Given the work involved has been done (the biggest issue) and a PR generated, and Nick is an implementer, and I will also implement in a different context and have been hanging off waiting for expected name changes from FPWD feedback....

I'm inclined to support the proposal as a marginal improvement in readability - that won't delay us getting to a FPWD.

So I guess it comes down now to the group consensus on property naming styles..

It doesnt affect the readiness of the FPWG - we simply choose version 1 or 2..

We have two choices:

  1. make this an issue for the plenary - i.e. vote to accept it immediately
  2. accept there is no change to the model and this is editorial in nature and leave it to the Profile guidance sub-group to make the final decision and release the relevant version to W3C

@aisaac
Copy link
Contributor

aisaac commented Nov 6, 2018

My recommendation on this is to get labels harmonized and discuss prefered convention later. After all, this issue is only about getting labels harmonized :-)

In any case transition to FPWD cannot result in enshrining anything like this.

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

Due for closing as the issue has been resolved in the now merged #532

@agbeltran
Copy link
Member

agbeltran commented Nov 13, 2018

Getting the labels harmonised is important and except for what I reported in #555 and proposed fix in #556, it should be ok in the ontology.

In terms of the names themselves, I would have preferred the shorter names (e.g. profileOf rather than isProfileOf) but this is only about naming styles preferences and indeed affects not ontology the ontology but document and diagrams, etc, so the choice of naming should be settled soon.

@agbeltran
Copy link
Member

Actually, the document still has some misalignments with respect to the ontology:
e.g. for isProfileOf the label in the document is still profile of instead of is profile of
document: https://w3c.github.io/dxwg/profilesont/#Property:isProfileOf
ontology:

rdfs:label "is profile of" .

@nicholascar
Copy link
Contributor Author

Thanks @agbeltran, I have update the label "profile of" -> "is profile of".

It's perhaps not thrilling styalistically to have these longer property names but it is consistent...

@nicholascar nicholascar added this to the PROF 2PWD milestone Jan 15, 2019
@nicholascar
Copy link
Contributor Author

Labels harmonised in document as per this date

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 profiles-vocabulary For discussion of profile description vocabulary
Projects
None yet
Development

No branches or pull requests

5 participants