Editing Template:Citation Style documentation/registration

<span id="csdoc_access_level"></span>
{{shortcut|WP:URLACCESS}}
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 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>: 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 with the provider of the source ("[[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=====
{{see also|WP:CONLINK}}
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 are not marked as <code>free</code>.  If the registration/limited/subscription access to the source goes dead and is no longer available, then remove the access-indicator parameter and add {{para|archive-url}} and {{para|archive-date}} values if possible.

{| 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}}
|}

For example, this cites a web page that requires registration but not subscription:

<syntaxhighlight lang="wikitext">{{cite web |url=https://example.com/nifty_data.php |url-access=registration |date=2021-04-15 |title=Nifty example data}}</syntaxhighlight>

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==== -->
{{Shortcut|WP:DOIACCESS}}
<!--
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.

To be clear, these should be flagged when the databases themselves host the free document, not merely a link to another database that hosts them. For example, the following citation has 3 identifiers a [[Digital Object Identifier|DOI]], a [[PubMed Central Identifier|PMCID]], and a [[PubMed Identifier|PMID]].

* {{cite journal |last1=Velmovitsky |first1=Pedro Elkind |last2=Kirolos |first2=Merna |last3=Alencar |first3=Paulo |last4=Leatherdale |first4=Scott |last5=Cowan |first5=Donald |last6=Morita |first6=Plinio Pelegrini |title=Leveraging mHealth Technologies for Public Health |journal=JMIR Public Health and Surveillance |date=2024 |volume=10 |article-number=e49719 |doi=10.2196/49719 |doi-access=free |pmid=39265164 |pmc=11427850 }}

Clicking on the DOI takes you to a page where the full paper is freely accessible, so flagging with {{para|doi-access|free}} is appropriated. The PMCID link also takes you to a page where the full paper is freely accessible, and is likewise automatically flagged as free, as [[Template:Citation Style documentation#csdoc Embargo|virtually all]] PMCID links are free. The PMID link, however, only takes you to a page that contains links to free versions of the paper (the DOI link and the PMCID link), but does not host a free version itself. Therefore it is not flagged as free.

{| 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="8" | <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|ssrn}}
| {{para|ssrn-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|medrxiv}}
*{{para|pmc}}
*{{para|rfc}}

For an embargoed {{#invoke:cs1 documentation support|canonical_name_get|PMC}} that will become available in the future, see [[Template:Citation Style documentation#csdoc Embargo|{{#invoke:cs1 documentation support|canonical_name_get|Embargo}}]].

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, host paywalled reviews, or give only basic information about the source), they may not be marked as <code>limited</code>, <code>registration</code>, or <code>subscription</code>. Those named identifiers are
*{{para|asin}}/{{para|asin-tld}}
*{{para|issn}}/{{para|e-issn}}
*{{para|isbn}}
*{{para|ismn}}
*{{para|jfm}}
*{{para|lccn}}
*{{para|mr|}}
*{{para|oclc}}
*{{para|pmid}}
*{{para|sbn}}
*{{para|zbl}}

=====Tracking of free DOIs=====
* The template is able to recognize known free-to-read [[DOI registrant]]s, based on a list in [[Module:Citation/CS1/Configuration]]. Once a free registrant is identified, the <code>10.xxxx/...</code> part of the DOI associated with the registrant can be added to the list under {{code|2=lua|style=white-space:nowrap|1=local function build_free_doi_registrants_table()}}. If {{para|doi-access|free}} is not set, it will place the page in [[:Category:CS1 maint: unflagged free DOI]], which is routinely cleared by [[User:Citation bot]]. 
* The template is also able to recognize known free-to-read journals, assuming they have a clear <code>10.xxxx/yyyy....</code> DOI pattern. Once that pattern is identified, it can be added to [[Module:Citation/CS1/Configuration]] under {{code|2=lua|style=white-space:nowrap|1=local extended_registrants_t = {}} with the format {{code|2=lua|style=white-space:nowrap|1=['XXXX'] = {'YYYY'},}}. If there are multiple journals with the same DOI prefix, they can be grouped together with the format {{code|2=lua|style=white-space:nowrap|1=['XXXX'] = {'YYYY', 'ZZZZ', '...'},}}.
* If you add a free registrant/free journal to the lists in [[Module:Citation/CS1/Configuration]], leave a note at [[User talk:Citation bot]] so the bot knows about it.