Template:Citation Style documentation/registration: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
← Older edit
VisualWikitext
m Fix broken wikilink
m Update template documentation to reflect code changes
 
Line 3: Line 3:
Four access levels can be defined for citation template links.
Four access levels can be defined for citation template links.
* '''[[#Access indicator for named identifiers|§ Access indicators for named identifiers]]:'''
* '''[[#Access indicator for named identifiers|§ Access indicators for named identifiers]]:'''
** [[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]] '''<code>free</code>''': The source is free to be read by anyone.
** [[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]] '''{{Code|free}}''': The source is freely accessible to everyone, worldwide.
* '''[[#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>''': Registration with the provider is required to access the source without any cost, even if a limited preview, abstract or review may still be available without registration.
** [[File:Lock-gray-alt-2.svg|9px|link=|alt=Free registration required|Free registration required]] '''{{Code|registration}}''': Registration with the provider without any associated cost is required to access the source, even if a limited preview, abstract or synopsis may still be available without registration.
** [[File:Lock-gray-alt-2.svg|9px|link=|alt=Free limited access trial, afterwards paid subscription required|Free limited access trial, afterwards paid subscription required]] '''<code>limited</code>''': Free access is subject to a limited trial period after which a paid subscription is normally required.
** [[File:Lock-gray-alt-2.svg|9px|link=|alt=Free limited access trial, afterwards paid subscription required|Free limited access trial, afterwards paid subscription required]] '''{{Code|limited}}''': Free access is subject to a limited trial period, after which a paid 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 (behind a "[[wikipedia:Paywall|paywall]]").
** [[File:Lock-red-alt-2.svg|9px|link=|alt=Paid subscription required|Paid subscription required]] '''{{Code|subscription}}''': The source is only accessible via a paid subscription with the provider (a/k/a it lies behind a "[[wikipedia:Paywall|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.
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 =====
Online sources linked by '''<code>url</code>''', '''<code>article-url</code>''', '''<code>chapter-url</code>''', '''<code>contribution-url</code>''', '''<code>entry-url</code>''', '''<code>map-url</code>''' and '''<code>section-url</code>''' are presumed to be free-to-read. When they are not, 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 cannot be explicitly 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 value for the '''<code>archive-url</code>''' and '''<code>archive-date</code>''' parameters, if possible.
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, 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 cannot be explicitly marked as '''{{Code|free}}'''. If the registration/limited/subscription access to the source goes dead and is no longer available, then remove the access-indicator parameter and add values for the '''{{Para|archive-url}}''' and '''{{Para|archive-date}}''' parameters instead, if possible.


{| class="wikitable plainrowheaders" style="margin-left: 8em; min-width: 33vw; text-align: center;"
{| class="wikitable plainrowheaders" style="margin-left: 8em; min-width: 33vw; text-align: center;"
Line 20: Line 20:
  ! scope="col" | Valid keywords
  ! scope="col" | Valid keywords
  |-
  |-
  ! scope="row" | '''<code>url</code>'''
  ! scope="row" | {{Para|url}}
  | '''<code>url-access</code>'''
  | '''{{Para|url-access}}'''
  | rowspan="7" style="line-height: 2;" | <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 limited access trial, afterwards paid subscription required|Free limited access trial, afterwards paid subscription required]]<br /><code>subscription</code> [[File:Lock-red-alt-2.svg|9px|link=|alt=Paid subscription required|Paid subscription required]]
  | rowspan="7" style="line-height: 2;" | {{Code|registration}}&nbsp;[[File:Lock-gray-alt-2.svg|9px|link=|alt=Free registration required|Free registration required]]<br />{{Code|limited}}&nbsp;[[File:Lock-gray-alt-2.svg|9px|link=|alt=Free limited access trial, afterwards paid subscription required|Free limited access trial, afterwards paid subscription required]]<br />{{Code|subscription}}&nbsp;[[File:Lock-red-alt-2.svg|9px|link=|alt=Paid subscription required|Paid subscription required]]
  |-
  |-
  ! scope="row" | '''<code>article-url</code>'''
  ! scope="row" | {{Para|article-url}}
  | '''<code>article-url-access</code>'''
  | '''{{Para|article-url-access}}'''
  |-
  |-
  ! scope="row" | '''<code>chapter-url</code>'''
  ! scope="row" | {{Para|chapter-url}}
  | '''<code>chapter-url-access</code>'''
  | '''{{Para|chapter-url-access}}'''
  |-
  |-
  ! scope="row" | '''<code>contribution-url</code>'''
  ! scope="row" | {{Para|contribution-url}}
  | '''<code>contribution-url-access</code>'''
  | '''{{Para|contribution-url-access}}'''
  |-
  |-
  ! scope="row" | '''<code>entry-url</code>'''
  ! scope="row" | {{Para|entry-url}}
  | '''<code>entry-url-access</code>'''
  | '''{{Para|entry-url-access}}'''
  |-
  |-
  ! scope="row" | '''<code>map-url</code>'''
  ! scope="row" | {{Para|map-url}}
  | '''<code>map-url-access</code>'''
  | '''{{Para|map-url-access}}'''
  |-
  |-
  ! scope="row" | '''<code>section-url</code>'''
  ! scope="row" | {{Para|section-url}}
  | '''<code>section-url-access</code>'''
  | '''{{Para|section-url-access}}'''
|}
|}


Line 49: Line 49:
…which gets rendered as…
…which gets rendered as…


:{{Cite web|url=https://example.com/nifty_data.php|url-access=registration|date=2021-04-15|title=Nifty example data|df=mdy}}
: {{Cite web|url=https://example.com/nifty_data.php|url-access=registration|date=2021-04-15|title=Nifty example data|df=mdy}}


===== Access indicator for named identifiers =====
===== Access indicator for named identifiers =====
Links inserted by named identifiers, such as '''<code>doi</code>''', are presumed to lie behind a paywall or registration barrier and lack free full-text access by default, with exceptions listed below. When they are free-to-read, editors should mark those sources with the corresponding {{Para|{{Var|indicator}}-access|free}} key/value pair 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 free-to-read full-text access (as when they're just abstracting services), they may not be marked as <code>limited</code>, <code>registration</code> or <code>subscription</code>.
Links inserted by named identifiers, such as '''{{Para|doi}}''', are presumed to lie behind a paywall or registration barrier and lack free full-text access by default – exceptions listed below. When they are free-to-read, editors should mark those sources with the corresponding {{Para|{{Var|identifier}}-access|free}} key/value pair 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 free-to-read full-text access (as when they're just abstracting services), they may not be marked as {{Code|limited}}, {{Code|registration}} or {{Code|subscription}}.


{| class="wikitable plainrowheaders" style="margin-left: 8em; min-width: 37.5vw; text-align: center;"
{| class="wikitable plainrowheaders" style="margin-left: 8em; min-width: 37.5vw; text-align: center;"
Line 60: Line 60:
  ! scope="col" | Valid keywords
  ! scope="col" | Valid keywords
  |-
  |-
  ! scope="row" | '''<code>bibcode</code>'''
  ! scope="row" | {{Para|bibcode}}
  | '''<code>bibcode-access</code>'''
  | '''{{Para|bibcode-access}}'''
  | rowspan="7" | <code>free</code> [[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]]<br />The source is free to be read by anyone<br />(not supported by '''<code>url-access</code>''')
  | rowspan="8" | {{Code|free}}&nbsp;[[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]]<br />The source is freely accessible to everyone<br />(not supported by '''{{Para|url-access}}''')
  |-
  |-
  ! scope="row" | '''<code>doi</code>'''
  ! scope="row" | {{Para|doi}}
  | '''<code>doi-access</code>'''
  | '''{{Para|doi-access}}'''
  |-
  |-
  ! scope="row" | '''<code>hdl</code>'''
  ! scope="row" | {{Para|hdl}}
  | '''<code>hdl-access</code>'''
  | '''{{Para|hdl-access}}'''
  |-
  |-
  ! scope="row" | '''<code>jstor</code>'''
  ! scope="row" | {{Para|jstor}}
  | '''<code>jstor-access</code>'''
  | '''{{Para|jstor-access}}'''
  |-
  |-
  ! scope="row" | '''<code>ol</code>'''
  ! scope="row" | {{Para|ol}}
  | '''<code>ol-access</code>'''
  | '''{{Para|ol-access}}'''
  |-
  |-
  ! scope="row" | '''<code>osti</code>'''
  ! scope="row" | {{Para|osti}}
  | '''<code>osti-access</code>'''
  | '''{{Para|osti-access}}'''
  |-
  |-
  ! scope="row" | '''<code>s2cid</code>'''
  ! scope="row" | {{Para|ssrn}}
  | '''<code>s2cid-access</code>'''
| '''{{Para|ssrn-access}}'''
|-
! scope="row" | {{Para|s2cid}}
  | '''{{Para|s2cid-access}}'''
|}
|}


Some identifiers always offer free full-text access, and if so the access level is automatically indicated by the template. This is the case for:
Some identifiers always offer free full-text access, and so free access is automatically indicated by the template. This is the case for:
* '''<code>arxiv</code>'''
* '''{{Para|arxiv}}'''
* '''<code>biorxiv</code>'''
* '''{{Para|biorxiv}}'''
* '''<code>citeseerx</code>'''
* '''{{Para|citeseerx}}'''
* '''<code>medrxiv</code>'''
* '''{{Para|medrxiv}}'''
* '''<code>pmc</code>'''
* '''{{Para|pmc}}'''
* '''<code>rfc</code>'''
* '''{{Para|rfc}}'''
* '''<code>ssrn</code>'''.


For embargoed <code>{{#invoke:Cs1 documentation support|canonical_name_get|PMC}}</code> documents that will become available in the future, see [[#csdoc_Embargo|<code>{{#invoke:Cs1 documentation support|canonical_name_get|Embargo|id=csdoc_Embargo}}</code>]].
For embargoed '''{{Code|{{#invoke:Cs1 documentation support|canonical_name_get|PMC}}}}''' documents that will become available in the future, see [[#csdoc_Embargo|<code>{{#invoke:Cs1 documentation support|canonical_name_get|Embargo|id=csdoc_Embargo}}</code>]].


===== Tracking of free DOIs =====
===== Tracking of free DOIs =====
* The template is able to recognize known free-to-read [[wikipedia:DOI registrant|DOI registrants]] 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 ''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]].
* The template is able to recognize known free-to-read [[wikipedia:DOI registrant|DOI registrants]] 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|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]].
* 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 ''local extended_registrants_t = {'' with the format <code>['XXXX'] = {'YYYY'},</code>. If there are multiple journals with the same DOI prefix, they can be grouped together with the format <code>['XXXX'] = {'YYYY', 'ZZZZ', '...'},</code>.
* The template is also able to recognize known free-to-read journals, assuming they have a clear {{Code|10.xxxx/yyyy…}} DOI pattern. Once that pattern is identified, it can be added to [[Module:Citation/CS1/Configuration]] under {{Code|local extended_registrants_t}} with the format {{Code|1=['XXXX'] = &lbrace;'YYYY'&rbrace;}}. If there are multiple journals with the same DOI prefix, they can be grouped together with the format {{Code|1=['XXXX'] = &lbrace;'YYYY', 'ZZZZ', '…'&rbrace;}}.

Latest revision as of 22:13, 22 December 2025

Citations of online sources that require registration or a paid subscription are acceptable on Zoophilia Wiki. As a courtesy to readers and other editors, editors should signal restrictions on access to material provided via the external links included in citations. 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 providing evidence in support of the information found in articles here.

Four access levels can be defined for citation template links.

  • § Access indicators for named identifiers:
    • Freely accessible free: The source is freely accessible to everyone, worldwide.
  • § Access indicators for URL-holding parameters:
    • Free registration required registration: Registration with the provider without any associated cost is required to access the source, even if a limited preview, abstract or synopsis may still be available without registration.
    • Free limited access trial, afterwards paid subscription required limited: Free access is subject to a limited trial period, after which a paid subscription is normally required.
    • Paid subscription required subscription: The source is only accessible via a paid subscription with the provider (a/k/a it lies behind a "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 |url=, |article-url=, |chapter-url=, |contribution-url=, |entry-url=, |map-url= and |section-url= are presumed to be free-to-read. When they are not, 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 cannot be explicitly marked as free. If the registration/limited/subscription access to the source goes dead and is no longer available, then remove the access-indicator parameter and add values for the |archive-url= and |archive-date= parameters instead, if possible.

URL access-indicator parameter mappings
URL holder Access indicator Valid keywords
|url= |url-access= registration Free registration required
limited Free limited access trial, afterwards paid subscription 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=

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

{{Cite web|url=https://example.com/nifty_data.php|url-access=registration|date=2021-04-15|title=Nifty example data|df=mdy}}

…which gets rendered as…

"Nifty example data". April 15, 2021.
Access indicator for named identifiers

Links inserted by named identifiers, such as |doi=, are presumed to lie behind a paywall or registration barrier and lack free full-text access by default – exceptions listed below. When they are free-to-read, editors should mark those sources with the corresponding |identifier-access=free key/value pair 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 free-to-read full-text access (as when they're just abstracting services), they may not be marked as limited, registration or subscription.

Named identifier access-indicator parameter mappings
Identifier parameter Access indicator Valid keywords
|bibcode= |bibcode-access= free Freely accessible
The source is freely accessible to everyone
(not supported by |url-access=)
|doi= |doi-access=
|hdl= |hdl-access=
|jstor= |jstor-access=
|ol= |ol-access=
|osti= |osti-access=
|ssrn= |ssrn-access=
|s2cid= |s2cid-access=

Some identifiers always offer free full-text access, and so free access is automatically indicated by the template. This is the case for:

  • |arxiv=
  • |biorxiv=
  • |citeseerx=
  • |medrxiv=
  • |pmc=
  • |rfc=

For embargoed pmc documents that will become available in the future, see pmc-embargo-date.

Tracking of free DOIs
  • The template is able to recognize known free-to-read DOI registrants based on a list in Module:Citation/CS1/Configuration. Once a free registrant is identified, the 10.xxxx/... part of the DOI associated with the registrant can be added to the list under local function build_free_doi_registrants_table(). If |doi-access=free is not set, it will place the page in Category:CS1 maint: Unflagged free DOI.
  • The template is also able to recognize known free-to-read journals, assuming they have a clear 10.xxxx/yyyy… DOI pattern. Once that pattern is identified, it can be added to Module:Citation/CS1/Configuration under local extended_registrants_t with the format ['XXXX'] = {'YYYY'}. If there are multiple journals with the same DOI prefix, they can be grouped together with the format ['XXXX'] = {'YYYY', 'ZZZZ', '…'}.
Retrieved from "https://zoophilia.wiki/index.php?title=Template:Citation_Style_documentation/registration&oldid=134015"