Difference between revisions of "Style/Relationships/URLs"

From MusicBrainz Wiki
(Which relationship types to use)
 
(26 intermediate revisions by 7 users not shown)
Line 3: Line 3:
 
This page outlines general guidelines for adding relationships which link an entity to a URL. Many relationships also have their own guidelines which, should they conflict, supersede the ones on this page.
 
This page outlines general guidelines for adding relationships which link an entity to a URL. Many relationships also have their own guidelines which, should they conflict, supersede the ones on this page.
  
= Which URLs are allowed? =
+
== Which URLs are allowed? ==
  
==Multiple URLs for the same relationship type==
+
===Multiple URLs for the same relationship type===
  
 
In general, any relevant URLs can be added, there is no technical limit to the number which can be added. However, some relationship types can potentially have hundreds of valid links and you should not try to link to every possible site in these cases.
 
In general, any relevant URLs can be added, there is no technical limit to the number which can be added. However, some relationship types can potentially have hundreds of valid links and you should not try to link to every possible site in these cases.
Line 11: Line 11:
 
Some examples of how this applies to different relationship types:
 
Some examples of how this applies to different relationship types:
  
* [[Fanpage_Relationship_Type|Fan pages]]: pick the ones that are most useful as a resource for MusicBrainz users and avoid sites whose unique content is only a few obscure bits and pieces. 【second point on [[Fanpage_Relationship_Type]]】
+
* [[rt:f484f897-81cc-406e-96f9-cd799a04ee24|Fan pages]]: pick the ones that are most useful as a resource for MusicBrainz users and avoid sites whose unique content is only a few obscure bits and pieces.
  
* [[Online_Community_Relationship_Type|Online communities]]: pick the more active ones, or those preferred and/or supported by someone involved with the entity. 【second point on [[Online_Community_Relationship_Type]]】
+
* [[rt:35b3a50f-bf0e-4309-a3b4-58eeed8cee6a|Online communities]]: pick the more active ones, or those preferred and/or supported by someone involved with the entity.  
  
* [[Mail_Order_Relationship_Type|Mail order]] and download relationships: Don't try to link widely available releases to every online store. The mail order and download relationships are most useful when a release is only available from particular stores. 【from the last section of [[What_Not_To_Link_To]] even though it's not official】
+
* [[rt:611b1862-67af-4253-a64f-34adba305d1d|Mail order]] and [[rt:f8319a2f-f824-4617-81c8-be6560b3b203|download]] relationships: Don't try to link widely available releases to every online store. The mail order and download relationships are most useful when a release is only available from particular stores.
  
* [[Wikipedia_Relationship_Type|Wikipedia]]: Only link to the languages which are relevant to the artist. This usually means the artist's native language(s). The English Wikipedia is always allowed. 【new based on current unwritten consensus】
+
* [[rt:29651736-fa6d-48e4-aadc-a557c6add1cb|Wikipedia]]: If possible, link to [[rt:689870a4-a1e4-4912-b17f-7b2664215698|Wikidata]] instead, which serves as a bridge for all languages. If no Wikidata item exists, only link to the languages which are relevant to the artist. This usually means the artist's native language(s). The English Wikipedia is always allowed.
  
* [[Image_Relationship_Type|Images]] and [[Logo_Relationship_Type|logos]]: Don't link to the same image on multiple hosts. 【second point on [[Image_Relationship_Type]]】
+
* [[rt:221132e9-e30e-43f2-a741-15afc4c5fa7c|Artist images]], [[rt:68a4537c-f2a6-49b8-81c5-82a62b0976b7|place images]] and [[rt:b35f7822-bf3c-4148-b306-fb723c63ee8b|label logos]]: Don't link to the same image on multiple hosts.
  
== Restricted pages ==
+
=== Restricted pages ===
  
Pages do not have to be completely open, as long as it is accessible to the general internet population. Password-protected sites are frowned upon, but if the page is really worth linking to, so long as the website allows free registration, the link is allowed. 【second point on [[:Category:External_Information_Relationship_Class]]】
+
Pages do not have to be completely open, as long as it is accessible to the general internet population. Password-protected sites are frowned upon, but if the page is really worth linking to, so long as the website allows free registration, the link is allowed.
  
== When not to link ==
+
=== When not to link ===
  
Some sites discourage systematic linking. Please do not add links if it would be counter to the wishes of the other site. 【first point on [[Discography_Relationship_Type]]】
+
Some sites discourage systematic linking. Please do not add links if it would be counter to the wishes of the other site.
  
 
When linking to a page where you can download, stream or get music via mail-order, the page must respect copyright law.  Do NOT link to pages which contain pirated material.  There are two exceptions to this guideline:
 
When linking to a page where you can download, stream or get music via mail-order, the page must respect copyright law.  Do NOT link to pages which contain pirated material.  There are two exceptions to this guideline:
Line 34: Line 34:
 
# Derivative works such as mash-ups or unauthorized remixes (a well-known example of this is Danger Mouse's "The Grey Album").
 
# Derivative works such as mash-ups or unauthorized remixes (a well-known example of this is Danger Mouse's "The Grey Album").
  
= Which URL to use =
+
== Which URL to use ==
  
Many sites have multiple pages, so there may be several URLs which would work. URLs which are simple and unlikely to change are preferred.【first point on [[Online_Community_Relationship_Type]]】Avoid linking to websites' search pages. 【generic version of the bit in the cd baby section of [[What_Not_To_Link_To]]】 The URL should still be specific to the entity being linked, so please do not link to top level domains when a site has information about numerous artists, releases, etc. 【from the bottom of [[What_Not_To_Link_To]], also [[:Category:External_Resource_Relationship_Class]]... not happy with the wording though】
+
Many sites have multiple pages, so there may be several URLs which would work. URLs which are simple and unlikely to change are preferred. Avoid linking to websites' search pages. The URL should still be specific to the entity being linked, so please do not link to top level domains when a site has information about numerous artists, releases, etc.
  
 
;Examples
 
;Examples
Line 43: Line 43:
 
* The Amazon URL for [[release:963b0e2e-d6cb-4482-a600-0ad167e5bff2|With Teeth]] is <nowiki>http://www.amazon.com/gp/product/B0008ISM40</nowiki> ('''not''' <nowiki>http://www.amazon.com/</nowiki> because Amazon sells lots of different releases)
 
* The Amazon URL for [[release:963b0e2e-d6cb-4482-a600-0ad167e5bff2|With Teeth]] is <nowiki>http://www.amazon.com/gp/product/B0008ISM40</nowiki> ('''not''' <nowiki>http://www.amazon.com/</nowiki> because Amazon sells lots of different releases)
  
==Linking to images==
+
===Linking to images===
  
When linking to images, link directly to image files, not to pages containing pictures. 【third point on [[Image_Relationship_Type]]】 The exception to this is when using the [[Has_Cover_Art_At_Relationship_Type|cover art relationship]] to link to CD Baby or Jamendo, these are handled specially and should link to the release page. 【new based on how the server handles those】
+
When linking to images, link directly to image files, not to pages containing pictures.
  
==Linking to pages where you can get music==
+
===Linking to pages where you can get music===
  
The URL should also be as close as possible to a direct link to just the specific entity which is being linked. 【partly from [[:Category:Get_Music_Relationship_Class]] ... but does this mean link to the page or the actual download?】
+
The URL should also be as close as possible to a direct link to just the specific entity which is being linked.
  
==Standardised URLs==
+
===Standardised URLs===
 
For many sites, we use a standardised URL format. In most cases, the URL will be automatically formatted correctly.
 
For many sites, we use a standardised URL format. In most cases, the URL will be automatically formatted correctly.
  
:{|
+
== Which entity to link to ==
!List of standardised URLs
 
|-
 
|
 
* Amazon:
 
** Canada: <nowiki>http://www.amazon.ca/gp/product/<ASIN></nowiki>
 
** France: <nowiki>http://www.amazon.fr/gp/product/<ASIN></nowiki>
 
** Germany: <nowiki>http://www.amazon.de/gp/product/<ASIN></nowiki>
 
** Italy: <nowiki>http://www.amazon.it/gp/product/<ASIN></nowiki>
 
** Japan: <nowiki>http://www.amazon.co.jp/gp/product/<ASIN></nowiki>
 
** UK: <nowiki>http://www.amazon.co.uk/gp/product/<ASIN></nowiki>
 
** USA: <nowiki>http://www.amazon.com/gp/product/<ASIN></nowiki>
 
* Discogs:
 
** Artists: <nowiki>http://www.discogs.com/artist/<name></nowiki>
 
** Labels: <nowiki>http://www.discogs.com/label/<name></nowiki>
 
** Release groups: <nowiki>http://www.discogs.com/master/<ID></nowiki>
 
** Releases: <nowiki>http://www.discogs.com/release/<ID></nowiki>
 
* IMDb:
 
** Artists: <nowiki>http://www.imdb.com/artist/<ID>/</nowiki> ('''not''' <nowiki>http://www.imdb.com/artist/<ID>/bio</nowiki>)
 
** Release groups: <nowiki>http://www.imdb.com/title/<ID>/</nowiki> ('''not''' <nowiki>http://www.imdb.com/title/<ID>/soundtrack</nowiki>)
 
* MySpace: <nowiki>http://www.myspace.com/<username> or http://www.myspace.com/<profile number></nowiki>
 
* PureVolume: <nowiki>http://www.purevolume.com/<name></nowiki>
 
* Wikipedia: <nowiki>http://<language>.wikipedia.org/wiki/<page name></nowiki>
 
* YouTube: <nowiki>http://www.youtube.com/user/<username></nowiki>
 
|}
 
  
= Which entity to link to =
+
The URL should be linked to the most appropriate entity.
 
 
The URL should be linked to the most appropriate entity.【first point on [[Fanpage_Relationship_Type]]】
 
 
;Examples
 
;Examples
 
* <nowiki>http://www.amazon.com/gp/product/B0008ISM40</nowiki> is linked to [[release:963b0e2e-d6cb-4482-a600-0ad167e5bff2|With Teeth]] and not [[artist:b7ffd2af-418f-4be2-bdd1-22f8b48613da|Nine Inch Nails]]. The URL is a purchase page for a specific release and not for the artist in general.
 
* <nowiki>http://www.amazon.com/gp/product/B0008ISM40</nowiki> is linked to [[release:963b0e2e-d6cb-4482-a600-0ad167e5bff2|With Teeth]] and not [[artist:b7ffd2af-418f-4be2-bdd1-22f8b48613da|Nine Inch Nails]]. The URL is a purchase page for a specific release and not for the artist in general.
* <nowiki>http://www.metallica.com/</nowiki> is not the official homepage of [[artist:e2190b35-1181-44f6-8587-4c04123a6f30|Lars Ulrich]]. The site is for the group, not the specific person.
+
* <nowiki>http://www.metallica.com/</nowiki> is not the official homepage of [[artist:e2190b35-1181-44f6-8587-4c04123a6f30|Lars Ulrich]]. The site is for the group [[artist:65f4f0c5-ef9e-490c-aee3-909e7ae6b2ab|Metallica]], not the specific person.
  
=Which relationship types to use=
+
==Which relationship types to use==
  
 
The relationship type used should be the one which most closely matches. If there is a specific relationship type for the site, that relationship type should be used instead of generic types.
 
The relationship type used should be the one which most closely matches. If there is a specific relationship type for the site, that relationship type should be used instead of generic types.
  
 
;Examples
 
;Examples
* An article on Wikipedia should be linked using the Wikipedia relationship type and not the biography relationship type.
+
* An article on Wikipedia should be linked using the [[rt:29651736-fa6d-48e4-aadc-a557c6add1cb|Wikipedia]] relationship type and not the [[rt:78f75830-94e1-4138-8f8a-643e3bb21ce5|biography]] relationship type.
* A page on Amazon should use the Amazon relationship type rather than [[Has_Cover_Art_At_Relationship_Type|cover art]] or [[Discography_Relationship_Type|discography]] relationship types.
+
* A page on Amazon should use the [[rt:4f2e710d-166c-480c-a293-2e2c8d658d87|Amazon]] relationship type rather than the [[rt:4fb0eeec-a6eb-4ae3-ad52-b55765b94e8f|discography]] relationship type.
 +
 
 +
==When to remove==
 +
In most cases, if a URL was correct but no longer works, it's best to mark the relationship as ended rather than fully removing the URL. This allows us to try and access an archived version of the URL, and even if that doesn't exist it can be useful as a way to know that other page listing the same URL referred to the same artist. Since URL relationships marked as ended are not displayed as links, it's generally safe to keep the URL even if it points to some other content now.
 +
 
 +
There are still cases where a URL should certainly be removed. If the URL was never correct in the first place (was added to the wrong entity, for example), it obviously shouldn't be kept. Lyrics URLs can only be linked if the site has a license and is approved, so they should be removed once the license no longer applies, even if archived versions exist. And if a URL is known to have been taken over and now contains malware, it's safer to remove it to avoid risk to other editors.
  
=Restricted relationships=
+
==Restricted relationships==
  
 
For some of our relationships, only certain sites are permitted. For these, links to sites which are not on the whitelist '''must not''' be added.
 
For some of our relationships, only certain sites are permitted. For these, links to sites which are not on the whitelist '''must not''' be added.
 
These relationships are:
 
These relationships are:
* [[Has Cover Art At Relationship Type|cover art]]
+
* [[rt:e38e65aa-75e0-42ba-ace0-072aeb91a538|Lyrics]] ([[/Lyrics whitelist|whitelist]])
* [[Has Lyrics At Relationship Type|lyrics]]
+
* [[rt:38320e40-9f4a-3ae7-8cb2-3f3c9c5d856d|Other Databases]] ([[Other_Databases_Relationship_Type/Whitelist|whitelist]])
* [[Has Score At Relationship Type|score]]
+
 
 +
{{StyleBox}}
 +
[[Category:WikiDocs Page]]

Latest revision as of 04:46, 1 September 2021

Status: This is an official style guideline.

This page outlines general guidelines for adding relationships which link an entity to a URL. Many relationships also have their own guidelines which, should they conflict, supersede the ones on this page.

Which URLs are allowed?

Multiple URLs for the same relationship type

In general, any relevant URLs can be added, there is no technical limit to the number which can be added. However, some relationship types can potentially have hundreds of valid links and you should not try to link to every possible site in these cases.

Some examples of how this applies to different relationship types:

  • Fan pages: pick the ones that are most useful as a resource for MusicBrainz users and avoid sites whose unique content is only a few obscure bits and pieces.
  • Online communities: pick the more active ones, or those preferred and/or supported by someone involved with the entity.
  • Mail order and download relationships: Don't try to link widely available releases to every online store. The mail order and download relationships are most useful when a release is only available from particular stores.
  • Wikipedia: If possible, link to Wikidata instead, which serves as a bridge for all languages. If no Wikidata item exists, only link to the languages which are relevant to the artist. This usually means the artist's native language(s). The English Wikipedia is always allowed.

Restricted pages

Pages do not have to be completely open, as long as it is accessible to the general internet population. Password-protected sites are frowned upon, but if the page is really worth linking to, so long as the website allows free registration, the link is allowed.

When not to link

Some sites discourage systematic linking. Please do not add links if it would be counter to the wishes of the other site.

When linking to a page where you can download, stream or get music via mail-order, the page must respect copyright law. Do NOT link to pages which contain pirated material. There are two exceptions to this guideline:

  1. Bootleg recordings of concerts.
  2. Derivative works such as mash-ups or unauthorized remixes (a well-known example of this is Danger Mouse's "The Grey Album").

Which URL to use

Many sites have multiple pages, so there may be several URLs which would work. URLs which are simple and unlikely to change are preferred. Avoid linking to websites' search pages. The URL should still be specific to the entity being linked, so please do not link to top level domains when a site has information about numerous artists, releases, etc.

Examples
  • The official homepage for Nine Inch Nails is http://nin.com/ (not http://nin.com/index.php, as that is more likely to change)
  • The Wikipedia page for George Harrison is http://en.wikipedia.org/wiki/George_Harrison (not http://www.wikipedia.org/, because Wikipedia contains information about numerous different things)
  • The Amazon URL for With Teeth is http://www.amazon.com/gp/product/B0008ISM40 (not http://www.amazon.com/ because Amazon sells lots of different releases)

Linking to images

When linking to images, link directly to image files, not to pages containing pictures.

Linking to pages where you can get music

The URL should also be as close as possible to a direct link to just the specific entity which is being linked.

Standardised URLs

For many sites, we use a standardised URL format. In most cases, the URL will be automatically formatted correctly.

Which entity to link to

The URL should be linked to the most appropriate entity.

Examples
  • http://www.amazon.com/gp/product/B0008ISM40 is linked to With Teeth and not Nine Inch Nails. The URL is a purchase page for a specific release and not for the artist in general.
  • http://www.metallica.com/ is not the official homepage of Lars Ulrich. The site is for the group Metallica, not the specific person.

Which relationship types to use

The relationship type used should be the one which most closely matches. If there is a specific relationship type for the site, that relationship type should be used instead of generic types.

Examples
  • An article on Wikipedia should be linked using the Wikipedia relationship type and not the biography relationship type.
  • A page on Amazon should use the Amazon relationship type rather than the discography relationship type.

When to remove

In most cases, if a URL was correct but no longer works, it's best to mark the relationship as ended rather than fully removing the URL. This allows us to try and access an archived version of the URL, and even if that doesn't exist it can be useful as a way to know that other page listing the same URL referred to the same artist. Since URL relationships marked as ended are not displayed as links, it's generally safe to keep the URL even if it points to some other content now.

There are still cases where a URL should certainly be removed. If the URL was never correct in the first place (was added to the wrong entity, for example), it obviously shouldn't be kept. Lyrics URLs can only be linked if the site has a license and is approved, so they should be removed once the license no longer applies, even if archived versions exist. And if a URL is known to have been taken over and now contains malware, it's safer to remove it to avoid risk to other editors.

Restricted relationships

For some of our relationships, only certain sites are permitted. For these, links to sites which are not on the whitelist must not be added. These relationships are:

Style
Overview
Title Style
Entities
Relationships
Classical
Special Cases/Misc.
Languages