Template:Citation Style documentation/registration: Difference between revisions

imported>Hawkeye7
Update the documentation to match the module
m 1 revision imported: template update
 
(One intermediate revision by one other user not shown)
Line 13: Line 13:


=====Access indicators for url-holding parameters=====
=====Access indicators for url-holding parameters=====
 
{{shortcut|WP:URLACCESS}}
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>.
{{main|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"
{| class="wikitable plainrowheaders"
Line 47: Line 48:
For example, this cites a web page that requires registration but not subscription:
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>
<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:
which renders as:
Line 95: Line 96:
|-
|-
!scope="row"| {{para|bibcode}}
!scope="row"| {{para|bibcode}}
| {{para|bibcode-access}} || rowspan="7" | <code>free</code> [[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]]
| {{para|bibcode-access}} || rowspan="8" | <code>free</code> [[File:Lock-green.svg|9px|link=|alt=Freely accessible|Freely accessible]]
|-
|-
!scope="row"| {{para|doi}}
!scope="row"| {{para|doi}}
Line 111: Line 112:
!scope="row"| {{para|osti}}
!scope="row"| {{para|osti}}
| {{para|osti-access}}
| {{para|osti-access}}
|-
!scope="row"| {{para|ssrn}}
| {{para|ssrn-access}}
|-
|-
!scope="row"| {{para|s2cid}}
!scope="row"| {{para|s2cid}}
Line 120: Line 124:
*{{para|biorxiv}}
*{{para|biorxiv}}
*{{para|citeseerx}}
*{{para|citeseerx}}
*{{para|medrxiv}}
*{{para|pmc}}
*{{para|pmc}}
*{{para|rfc}}
*{{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}}.
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}}.
=====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 ''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 ''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>.
* 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.