View source for Template:Subscription required/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE END OF THIS PAGE -->

{{cs1 function|by use of {{para|url-access}} and {{para|via}}}}
{{Hatnote|See [[WP:PAYWALL]] for the related policy}}
{{High-use}}
The {{tlc|subscription required}} template can be used to flag an external link that requires a [[paid subscription]].

Use the {{tlc|subscription required}} template when:

:You create or find a link to an external website

::in a reference citation
::'''OR'''
::in a paragraph within the body of an article
::'''OR'''
::in the "External links" section of an article

:'''AND'''

:a reader must pay to subscribe to the website to gain access to the linked page.

== Usage ==
Using {{tlc|subscription required}} will place a note by the link.

Append the {{tlc|subscription required}} template '''directly after''' the link or citation template, leaving the original link intact. If the {{tlc|subscription required}} template is not placed '''directly after''' the link or citation template, the template will not be correctly detected by automated tools.

If the external link is part of a '''reference citation''', the {{tlc|subscription required}} template should be placed '''directly after''' the link or citation template but before the <code>&lt;/ref&gt;</code> tag. Placing {{tlc|subscription required}} '''directly after''' the link or citation template but before the <code>&lt;/ref&gt;</code> tag will cause the '''subscription required''' message to appear in the footnote reference area of the article rather than in the body of the text. Placing the message in the body of the text is not recommended in this situation.

=== Common form ===
{{tlc|subscription required}}

This generates&nbsp;:

{{subscription required}}

=== Optional parameters ===

{{tlc|subscription required|via{{=}}}}

where ''via'' is the publication or website used.

In order to get the result as a sentence, write&nbsp;<code><nowiki>{{subscription required|s}}</nowiki></code>. This generates&nbsp;:

{{subscription required|s}}

=== Redirects ===
* {{tl|pay}}
* {{tl|paywall}}
* {{tl|required subscription}}
* {{tl|restricted access}}
* {{tl|subreq}}
* {{tl|subscription}}
* {{tl|subscriptionrequired}}
* {{tl|subscription needed}}

=== Categorization ===
Using this template in its common form will add pages to {{clc|Pages containing links to subscription-only content}}; when the {{para|via}} parameter is added, pages will also be placed into {{clc|Subscription required using via}}.

== Examples ==

=== External links ===
<code><nowiki>* [http://example.org/ Webpage title] {{subscription required}}</nowiki></code>
:* [http://example.org/ Webpage title] {{subscription required}}

=== Citation templates ===
<code><nowiki>Example.<ref>{{cite web |url=http://example.org/ |title=Webpage title |access-date=September 22, 2012}} {{subscription required}}</ref></nowiki></code>
: Example.<ref>{{cite web |url=http://example.org/ |title=Webpage title |access-date=September 22, 2012}} {{subscription required}}</ref>

<code><nowiki>Example.<ref>{{cite news |last=Woolf |first=Marie |date=13 April 2008 |url=http://www.timesonline.co.uk/tol/news/uk/article3736239.ece |title=Pirates can claim UK asylum |newspaper=[[The Sunday Times]] |access-date=22 April 2009 |location=London}} {{subscription required|s}}</ref></nowiki></code>
: Example.<ref>{{cite news |last=Woolf |first=Marie |date=13 April 2008 |url=http://www.timesonline.co.uk/tol/news/uk/article3736239.ece |title=Pirates can claim UK asylum |newspaper=[[The Sunday Times]] |access-date=22 April 2009 |location=London}} {{subscription required|s}}</ref>

<code><nowiki>Example.<ref>{{Cite book |title=Profit Theory and Capitalism |author=Obrinsky, Mark |location=Philadelphia |publisher=University of Pennsylvania Press {{Subscription required |via=[[Questia]]}} |url=https://www.questia.com/read/4995070/profit-theory-and-capitalism |year=1983 |page=1 |isbn=978-0812278637}}</ref></nowiki></code>
: Example.<ref>{{Cite book |title=Profit Theory and Capitalism |author=Obrinsky, Mark |location=Philadelphia |publisher=University of Pennsylvania Press {{Subscription required |via=[[Questia]]}} |url=https://www.questia.com/read/4995070/profit-theory-and-capitalism |year=1983 |page=1 |isbn=978-0812278637}}</ref>

<references />

=== Citation templates using {{para|url-access}} and {{para|via}} ===
<code><nowiki>Example.<ref>{{cite web |url=http://example.org/ |title=Webpage title |access-date=September 22, 2012 |url-access=limited}}</ref></nowiki></code>
: Example.<ref>{{cite web |url=http://example.org/ |title=Webpage title |access-date=September 22, 2012 |url-access=limited}}</ref>

<code><nowiki>Example.<ref>{{cite news |last=Woolf |first=Marie |date=13 April 2008 |url=http://www.timesonline.co.uk/tol/news/uk/article3736239.ece |title=Pirates can claim UK asylum |newspaper=[[The Sunday Times]] |access-date=22 April 2009 |location=London |url-access=subscription}}</ref></nowiki></code>
: Example.<ref>{{cite news |last=Woolf |first=Marie |date=13 April 2008 |url=http://www.timesonline.co.uk/tol/news/uk/article3736239.ece |title=Pirates can claim UK asylum |newspaper=[[The Sunday Times]] |access-date=22 April 2009 |location=London |url-access=subscription}}</ref>

<code><nowiki>Example.Example.<ref>{{Cite book |title=Profit Theory and Capitalism |author=Obrinsky, Mark |location=Philadelphia |publisher=University of Pennsylvania Press |url-access=subscription |via=[[Questia]] |url=https://www.questia.com/read/4995070/profit-theory-and-capitalism |year=1983 |page=1 |isbn=978-0812278637}}</ref></nowiki></code>
: Example.<ref>{{Cite book |title=Profit Theory and Capitalism |author=Obrinsky, Mark |location=Philadelphia |publisher=University of Pennsylvania Press |url-access=subscription |via=[[Questia]] |url=https://www.questia.com/read/4995070/profit-theory-and-capitalism |year=1983 |page=1 |isbn=978-0812278637}}</ref>

<references />

== See also ==
* {{tl|Registration required}} – to flag an external link that requires free registration.
* {{para|url-access}} in &#123;&#123;[[Template:cite news#Subscription or registration required|cite news]]&#125;&#125; and &#123;&#123;[[Template:cite web#Subscription or registration required|cite web]]&#125;&#125;
* [[Wikipedia:WikiProject Open Access/Signalling OA-ness]] 
** {{tl|Closed access}} and {{tl|Open access}} templates/symbols

<includeonly>{{Sandbox other||
<!-- CATEGORIES HERE, THANKS -->
[[Category:External link note templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>