Module:Footnotes/whitelist/doc - Revision history

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

2024-12-02T15:58:05Z

Adding templates to the whitelist: typo

← Previous revision		Revision as of 15:58, 2 December 2024
Line 5:		Line 5:
	There are three whitelist mechanisms for templates: each one is appropriate for different template behaviors:		There are three whitelist mechanisms for templates: each one is appropriate for different template behaviors:
	# <b>Wrapper template produces small number of different references, whose name and date is suitable for short footnotes, name and date not overriden</b>		# <b>Wrapper template produces small number of different references, whose name and date is suitable for short footnotes, name and date not overriden</b>
	#: 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 ~~CITREF~~.		#: 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".		#:* 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>.		#:*[[Module:Footnotes/whitelist/sort]] is a tool to aid the maintenance of <code>whitelist{}</code>.

Hike395: /* Adding templates to the whitelist */ nowiki

2024-12-02T15:57:12Z

Adding templates to the whitelist: nowiki

← Previous revision		Revision as of 15:57, 2 December 2024
Line 12:		Line 12:
	#:* 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).		#:* 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>.		#:* 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>''</code> for the default.		#:* 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.
	# <b>Wrapper template produces unusual short footnotes (e.g. without an author or date)</b>		# <b>Wrapper template produces unusual short footnotes (e.g. without an author or date)</b>
	#: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.		#: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.

Hike395: /* Adding templates to the whitelist */ empty string for defaults are ok

2024-12-02T15:56:36Z

Adding templates to the whitelist: empty string for defaults are ok

← Previous revision		Revision as of 15:56, 2 December 2024
Line 12:		Line 12:
	#:* 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).		#:* 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>.		#:* 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>''</code> for the default.
	# <b>Wrapper template produces unusual short footnotes (e.g. without an author or date)</b>		# <b>Wrapper template produces unusual short footnotes (e.g. without an author or date)</b>
	#: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.		#: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.

Hike395: explanation of the three mechanisms for whitelisting, which one to choose, and how to add an additional entry

2024-12-02T15:17:59Z

explanation of the three mechanisms for whitelisting, which one to choose, and how to add an additional entry

@@ Line 2: / Line 2: @@
 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.
 <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 <!-- Categories below this line, please; interwikis at Wikidata -->

Warudo: Added the page to :Category:Module documentation pages

2024-08-29T21:26:54Z

Added the page to Category:Module documentation pages

← Previous revision		Revision as of 21:26, 29 August 2024
Line 8:		Line 8:
	<!-- Categories below this line, please; interwikis at Wikidata -->		<!-- Categories below this line, please; interwikis at Wikidata -->

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

Jonesey95: ce

2022-05-22T13:35:13Z

← Previous revision		Revision as of 13:35, 22 May 2022
Line 2:		Line 2:
	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.		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.

	Do not include disambiguation letters in whitelist entries. In other words, use "CITEREFSmith2018" even when the cite template generates "CITEREFSmith2018a".		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>.		[[Module:Footnotes/whitelist/sort]] is a tool to aid the maintenance of <code>whitelist{}</code>.

Jonesey95: note about dab letters

2022-05-22T13:34:56Z

note about dab letters

← Previous revision		Revision as of 13:34, 22 May 2022
Line 1:		Line 1:
	{{High-risk}}		{{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.		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.

			Do not include disambiguation letters in whitelist entries. In other words, use "CITEREFSmith2018" even when the cite template generates "CITEREFSmith2018a".

	[[Module:Footnotes/whitelist/sort]] is a tool to aid the maintenance of <code>whitelist{}</code>.		[[Module:Footnotes/whitelist/sort]] is a tool to aid the maintenance of <code>whitelist{}</code>.

Trappist the monk: +sorter;

2020-07-21T22:24:45Z

+sorter;

← Previous revision		Revision as of 22:24, 21 July 2020
Line 2:		Line 2:
	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.		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.

			[[Module:Footnotes/whitelist/sort]] is a tool to aid the maintenance of <code>whitelist{}</code>.
	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \| \|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \| \|
	<!-- Categories below this line, please; interwikis at Wikidata -->		<!-- Categories below this line, please; interwikis at Wikidata -->

Christian75: {{High-risk}}

2020-05-31T08:52:10Z

← Previous revision		Revision as of 08:52, 31 May 2020
Line 1:		Line 1:
			{{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.		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.

Trappist the monk: ce;

2020-04-02T12:11:33Z

ce;

← Previous revision		Revision as of 12:11, 2 April 2020
Line 1:		Line 1:
			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.
	<!--{{tl\|Module rating \| Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call }}-->
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
	This page is a formatted list of templates that contain {{para\|ref\|harv}} and similar invocations that lead to false positive errors in {{cl\|Harv and Sfn template errors}}. To prevent a template from causing false positive errors, add the template and its matching CITEREF to the list on this page.

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