Template:Citation Style documentation/registration: Difference between revisions

Update the documentation to match the module
(fixed!)
 
imported>Hawkeye7
(Update the documentation to match the module)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<span id="csdoc_access_level"></span>
<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.
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:
<!-- There are four access levels split between the url-holding parameters and the identifier parameters. -->Four access levels can be used:
Line 6: Line 6:
** [[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
*[[#Access indicators for url-holding parameters|access indicators for url-holding parameters]]:
*[[#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 registration required|Free registration required]] <code>registration</code>: a free registration with the provider is required to access the source, even if a limited preview, abstract or review may still be available without registration
** [[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-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>: free access is subject to limited trial and a subscription is normally required
** [[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]]")
** [[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 with the provider of the source ("[[paywall]]")


As there are often multiple external links with different access levels in the same citation, these values are attributed to a particular external link.
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=====
=====Access indicators for url-holding parameters=====
<!-- ====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
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. 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>.
|+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 plainrowheaders"
|+ URL-holding and access-indicator parameters
|+ URL-holding and access-indicator parameters
|-
|-
! URL !! Access !! Allowed keywords
!scope="col"| URL
!scope="col"| Access
!scope="col"| Allowed keywords
|-
|-
| {{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|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}}
!scope="row"| {{para|article-url}}
| {{para|article-url-access}}
|-
|-
| {{para|chapter-url}} || {{para|chapter-url-access}}
!scope="row"| {{para|chapter-url}}
| {{para|chapter-url-access}}
|-
|-
| {{para|contribution-url}} || {{para|contribution-url-access}}
!scope="row"| {{para|contribution-url}}
| {{para|contribution-url-access}}
|-
|-
| {{para|entry-url}} || {{para|entry-url-access}}
!scope="row"| {{para|entry-url}}
| {{para|entry-url-access}}
|-
|-
| {{para|map-url}} || {{para|map-url-access}}
!scope="row"| {{para|map-url}}
| {{para|map-url-access}}
|-
|-
| {{para|section-url}} || {{para|section-url-access}}
!scope="row"| {{para|section-url}}
| {{para|section-url-access}}
|}
|}
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 indicator for named identifiers=====
Line 68: Line 60:
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}}.
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
{| class="wikitable plainrowheaders"
|+identifier parameter access icons
|+identifier parameter access icons
! url parameter !! access icon parameter !! supported keywords
!scope="col"| url parameter
!scope="col"| access icon parameter
!scope="col"| 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}})
!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}})
|-
|-
| {{para|doi}} || {{para|doi-access}}
!scope="row"| {{para|doi}}
| {{para|doi-access}}
|-
|-
| {{para|hdl}} || {{para|hdl-access}}
!scope="row"| {{para|hdl}}
| {{para|hdl-access}}
|-
|-
| {{para|jstor}} || {{para|jstor-access}}
!scope="row"| {{para|jstor}}
| {{para|jstor-access}}
|-
|-
| {{para|ol}} || {{para|ol-access}}
!scope="row"| {{para|ol}}
| {{para|ol-access}}
|-
|-
| {{para|osti}} || {{para|osti-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>.
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.  When the sources linked by these named-identifier parameters are not presumed to carry a free-to-read full text (for instance because they're just abstracting services), they may not be marked as <code>limited</code>, <code>registration</code>, or <code>subscription</code>.


{| class="wikitable"
{| class="wikitable plainrowheaders"
|+ Named-identifier and access-indicator parameters
|+ Named-identifier and access-indicator parameters
|-
|-
! Identifier!! Access !! Allowed keywords
!scope="col"| Identifier
!scope="col"| Access
!scope="col"| Allowed keywords
|-
|-
| {{para|bibcode}} || {{para|bibcode-access}} || rowspan="7" | <code>free</code> [[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]]
!scope="row"| {{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}}
!scope="row"| {{para|doi}}
| {{para|doi-access}}
|-
|-
| {{para|hdl}} || {{para|hdl-access}}
!scope="row"| {{para|hdl}}
| {{para|hdl-access}}
|-
|-
| {{para|jstor}} || {{para|jstor-access}}
!scope="row"| {{para|jstor}}
| {{para|jstor-access}}
|-
|-
| {{para|ol}} || {{para|ol-access}}
!scope="row"| {{para|ol}}
| {{para|ol-access}}
|-
|-
| {{para|osti}} || {{para|osti-access}}
!scope="row"| {{para|osti}}
| {{para|osti-access}}
|-
|-
| {{para|s2cid}} || {{para|s2cid-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:
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|arxiv}}
*{{para|biorxiv}}
*{{para|biorxiv}}
Line 114: Line 123:
*{{para|rfc}}
*{{para|rfc}}
*{{para|ssrn}}
*{{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}}.
Anonymous user