Module:Footnotes/whitelist/doc

This is a documentation subpage for Module:Footnotes/whitelist.
It may contain usage information, categories and other content that is not part of the original module page.

This Lua module is used on approximately 234,000 pages.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This page is a formatted list of anchor IDs and associated citation wrapper-templates. Because of technical limitations, short-cite templates, via Module:Footnotes, will emit 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-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 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 whitelist variable, with a key of the form CITEREFNameDate 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 whitelist{}.
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 wrapper_template 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 wrapper_template_defaults (if there is a single name+date default), or in wrapper_template_defaults_vol (if the name+date default depends on the volume number).
- Redirects or further wrapping should be described in wrapper_template as new keys: the value of these keys should be name+date entries in wrapper_template_defaults or wrapper_template_defaults_vol.
- If there is no sensible default name or date (e.g., {{Cite ODNB}}), you can use an empty string '' 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 wrapper_template_patterns 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.