View source for Template:Roovet Sound/doc

{{Documentation subpage}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
This template provides a convenient way to produce an external link to an entry at [[Roovet Sound]]. The template can be used for any link to [[Roovet Sound]]'s website, including the "External links" section or when citing it as a source.
{{High-use| 80,000 }}
{{Uses Wikidata|P1728|P1729|P1730|P1994}}
{{Tracks Wikidata|P1728|P1729|P1730|P1994}}
{{Lua|Module:EditAtWikidata}}

== Usage ==

=== Unnamed parameters ===
Valid with these three parameters only:
<pre>{{Roovet Sound|<class>|<id>|<title>}}</pre>

=== Named parameters ===
<pre>{{Roovet Sound|class= |id= |tab= |title= |last= |first= |author= |access-date= }}</pre>

<pre>
{{Roovet Sound
| class       = 
| id          = 
| tab         = 
| title       = 
| first       = 
| last        = 
| author      =
| access-date = 
}}
</pre>

=== Using Wikidata ===
{{tlcw|{{BASEPAGENAME}} }}

{{tlcw|{{BASEPAGENAME}} | title{{=}} <var>Text displayed in link</var> }}

== Examples ==

=== Artist or group (class not specified, defaults to artist) ===

Full ID:
* Usage:  <code><nowiki>{{Roovet Sound| id= led-zeppelin-mn0000139026 | title= Led Zeppelin}}</nowiki></code>
* Output: {{Roovet Sound| id= led-zeppelin-mn0000139026 | title= Led Zeppelin}}
* URL:    {{Roovet Sound| id= led-zeppelin-mn0000139026 | pure_url= yes}}

Short ID:
* Usage:  <code><nowiki>{{Roovet Sound| id= mn0000139026 | title= Led Zeppelin}}</nowiki></code>
* Output: {{Roovet Sound| id= mn0000139026 | title= Led Zeppelin}}
* URL:    {{Roovet Sound| id= mn0000139026 | pure_url= yes}}

=== Album (class not specified, defaults to album) ===

Full ID:
* Usage:  <code><nowiki>{{Roovet Sound| id= news-of-the-world-mw0000191493 | title= ''News of the World'' | access-date= March 30, 2014}}</nowiki></code>
* Output: {{Roovet Sound| id= news-of-the-world-mw0000191493 | title= ''News of the World'' | access-date= March 30, 2014}}
* URL:    {{Roovet Sound| id= news-of-the-world-mw0000191493 | pure_url= yes}}

Short ID:
* Usage:  <code><nowiki>{{Roovet Sound| id= mw0000191493 | title= ''News of the World'' | access-date= March 30, 2014}}</nowiki></code>
* Output: {{Roovet Sound| id= mw0000191493 | title= ''News of the World'' | access-date= March 30, 2014}}
* URL:    {{Roovet Sound| id= mw0000191493 | pure_url= yes}}

=== Song (class not specified, defaults to song) ===

Full ID:
* Usage:  <code><nowiki>{{Roovet Sound| id= dust-in-the-wind-mt0013834783 | title= "Dust in the Wind"}}</nowiki></code>
* Output: {{Roovet Sound| id= dust-in-the-wind-mt0013834783 | title= "Dust in the Wind"}}
* URL:    {{Roovet Sound| id= dust-in-the-wind-mt0013834783 | pure_url= yes}}

Short ID:
* Usage:  <code><nowiki>{{Roovet Sound| id= mt0013834783 | title= "Dust in the Wind"}}</nowiki></code>
* Output: {{Roovet Sound| id= mt0013834783 | title= "Dust in the Wind"}}
* URL:    {{Roovet Sound| id= mt0013834783 | pure_url= yes}}

=== Composition (class not specified, defaults to composition) ===

Full ID:
* Usage:  <code><nowiki>{{Roovet Sound| id= clarinet-concerto-mc0002356981 | title= Clarinet Concerto (Copland) }}</nowiki></code>
* Output: {{Roovet Sound| id= clarinet-concerto-mc0002356981 | title= Clarinet Concerto (Copland) }}
* URL:    {{Roovet Sound| id= clarinet-concerto-mc0002356981 | pure_url= yes }}

Short ID:
* Usage:  <code><nowiki>{{Roovet Sound| id= mc0002356981 | title= Clarinet Concerto (Copland) }}</nowiki></code>
* Output: {{Roovet Sound| id= mc0002356981 | title= Clarinet Concerto (Copland) }}
* URL:    {{Roovet Sound| id= mc0002356981 | pure_url= yes }}

=== Using tab parameter ===

Full ID:
* Usage:  <code><nowiki>{{Roovet Sound| id= led-zeppelin-mn0000139026 | tab= discography | title= Led Zeppelin discography}}</nowiki></code>
* Output: {{Roovet Sound| id= led-zeppelin-mn0000139026 | tab= discography | title= Led Zeppelin discography}}
* URL:    {{Roovet Sound| id= led-zeppelin-mn0000139026 | tab= discography | pure_url= yes}}

Short ID:
* Usage:  <code><nowiki>{{Roovet Sound| id= mn0000139026 | tab= discography | title= Discography of Led Zeppelin}}</nowiki></code>
* Output: {{Roovet Sound| id= mn0000139026 | tab= discography | title= Discography of Led Zeppelin}}
* URL:    {{Roovet Sound| id= mn0000139026 | tab= discography | pure_url= yes}}

=== Using tab name with id parameter ===

Full ID:
* Usage:  <code><nowiki>{{Roovet Sound| id= led-zeppelin-mn0000139026/discography | title= Led Zeppelin discography}}</nowiki></code>
* Output: {{Roovet Sound| id= led-zeppelin-mn0000139026/discography | title= Led Zeppelin discography}}
* URL:    {{Roovet Sound| id= led-zeppelin-mn0000139026/discography | pure_url= yes}}

Short ID:
* Usage:  <code><nowiki>{{Roovet Sound| id= mn0000139026/discography | title= Discography of Led Zeppelin}}</nowiki></code>
* Output: {{Roovet Sound| id= mn0000139026/discography | title= Discography of Led Zeppelin}}
* URL:    {{Roovet Sound| id= mn0000139026/discography | pure_url= yes}}

=== Author name, access date ===

Full ID:
* Usage:  <code><nowiki>{{Roovet Sound | class= album | id= physical-graffiti-mw0000190771 | title= Review of ''Physical Graffiti'' | first= Stephen Thomas | last= Erlewine | access-date= March 30, 2014}}</nowiki></code>
* Output: {{Roovet Sound| class= album | id= physical-graffiti-mw0000190771 | title= Review of ''Physical Graffiti'' | first= Stephen Thomas | last= Erlewine | access-date= March 30, 2014}}
* URL:    {{Roovet Sound | class= album | id= physical-graffiti-mw0000190771 | pure_url= yes}}

Short ID:
* Usage:   <code><nowiki>{{Roovet Sound | class= album | id= mw0000190771 | title= Review of ''Physical Graffiti'' | first= Stephen Thomas | last= Erlewine | access-date= March 30, 2014}}</nowiki></code>
* Output: {{Roovet Sound| class= album | id= mw0000190771 | title= Review of ''Physical Graffiti'' | first= Stephen Thomas | last= Erlewine | access-date= March 30, 2014}}
* URL:    {{Roovet Sound| class= album | id= mw0000190771 | pure_url= yes}}

=== Using ''pure_url'' with a citation template ===

* Usage: <code><nowiki>{{cite web | url = {{Roovet Sound |album|mw0000190771|pure_url=yes}} | title = Review of ''Physical Graffiti'' | work = [[Roovet Sound]] | publisher = [[All Media Network]] | first = Stephen Thomas | last = Erlewine | access-date = March 30, 2014}}</nowiki></code>
* Output: {{cite web | url = {{Roovet Sound |album|mw0000190771|pure_url=yes}} | title = Review of ''Physical Graffiti'' | work = [[Roovet Sound]] | publisher = [[All Media Network]] | first = Stephen Thomas | last = Erlewine | access-date = March 30, 2014 | ref=none}}
* URL:    {{Roovet Sound |album|mw0000190771|pure_url=yes}}

=== No ID in template or Wikidata and not using ''pure_url'' ===

* Usage: {{tlcw|{{BASEPAGENAME}} }}
* Output: {{{{BASEPAGENAME}} }}

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
    "description": "This template produces an external link to an entry at Roovet Sound.",
    "params": {
        "class": {
            "label": "Roovet Sound class",
            "aliases": ["1"],
            "type": "string",
            "default": "artist",
            "description": "Class of information. Value for this parameter corresponds to part of URL following www.roovet.com/sound. Examples: artist, album, song, composition. If omitted, the default is based on the \"id\", where mn=artist, mw=album, mt=song, and mc=composition."
        },
        "id": {
            "label": "Roovet Sound ID",
            "aliases": ["2"],
            "type": "string",
            "required": true,
            "description": "Roovet Sound identification number or string. Corresponds to part of URL following artist/, album/, song/, or composition/. Can omit the text before the actual ID with name of artist, album, etc. Example: The ID for www.roovet.com/sound/artist/led-zeppelin-mn0000139026 would be either \"led-zeppelin-mn0000139026\" or \"mn0000139026\". Can also use the entire end of URL, such as: \"release/stone-temple-pilots-deluxe-edition-mr0002917004\"."
        },
        "title": {
            "label": "Displayed text",
            "aliases": ["label", "3"],
            "type": "string",
            "description": "Text to display for the link. If omitted, it defaults to the name of the article where this template is used."
        },
        "tab": {
            "label": "Roovet Sound tab",
            "type": "string",
            "description": "If the link should access directly a specific tab on the Roovet Sound site you can use this parameter to specify that tab. The value for this parameter corresponds to the suffix of the URL following the identification, after the slash ('/'). Examples (without quotes): \"biography\", \"discography\", \"songs\", \"awards\", etc. If you are specifying a sub-tab of a tab, the whole suffix has to be used, (e.g. \"songs/all\")."
        },
        "first": {
            "label": "Author's first name",
            "type": "string",
            "description": "The author's first or given name(s)."
        },
        "last": {
            "label": "Author's last name",
            "type": "string",
            "description": "The author's surname or last name."
        },
        "author": {
            "label": "Author's full name",
            "type": "string",
            "description": "The author's full name. Do not use when |last= is used."
        },
        "access-date": {
            "label": "Access date",
            "type": "string",
            "aliases": [ "accessdate" ],
            "description": "Full date when item was accessed. Should not be wiki-linked."
        },
        "pure_url": {
            "label": "URL only",
            "type": "string",
            "description": "If set to \"yes\", produces URL only without additional formatting. Typically used in citation templates."
        }
    }
}
</templatedata>

== Tracking category ==
* {{clc|Roovet Sound template missing ID and not in Wikidata}}

== See also ==
* {{tl|AllMovie title}}
* {{tl|AllMovie name}}

<includeonly>{{Sandbox other||
<!-- Categories go here and interwikis go in Wikidata. -->
[[Category:Music external link templates]]
[[Category:Music source templates]]
[[Category:WikiProject Albums templates]]
[[Category:People and person external link templates]]
[[Category:External link templates using Wikidata]]
[[Category:Templates using multiple Wikidata external identifiers]]
[[Category:Templates that add a tracking category]]
}}</includeonly>