Open main menu
Producers.wiki

Difference between revisions of "Template:Citation Style documentation/registration"

< Template:Citation Style documentation
m (1 revision imported)
m (1 revision imported)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<span id="csdoc_access_level"></span>{{tracked|T225430}}Citations of online sources that require registration or a subscription are acceptable in Wikipedia as documented in [[WP:PAYWALL|Verifiability § Access to sources]]. As a courtesy to readers and other editors, editors should signal the access restrictions of the external links included in a citation.  {{lang|la|Nota bene}}: access icons do not display correctly for editors who use Modern skin.
+
<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 the access restrictions of the external links included in a citation.
  
−
Four access levels can be used:
+
<!-- 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]]:
 
*[[#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
 
** [[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]] <code>free</code>: the source is free to read for anyone
Line 12: Line 13:
  
 
=====Access indicators for url-holding parameters=====
 
=====Access indicators for url-holding parameters=====
−
Sources linked by {{para|url}}, {{para|chapter-url}}, {{para|entry-url}}, {{para|article-url}}, and {{para|section-url}} are presumed to be free-to-read. 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>.
+
<!-- ====Access level of url-holding parameters==== -->
 +
<!--
 +
There are several url-holding parameters. Each may be marked with an access icon. Links inserted with any of the url-holding parameters are expected to be free-to-read by default, so {{para|url-access|free}} is not valid. For a URL that is not free-to-read, editors may use the matching access-icon parameter with the appropriate keyword.
 +
 
 +
{| class=wikitable
 +
|+url-holding parameter access icons
 +
! url parameter !! access icon parameter !! supported keywords
 +
|-
 +
| {{para|url}} || {{para|url-access}} ||rowspan=7|{{plainlist|
 +
* <code>subscription</code> – [[File:Lock-red-alt-2.svg|9px|link=|alt=Paid subscription required|Paid subscription required]] – the source is only accessible via a paid subscription
 +
* <code>registration</code> – [[File:Lock-gray-alt-2.svg|9px|link=|alt=Free registration required|Free registration required]] – a free registration is required to access the source
 +
* <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]] – there are other constraints (such as a cap on daily views) to freely access this source}}
 +
|-
 +
| {{para|article-url}} || {{para|article-url-access}}
 +
|-
 +
| {{para|chapter-url}} || {{para|section-url-access}}
 +
|-
 +
| {{para|contribution-url}} || {{para|section-url-access}}
 +
|-
 +
| {{para|entry-url}} || {{para|section-url-access}}
 +
|-
 +
| {{para|map-url}} || {{para|section-url-access}}
 +
|-
 +
| {{para|section-url}} || {{para|section-url-access}}
 +
|}
 +
-->
 +
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"
 
{| class="wikitable"
−
|+ url-holding and access-indicator parameters
+
|+ URL-holding and access-indicator parameters
 
|-
 
|-
−
! url !! access !! allowed keywords
+
! URL !! Access !! Allowed keywords
 
|-
 
|-
−
| {{para|url}} || {{para|url-access}} || rowspan="6" | <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]]
+
| {{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]]
 
|-
 
|-
 
| {{para|article-url}} || {{para|article-url-access}}
 
| {{para|article-url}} || {{para|article-url-access}}
Line 25: Line 52:
 
| {{para|chapter-url}} || {{para|chapter-url-access}}
 
| {{para|chapter-url}} || {{para|chapter-url-access}}
 
|-
 
|-
−
| {{para|contribution-url}} || {{para|chapter-url-access}}{{dagger}}
+
| {{para|contribution-url}} || {{para|contribution-url-access}}
 
|-
 
|-
 
| {{para|entry-url}} || {{para|entry-url-access}}
 
| {{para|entry-url}} || {{para|entry-url-access}}
 +
|-
 +
| {{para|map-url}} || {{para|map-url-access}}
 
|-
 
|-
 
| {{para|section-url}} || {{para|section-url-access}}
 
| {{para|section-url}} || {{para|section-url-access}}
 
|}
 
|}
−
{{dagger}}{{para|contribution-url-access}} not currently defined; use its alias {{para|chapter-url-access}}
 
  
 
=====Access indicator for named identifiers=====
 
=====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
 +
|+identifier parameter access icons
 +
! url parameter !! access icon parameter !! supported keywords
 +
|-
 +
| {{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}})
 +
|-
 +
| {{para|doi}} || {{para|doi-access}}
 +
|-
 +
| {{para|hdl}} || {{para|hdl-access}}
 +
|-
 +
| {{para|jstor}} || {{para|jstor-access}}
 +
|-
 +
| {{para|ol}} || {{para|ol-access}}
 +
|-
 +
| {{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>.
 
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"
 
{| class="wikitable"
−
|+ named-identifier and access-indicator parameters
+
|+ Named-identifier and access-indicator parameters
 
|-
 
|-
−
! identifier!! access !! allowed keywords
+
! Identifier!! Access !! Allowed keywords
 
|-
 
|-
−
| {{para|bibcode}} || {{para|bibcode-access}} || rowspan="6" | <code>free</code> [[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]]
+
| {{para|bibcode}} || {{para|bibcode-access}} || rowspan="7" | <code>free</code> [[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]]
 
|-
 
|-
 
| {{para|doi}} || {{para|doi-access}}
 
| {{para|doi}} || {{para|doi-access}}
 
|-
 
|-
−
| {{para|hdl}} || {{para|hdl-access}}{{dagger}}
+
| {{para|hdl}} || {{para|hdl-access}}
 
|-
 
|-
 
| {{para|jstor}} || {{para|jstor-access}}
 
| {{para|jstor}} || {{para|jstor-access}}
Line 52: Line 103:
 
|-
 
|-
 
| {{para|osti}} || {{para|osti-access}}
 
| {{para|osti}} || {{para|osti-access}}
 +
|-
 +
| {{para|s2cid}} || {{para|s2cid-access}}
 
|}
 
|}
  
Line 61: Line 114:
 
*{{para|rfc}}
 
*{{para|rfc}}
 
*{{para|ssrn}}
 
*{{para|ssrn}}
−
 
−
=====Ambiguous access parameters=====
 
−
The parameters {{para|registration|yes}} and {{para|subscription|yes}} can also be used to indicate the access level of a citation. However, they do not indicate which link they apply to, so editors are encouraged to use {{para|url-access|registration}} and {{para|url-access|subscription}} instead, when the restriction applies to {{para|url}}. If the restriction applies to an identifier, these parameters should be omitted.
 
−
 
−
These parameters add a link note to the end of the citation:
 
−
* '''{{xtd|registration}}''': (deprecated) <s>For online sources that require registration, set {{para|registration|yes}} (or <code>y</code>, or <code>true</code>); yields to '''{{xtd|subscription}}''' if both are set.</s> Use the appropriate [[#Subscription_or_registration_required|access-indicator parameter]]
 
−
* '''{{xtd|subscription}}''': (deprecated) <s>For online sources that require a subscription, set {{para|subscription|yes}} (or <code>y</code>, or <code>true</code>); supersedes '''{{xtd|registration}}''' if both are set.</s> Use the appropriate [[#Subscription_or_registration_required|access-indicator parameter]]
 
−
Setting {{para|registration}} or {{para|subscription}} to any value other than <code>y</code>, <code>yes</code>, or <code>true</code> will generate an error message.
 

Latest revision as of 05:11, 17 December 2020

Citations of online sources that require registration or a subscription are acceptable in Wikipedia as documented in Verifiability § Access to sources. As a courtesy to readers and other editors, editors should signal the access restrictions of the external links included in a citation.

Four access levels can be used:

As there are often multiple external links with different access levels in the same citation, these values are attributed to a particular external link.

Access indicators for url-holding parameters

Sources linked by |url=, |article-url=, |chapter-url=, |contribution-url=, |entry-url=, |map-url=, and |section-url= are presumed to be free-to-read.[1] 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 free.

URL-holding and access-indicator parameters
URL Access Allowed keywords
|url= |url-access= registration Free registration required
limited Free access subject to limited trial, subscription normally required
subscription Paid subscription required
|article-url= |article-url-access=
|chapter-url= |chapter-url-access=
|contribution-url= |contribution-url-access=
|entry-url= |entry-url-access=
|map-url= |map-url-access=
|section-url= |section-url-access=
Access indicator for named identifiers

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 limited, registration, or subscription.

Named-identifier and access-indicator parameters
Identifier Access Allowed keywords
|bibcode= |bibcode-access= free Freely accessible
|doi= |doi-access=
|hdl= |hdl-access=
|jstor= |jstor-access=
|ol= |ol-access=
|osti= |osti-access=
|s2cid= |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:

  • |arxiv=
  • |biorxiv=
  • |citeseerx=
  • |pmc=
  • |rfc=
  • |ssrn=
  • ↑ This guidance does not restrict linking to websites that are being used as sources to provide content in articles.
    • Retrieved from "https://producers.wiki/index.php?title=Template:Citation_Style_documentation/registration&oldid=5488"