imported>Hike395: /* Adding templates to the whitelist */ typo

2024-12-02T15:58:05Z

Adding templates to the whitelist: typo

New page

{{High-risk}}
This page is a formatted list of anchor IDs and associated citation wrapper-templates. Because of {{cl|Harv and Sfn template errors#Current limitations and false-positive errors|technical limitations}}, short-cite templates, via [[Module:Footnotes]], will emit [[false positive|false-positive]] error messages for citation wrapper-templates. The anchor IDs listed here instruct Module:Footnotes to suppress error messages for short-cite templates that link to the anchor IDs listed here so long as the associated citation wrapper-template is present in the article. This is an imperfect system that will allow [[false negative|false-negatives]] because this mechanism will suppress valid error messages in the absence of a full-cite target. Adding an anchor ID and matching template to this list will suppress all {{error-small|no target}} error messages for that anchor ID / template pair.

==Adding templates to the whitelist==
There are three whitelist mechanisms for templates: each one is appropriate for different template behaviors:
# Wrapper template produces small number of different references, whose name and date is suitable for short footnotes, name and date not overriden
#: In this case, the CITEREF should be added to the <code>whitelist</code> variable, with a key of the form <code>CITEREFNameDate</code> and value being a list of templates that can generate that CITEREF.
#:* Do not include disambiguation letters in whitelist entries. In other words, use "CITEREFSmith2018" in this whitelist even when the cite template generates "CITEREFSmith2018a".
#:*[[Module:Footnotes/whitelist/sort]] is a tool to aid the maintenance of <code>whitelist{}</code>.
# Wrapper template produces name and date suitable for short footnotes, but the name and date often get overriden and can generate many different references.
#:These wrapper templates should be added to the <code>wrapper_template</code> variable. The module will then look for uses of the template where the name and/or date are overriden.
#:* The default name+date should be supplied either in <code>wrapper_template_defaults</code> (if there is a single name+date default), or in <code>wrapper_template_defaults_vol</code> (if the name+date default depends on the volume number).
#:* Redirects or further wrapping should be described in <code>wrapper_template</code> as new keys: the value of these keys should be name+date entries in <code>wrapper_template_defaults</code> or <code>wrapper_template_defaults_vol</code>.
#:* If there is no sensible default name or date (e.g., {{tl|Cite ODNB}}), you can use an empty string <code><nowiki>''</nowiki></code> for the default.
# Wrapper template produces unusual short footnotes (e.g. without an author or date)
#:In this case, a Lua pattern that covers all of the CITEREF cases should be added to the <code>wrapper_template_patterns</code> variable. Each entry is a pair of lists: a list of templates that share the Lua pattern(s), and a list of Lua patterns that cover the CITEREFs generated by all of the template.

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |


}}</includeonly><noinclude>
[[Category:Module documentation pages]]
</noinclude>

Module:Footnotes/whitelist/doc - Revision history

imported>Hike395: /* Adding templates to the whitelist */ typo