Changes
Template:Citation Style documentation/registration (view source)
Revision as of 20:55, 25 April 2021
, 20:55, 25 April 2021Tweak tables toward WP:ACCESS
<span id="csdoc_access_level"></span>
Citations of online sources that require registration or a subscription are acceptable in Wikipedia as documented in [[WP:PAYWALL|Verifiability § Access to sources]]<!-- {{Section link|Wikipedia:Verifiability|Access to sources}} -->. As a courtesy to readers and other editors, editors should<!-- can --> signal restrictions on access to material provided via the external links included in a citation. These levels describe requirements or constraints related to accessing and viewing the cited material; they are not intended to indicate the ability to reuse, or the copyright status, of the material, since that status is not relevant to [[WP:V|verifying claims in articles]].
<!-- There are four access levels split between the url-holding parameters and the identifier parameters. -->Four access levels can be used:
*[[#Access indicator for named identifiers|access indicator for named identifiers]]:
** [[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]] <code>free</code>: the source is free to read for anyone
*[[#Access indicators for url-holding parameters|access indicators for url-holding parameters]]:
** [[File:Lock-gray-alt-2.svg|9px|link=|alt=Free registration required|Free registration required]] <code>registration</code>: a free registration is required to access the source
** [[File:Lock-gray-alt-2.svg|9px|link=|alt=Free access subject to limited trial, subscription normally required|Free access subject to limited trial, subscription normally required]] <code>limited</code>: there are other constraints (such as a cap on daily views) to freely access this source
** [[File:Lock-red-alt-2.svg|9px|link=|alt=Paid subscription required|Paid subscription required]] <code>subscription</code>: the source is only accessible via a paid subscription ("[[paywall]]")
As there are often multiple external links with different access levels in the same citation, each value is attributed to a specific external link.
=====Access indicators for url-holding parameters=====
Online sources linked by {{para|url}}, {{para|article-url}}, {{para|chapter-url}}, {{para|contribution-url}}, {{para|entry-url}}, {{para|map-url}}, and {{para|section-url}} are presumed to be free-to-read.<ref name=NotRef>{{NotRef}}</ref> When they are not free-to-read, editors should mark those sources with the matching access-indicator parameter so that an appropriate icon is included in the rendered citation. Because the sources linked by these url-holding parameters are presumed to be free-to-read, they may not be marked as <code>free</code>.
{| class="wikitable plainrowheaders"
|+ URL-holding and access-indicator parameters
|-
!scope="col"| URL
!scope="col"| Access
!scope="col"| Allowed keywords
|-
!scope="row"| {{para|url}}
| {{para|url-access}} || rowspan="7" | <code>registration</code> [[File:Lock-gray-alt-2.svg|9px|link=|alt=Free registration required|Free registration required]]<br /><code>limited</code> [[File:Lock-gray-alt-2.svg|9px|link=|alt=Free access subject to limited trial, subscription normally required|Free access subject to limited trial, subscription normally required]]<br /><code>subscription</code> [[File:Lock-red-alt-2.svg|9px|link=|alt=Paid subscription required|Paid subscription required]]
|-
!scope="row"| {{para|article-url}}
| {{para|article-url-access}}
|-
!scope="row"| {{para|chapter-url}}
| {{para|chapter-url-access}}
|-
!scope="row"| {{para|contribution-url}}
| {{para|contribution-url-access}}
|-
!scope="row"| {{para|entry-url}}
| {{para|entry-url-access}}
|-
!scope="row"| {{para|map-url}}
| {{para|map-url-access}}
|-
!scope="row"| {{para|section-url}}
| {{para|section-url-access}}
|}
{{reflist}}
For example, this cites a web page that requires registration but not subscription:
:<nowiki>{{cite web |url=https://example.com/nifty_data.php |url-access=registration |date=2021-04-15 |title=Nifty example data}}</nowiki>
which renders as:
:{{cite web |url=https://example.com/nifty_data.php |url-access=registration |date=2021-04-15 |title=Nifty example data}}
=====Access indicator for named identifiers=====
<!-- ====Access level of identifiers==== -->
<!--
Links inserted by identifiers such as {{para|doi}} are not expected to offer a free full text by default. If they do, editors can use {{para|doi-access|free}} (in the case of {{para|doi}}) to indicate the relevant access level.
Some identifiers always link to free full texts. In this case, the access level is automatically indicated by the template. This is the case for {{para|arxiv}}, {{para|biorxiv}}, {{para|citeseerx}}, {{para|pmc}}, {{para|rfc}} and {{para|ssrn}}.
{| class="wikitable plainrowheaders"
|+identifier parameter access icons
!scope="col"| url parameter
!scope="col"| access icon parameter
!scope="col"| supported keywords
|-
!scope="row"| {{para|bibcode}}
| {{para|bibcode-access}} ||rowspan="6"|<code>free</code> – [[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]] – the source is free to read for anyone (not supported by {{para|url-access}})
|-
!scope="row"| {{para|doi}}
| {{para|doi-access}}
|-
!scope="row"| {{para|hdl}}
| {{para|hdl-access}}
|-
!scope="row"| {{para|jstor}}
| {{para|jstor-access}}
|-
!scope="row"| {{para|ol}}
| {{para|ol-access}}
|-
!scope="row"| {{para|osti}}
| {{para|osti-access}}
|}
-->
Links inserted by named identifiers are presumed to lie behind a paywall or registration barrier – exceptions listed below. When they are free-to-read, editors should mark those sources with the matching access-indicator parameter so that an appropriate icon is included in the rendered citation. Because the sources linked by these named-identifier parameters are not presumed to be free-to-read, they may not be marked as <code>limited</code>, <code>registration</code>, or <code>subscription</code>.
{| class="wikitable plainrowheaders"
|+ Named-identifier and access-indicator parameters
|-
!scope="col"| Identifier
!scope="col"| Access
!scope="col"| Allowed keywords
|-
!scope="row"| {{para|bibcode}}
| {{para|bibcode-access}} || rowspan="7" | <code>free</code> [[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]]
|-
!scope="row"| {{para|doi}}
| {{para|doi-access}}
|-
!scope="row"| {{para|hdl}}
| {{para|hdl-access}}
|-
!scope="row"| {{para|jstor}}
| {{para|jstor-access}}
|-
!scope="row"| {{para|ol}}
| {{para|ol-access}}
|-
!scope="row"| {{para|osti}}
| {{para|osti-access}}
|-
!scope="row"| {{para|s2cid}}
| {{para|s2cid-access}}
|}
Some named-identifiers are always free-to-read. For those named identifiers there are no access-indicator parameters; the access level is automatically indicated by the template. These named identifiers are:
*{{para|arxiv}}
*{{para|biorxiv}}
*{{para|citeseerx}}
*{{para|pmc}}
*{{para|rfc}}
*{{para|ssrn}}
For embargoed {{#invoke:cs1 documentation support|canonical_name_get|PMC}} that will become available in the future, see {{#invoke:cs1 documentation support|canonical_name_get|Embargo|id=csdoc_Embargo}}.
Citations of online sources that require registration or a subscription are acceptable in Wikipedia as documented in [[WP:PAYWALL|Verifiability § Access to sources]]<!-- {{Section link|Wikipedia:Verifiability|Access to sources}} -->. As a courtesy to readers and other editors, editors should<!-- can --> signal restrictions on access to material provided via the external links included in a citation. These levels describe requirements or constraints related to accessing and viewing the cited material; they are not intended to indicate the ability to reuse, or the copyright status, of the material, since that status is not relevant to [[WP:V|verifying claims in articles]].
<!-- There are four access levels split between the url-holding parameters and the identifier parameters. -->Four access levels can be used:
*[[#Access indicator for named identifiers|access indicator for named identifiers]]:
** [[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]] <code>free</code>: the source is free to read for anyone
*[[#Access indicators for url-holding parameters|access indicators for url-holding parameters]]:
** [[File:Lock-gray-alt-2.svg|9px|link=|alt=Free registration required|Free registration required]] <code>registration</code>: a free registration is required to access the source
** [[File:Lock-gray-alt-2.svg|9px|link=|alt=Free access subject to limited trial, subscription normally required|Free access subject to limited trial, subscription normally required]] <code>limited</code>: there are other constraints (such as a cap on daily views) to freely access this source
** [[File:Lock-red-alt-2.svg|9px|link=|alt=Paid subscription required|Paid subscription required]] <code>subscription</code>: the source is only accessible via a paid subscription ("[[paywall]]")
As there are often multiple external links with different access levels in the same citation, each value is attributed to a specific external link.
=====Access indicators for url-holding parameters=====
Online sources linked by {{para|url}}, {{para|article-url}}, {{para|chapter-url}}, {{para|contribution-url}}, {{para|entry-url}}, {{para|map-url}}, and {{para|section-url}} are presumed to be free-to-read.<ref name=NotRef>{{NotRef}}</ref> When they are not free-to-read, editors should mark those sources with the matching access-indicator parameter so that an appropriate icon is included in the rendered citation. Because the sources linked by these url-holding parameters are presumed to be free-to-read, they may not be marked as <code>free</code>.
{| class="wikitable plainrowheaders"
|+ URL-holding and access-indicator parameters
|-
!scope="col"| URL
!scope="col"| Access
!scope="col"| Allowed keywords
|-
!scope="row"| {{para|url}}
| {{para|url-access}} || rowspan="7" | <code>registration</code> [[File:Lock-gray-alt-2.svg|9px|link=|alt=Free registration required|Free registration required]]<br /><code>limited</code> [[File:Lock-gray-alt-2.svg|9px|link=|alt=Free access subject to limited trial, subscription normally required|Free access subject to limited trial, subscription normally required]]<br /><code>subscription</code> [[File:Lock-red-alt-2.svg|9px|link=|alt=Paid subscription required|Paid subscription required]]
|-
!scope="row"| {{para|article-url}}
| {{para|article-url-access}}
|-
!scope="row"| {{para|chapter-url}}
| {{para|chapter-url-access}}
|-
!scope="row"| {{para|contribution-url}}
| {{para|contribution-url-access}}
|-
!scope="row"| {{para|entry-url}}
| {{para|entry-url-access}}
|-
!scope="row"| {{para|map-url}}
| {{para|map-url-access}}
|-
!scope="row"| {{para|section-url}}
| {{para|section-url-access}}
|}
{{reflist}}
For example, this cites a web page that requires registration but not subscription:
:<nowiki>{{cite web |url=https://example.com/nifty_data.php |url-access=registration |date=2021-04-15 |title=Nifty example data}}</nowiki>
which renders as:
:{{cite web |url=https://example.com/nifty_data.php |url-access=registration |date=2021-04-15 |title=Nifty example data}}
=====Access indicator for named identifiers=====
<!-- ====Access level of identifiers==== -->
<!--
Links inserted by identifiers such as {{para|doi}} are not expected to offer a free full text by default. If they do, editors can use {{para|doi-access|free}} (in the case of {{para|doi}}) to indicate the relevant access level.
Some identifiers always link to free full texts. In this case, the access level is automatically indicated by the template. This is the case for {{para|arxiv}}, {{para|biorxiv}}, {{para|citeseerx}}, {{para|pmc}}, {{para|rfc}} and {{para|ssrn}}.
{| class="wikitable plainrowheaders"
|+identifier parameter access icons
!scope="col"| url parameter
!scope="col"| access icon parameter
!scope="col"| supported keywords
|-
!scope="row"| {{para|bibcode}}
| {{para|bibcode-access}} ||rowspan="6"|<code>free</code> – [[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]] – the source is free to read for anyone (not supported by {{para|url-access}})
|-
!scope="row"| {{para|doi}}
| {{para|doi-access}}
|-
!scope="row"| {{para|hdl}}
| {{para|hdl-access}}
|-
!scope="row"| {{para|jstor}}
| {{para|jstor-access}}
|-
!scope="row"| {{para|ol}}
| {{para|ol-access}}
|-
!scope="row"| {{para|osti}}
| {{para|osti-access}}
|}
-->
Links inserted by named identifiers are presumed to lie behind a paywall or registration barrier – exceptions listed below. When they are free-to-read, editors should mark those sources with the matching access-indicator parameter so that an appropriate icon is included in the rendered citation. Because the sources linked by these named-identifier parameters are not presumed to be free-to-read, they may not be marked as <code>limited</code>, <code>registration</code>, or <code>subscription</code>.
{| class="wikitable plainrowheaders"
|+ Named-identifier and access-indicator parameters
|-
!scope="col"| Identifier
!scope="col"| Access
!scope="col"| Allowed keywords
|-
!scope="row"| {{para|bibcode}}
| {{para|bibcode-access}} || rowspan="7" | <code>free</code> [[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]]
|-
!scope="row"| {{para|doi}}
| {{para|doi-access}}
|-
!scope="row"| {{para|hdl}}
| {{para|hdl-access}}
|-
!scope="row"| {{para|jstor}}
| {{para|jstor-access}}
|-
!scope="row"| {{para|ol}}
| {{para|ol-access}}
|-
!scope="row"| {{para|osti}}
| {{para|osti-access}}
|-
!scope="row"| {{para|s2cid}}
| {{para|s2cid-access}}
|}
Some named-identifiers are always free-to-read. For those named identifiers there are no access-indicator parameters; the access level is automatically indicated by the template. These named identifiers are:
*{{para|arxiv}}
*{{para|biorxiv}}
*{{para|citeseerx}}
*{{para|pmc}}
*{{para|rfc}}
*{{para|ssrn}}
For embargoed {{#invoke:cs1 documentation support|canonical_name_get|PMC}} that will become available in the future, see {{#invoke:cs1 documentation support|canonical_name_get|Embargo|id=csdoc_Embargo}}.