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

MediaObject / embedUrl and contentUrl are confusing #462

Open
mfhepp opened this issue Apr 30, 2015 · 5 comments
Open

MediaObject / embedUrl and contentUrl are confusing #462

mfhepp opened this issue Apr 30, 2015 · 5 comments
Labels
guidelines docs examples Work on our supporting materials rather than on schema definitions no-issue-activity Discuss has gone quiet. Auto-tagging to encourage people to re-engage with the issue (or close it!). schema.org vocab General top level tag for issues on the vocabulary

Comments

@mfhepp
Copy link
Contributor

mfhepp commented Apr 30, 2015

I think that the descriptions for the following two properties are confusing:

contentUrl
Actual bytes of the media object, for example the image file or video file.
-> Maybe better as: The URL of the actual media object, e.g. the image or video file.

embedUrl
A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.

What is meant with the loc tag? Neither nor

This should be explained in the examples.

Note: This issue is related to #416.

@Aaranged
Copy link

I would add to this list:

url
URL of the item.

For MediaObject neither the cited property descriptions nor the examples provide guidance under which circumstances "contentUrl" should be used rather than "url". What is the difference between the two?

@blikkie
Copy link

blikkie commented May 1, 2015

I presume loc refers to the loc tag of the sitemaps protocol: http://www.sitemaps.org/protocol.html

Also, isn't the url redundant for a MediaObject any MediaObject is a Thing?

@Aaranged
Copy link

Aaranged commented May 1, 2015

Great catch with loc @blikkie. The reference to loc is indeed sitemap related. It comes directly from the Google Webmaster Tools Help page Creating a Video Sitemap, which reads:

A URL pointing to a player for a specific video. Usually this is the information in the src element of an tag and should not be the same as the content of the <loc> tag.

Because loc is not a schema.org property - and, indeed, except for this reference in relation to embedUrl isn't documented anywhere on schema.org - this should be removed from the cleaned up description for embedUrl (or explained in reference to sitemaps).

Re url I'm going to paste something on this issue from Dan Scott in a subsequent comment.

@Aaranged
Copy link

Aaranged commented May 1, 2015

Dan Scott - @dbs - provided this in a post on the public-schemaorg mailing list, which I'm copying and pasting here because I think it adds clarity to these issues:

I'm willing to take a stab at an answer (and thus willing to be wrong!). It probably works better with VideoObject or AudioObject examples which are more likely to have embeddable players.

... and to add in a suggested answer to Martin's related question around embedUrl:

  • embedUrl: is for a URL that can be used to embed the media on a web page via a specific media player (example:
    http://archive.org/embed/WhatIsLinkedDataAndWhatDoesItMeanForLibraries -- often embedded in an iframe element like <iframe src="https://archive.org/embed/WhatIsLinkedDataAndWhatDoesItMeanForLibraries" width="640" height="480" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen></iframe>). And of course this URL will often be used in the page referenced by schema:url about the VideoObject :)

So ultimately you could have a object with meaningfully distinct properties like:

<script type="application/ld+json">
{
  "@context": "http://schema.org",
  "@type": "VideoObject",
  "contentUrl": "https://archive.org/download/WhatIsLinkedDataAndWhatDoesItMeanForLibraries/2010.10.15Nla2010LinkedData.ogv
",
  "embedUrl": "http://archive.org/embed/WhatIsLinkedDataAndWhatDoesItMeanForLibraries",
  "url": "https://archive.org/details/WhatIsLinkedDataAndWhatDoesItMeanForLibraries",
  "name": "What is Linked Data and What Does it Mean for Libraries?"
}
</script>

To summarize:

  • I think all three properties have a reason to exist, if you look at them in context with one another
  • The properties probably make much more sense if used with a more conventionally streamable example such as AudioObject or VideoObject
  • We probably need to add more examples in this area, and ensure that we have some in which all of contentUrl, embedUrl, and url appear (and hang those examples off the properties, too) :)

@danbri danbri added schema.org vocab General top level tag for issues on the vocabulary guidelines docs examples Work on our supporting materials rather than on schema definitions labels May 27, 2015
@github-actions
Copy link

This issue is being tagged as Stale due to inactivity.

@github-actions github-actions bot added the no-issue-activity Discuss has gone quiet. Auto-tagging to encourage people to re-engage with the issue (or close it!). label Aug 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
guidelines docs examples Work on our supporting materials rather than on schema definitions no-issue-activity Discuss has gone quiet. Auto-tagging to encourage people to re-engage with the issue (or close it!). schema.org vocab General top level tag for issues on the vocabulary
Projects
None yet
Development

No branches or pull requests

4 participants