Incorrect, inconsistent, and under-utilised OpenGraph tags #3210
Labels
🕹 aspect: interface
Concerns end-users' experience with the software
✨ goal: improvement
Improvement to an existing user-facing feature
🟩 priority: low
Low priority and doesn't need to be rushed
🧱 stack: frontend
Related to the Nuxt frontend
🧹 status: ticket work required
Needs more details before it can be worked on
Description
Openverse incorrectly uses certain OpenGraph metadata properties. It also under-utilises the available properties. Please reference this Spanish language single result page of an image of a bird for an example of these issues
Openverse's tags:
Flickr's tags:
Compare something similar on Wikimedia Commons:
And one from Europeana:
og:description
is meant to be a description of the work. On single result pages like the one above, it is set to:<meta data-n-head="ssr" data-hid="og:description" name="og:description" content="Search over 700 million free and openly licensed images, photos, audio, and other media types for reuse and remixing.">
. Instead it should be the work's description. For some Openverse results this isn't practical, and the API doesn't surface this information anyway.og:description
isn't a required field, so we can just remove it.og:locale
is meant to be the locale the work is described in, not the locale of the page. That work in particular is described in English, yet theog:locale
is set toes
. Ifog:description
is changed to use the work description, I don't know if it's possible for us to easily correctog:locale
to match.og:locale
should also be inlanguage_TERRITORY
format, so the format we are using is incorrect.og:url
is a required property, but isn't present. OpenGraph defines it as "The canonical URL of your object that will be used as its permanent ID in the graph", which could be the foreign landing URL but could also need to be the Openverse single result page, depending on howog:url
is interpreted.og:type
is also required but not implemented. OGP's types are extremely unclear. They have types for video and music, but not for images. All of the places above exclude it, except for Flickr, which usesarticle
. The benefit of article is that it is built in and does include some important attributes like "article:author", which we could interpret as creator, andarticle:tag
where we could put some tags (probably not all, though!). Alternatively, OpenGraph does not have a native "image" type, but it can be defined following OGP using Dublin Core by including the DC namespace and using it forog:type
as follows:If the OpenGraph tags are meant to describe the webpage rather than the work, then the list above is mostly incorrect. In that case, these are the issues:
og:description
is not translated, soog:locale
is inaccurate.og:locale
format is incorrect (should belanguage_TERRITORY
but we only havelanguage
).og:type
is required should be set to "website" explicitlyog:url
is required and should be set to the single result, either the Openverse.org page or the API URIog:image
is fine as-isog:description
might be fine, though we could use more specific versions depending on whether the work is an image or audio, and we could due to specify the source. Maybe something like "<title> by on , indexed by Openverse"?. The idea would be to relate the contents of the page more accurately than the generic statement we currently use.og:title
should probably be something like "<title> by on Openverse", similar to the description.og:image:height
andog:image:width
can also be set because we pointog:image
to the thumbnail, for which we can fairly easily get the dimensions. We could also potentially getog:image:type
, which is just the mimetype ofog:image
.The text was updated successfully, but these errors were encountered: