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

Use LinkRole instead of PublicationLink #235

Closed
iherman opened this issue Jun 19, 2018 · 7 comments
Closed

Use LinkRole instead of PublicationLink #235

iherman opened this issue Jun 19, 2018 · 7 comments

Comments

@iherman
Copy link
Member

iherman commented Jun 19, 2018

(Extracting a discussion on #232 into a separate Issue.)

Schema.org has a (currently "pending") type LinkRole which may be a good alternative to the (publication specific) PublicationLink. Maybe worth considering using the schema.org type.


Ref: #232 (review), #232 (comment), #232 (comment)

@iherman
Copy link
Member Author

iherman commented Jun 19, 2018

Looking at the two types, the mapping of the relevant properties would be:

  • url is identical
  • name is identical
  • description is identical
  • rel would be replaced by linkRelationship although this is also pending, just like LinkRole
  • fileFormat would be the same, but it is not defined on that specific type, which may be a problem. (B.t.w, there is also a pending encodingFormat, that has the same issue.)

@iherman
Copy link
Member Author

iherman commented Jun 19, 2018

See also schemaorg/schemaorg#1959

@HadrienGardeur
Copy link

PublicationLink is meant to be our WebIDL, it was never my intention for this to be used in our JSON-LD manifest.

@HadrienGardeur
Copy link

From a manifest perspective, it makes sense to align with whatever's available in schema.org.

I'm just concerned once again by some of the decisions made by the schema.org community when naming such terms (linkRelationship vs rel, encodingFormat vs type).
Now that we have our own context document, it's always possible to use it for mapping those terms to something easier to use as well.

@iherman
Copy link
Member Author

iherman commented Jun 19, 2018

It is both. It is the name of the JSON-LD type that is used for the values of resources & co. That is already in the current draft:-) (In the schema.org world it seems that all objects is required to have a type.)

Obviously, if we move to LinkRole, we have to update the IDL as well.

@HadrienGardeur
Copy link

Obviously, if we move to LinkRole, we have to update the IDL as well.

We don't have to, but it makes the life of implementers much easier if we do.

There's no need to rename the dictionary in the WebIDL, but we can switch from rel to linkRelationship and from fileFormat to encodingFormat (to avoid a superseded term).

@iherman
Copy link
Member Author

iherman commented Jun 19, 2018

I am not fond of the schema.org names, but I would prefer to keep to them nevertheless and not hide them. Authors should be aware that they use schema.org, they may then use the various outreach materials that the schema.org community, for example.

(We can come back on this issue later, b.t.w., let us not worry about this now...)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants