View source for Template:Refideas/doc

{{Documentation subpage}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
{{High-use}}
{{template redirect|Suggested sources|Refideas-nonotice|msg=Redirects do not trigger editnotices}} 
{{tsh|ri|msg=Shortcuts do not<br> trigger editnotices}}
{{lua|Module:Message box}}

This template provides a way to tell other editors about potentially useful references that could be used to improve the article.

== Usage ==
This template should be put on talk pages, and is used to list up to 21 references which may be useful for an article but either aren't yet included in the article or which could be used more. It will cause an editnotice to appear upon editing the article to remind editors of the reference ideas. 

The syntax is as follows:
<syntaxhighlight lang="wikitext">
{{Refideas
| (reference1)
| (reference2)
...
}}
</syntaxhighlight>

Each "reference#" should be replaced by the information on a reference. The template currently accepts up to 21 such reference parameters. Whitespace (including carriage returns) before or after the pipes don't matter, so you can have each reference on a separate line if wanted (as in the sample below).

For example:
<syntaxhighlight lang="wikitext">
{{Refideas
| [https://www.example.com/article News article]. Example.com.
| [https://www.example.com/article2 Another news article]. Example.com.
}}
</syntaxhighlight>

produces:
{{Refideas
| [https://www.example.com/article News article]. Example.com.
| [https://www.example.com/article2 Another news article]. Example.com.
}}

There is also a "comment" parameter. For example:
<syntaxhighlight lang="wikitext">
{{Refideas
| [https://www.example.com/article News article]. Example.com.
| [https://www.example.com/article2 Another news article]. Example.com.
| comment = These articles have good quotations.
}}
</syntaxhighlight>

produces:
{{Refideas
| [https://www.example.com/article News article]. Example.com.
| [https://www.example.com/article2 Another news article]. Example.com.
| comment = These articles have good quotations.
}}

===URLs containing equals signs===
When one or more equals signs appear in an unnamed parameter, the template treats everything before the ''first'' equals sign as a parameter name. Use {{para|1}} (and {{para|2}}, etc.) before the parameter value if the text contains any equals signs (such as in a URL):

<syntaxhighlight lang="wikitext">
{{Refideas 
| 1 = M. M. Loubser, Towards a Theory of Extinctive Prescription, 105 S. AFRICAN L.J. 34, 53 (1988). https://heinonline.org/HOL/P?h=hein.journals/tulr85&i=3
}}
</syntaxhighlight>

produces:
{{Refideas 
| 1 = M. M. Loubser, Towards a Theory of Extinctive Prescription, 105 S. AFRICAN L.J. 34, 53 (1988). https://heinonline.org/HOL/P?h=hein.journals/tulr85&i=3
}}

Note how we by adding "1=" allow the refidea to be interpreted correctly, including the equals signs in the URL.

=== Free sources ===
Sources which have information available as [[free content]] which is compatible with Wikipedia or released into the [[public domain]] should be listed separately because such content can be directly incorporated into articles, rather than being used as footnote references. Each reference to a free or public domain source can be added using the normal parameters except with an "f" before the parameter number. For example:
<syntaxhighlight lang="wikitext">
{{Refideas
| [https://www.example.com/article News article]. Example.com.
| [https://www.example.com/article2 Another news article]. Example.com.
| f1 = [https://www.example.com/cc-by-sa-page Some free source]. CC BY-SA 3.0.
}}
</syntaxhighlight>

produces:
{{Refideas
| [https://www.example.com/article News article]. Example.com.
| [https://www.example.com/article2 Another news article]. Example.com.
| f1 = [https://www.example.com/cc-by-sa-page Some free source]. CC BY-SA 3.0.
}}

Already-used free resources can also be included in a separate section, by adding them with the parameter "u#" rather than "f#". For example:
<syntaxhighlight lang="wikitext">
{{Refideas
| f1 = [https://www.example.com/cc-by-sa-page Some free source]. CC BY-SA 3.0.
| u1 = [https://www.example.com/cc-by-sa-page2 Another free source].
| 1 = [https://www.example.com/article News article]. Example.com.
}}
</syntaxhighlight>

produces:
{{Refideas
| f1 = [https://www.example.com/cc-by-sa-page Some free source]. CC BY-SA 3.0.
| u1 = [https://www.example.com/cc-by-sa-page2 Another free source].
| 1 = [https://www.example.com/article News article]. Example.com.
}}

Whenever a free source is listed, a category link appears below the image to help navigate to [[:Category:Articles which could have free content incorporated from elsewhere]].

===Collapsing the box===
By default, this box will be in an uncollapsed state{{snd}}meaning if there are a lot of entries, it can take up a lot of space on the page. The parameter {{para|state}} can be used in this case. 

For example:

<syntaxhighlight lang="wikitext">
{{Refideas
| state = collapsed
| [https://www.example.com/article News article]. Example.com.
| [https://www.example.com/article2 Another news article]. Example.com.

}}
</syntaxhighlight>

produces:

{{Refideas
| state = collapsed
| [https://www.example.com/article News article]. Example.com.
| [https://www.example.com/article2 Another news article]. Example.com.
}}

==Article edit notices==
Since November 2023, {{tl|Refideas editnotice}} is automatically added to articles which have {{tl|Refideas}} on their talk page. Further information regarding its implementation can be found [[Template talk:Refideas editnotice|here]] and [[Wikipedia:Village pump (technical)/Archive 209#Implementation of Template:Refideas editnotice|here]].

===Turning off the edit notice===
To turn off the edit notice, change <code><nowiki>{{Refideas|...}}</nowiki></code> to <code><nowiki>{{Refideas-nonotice|...}}</nowiki></code>.

This works because the edit notice only appears for the {{tl|Refideas}} template, not any of its alternative names, such as {{tl|Suggested sources}}. The redirect {{tl|Refideas-nonotice}} is offered specifically for the use case where you want to turn off the editnotice, and signal this to fellow editors.

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Reference 1",
			"description": "A reference that could be used to expand this article",
			"type": "line",
			"suggested": true,
			"example": "[https://www.example.com/article News article]. Example.com."
		},
		"2": {
			"label": "Reference 2",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"3": {
			"label": "Reference 3",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"4": {
			"label": "Reference 4",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"5": {
			"label": "Reference 5",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"6": {
			"label": "Reference 6",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"7": {
			"label": "Reference 7",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"8": {
			"label": "Reference 8",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"9": {
			"label": "Reference 9",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"10": {
			"label": "Reference 10",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"11": {
			"label": "Reference 11",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"12": {
			"label": "Reference 12",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"13": {
			"label": "Reference 13",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"14": {
			"label": "Reference 14",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"15": {
			"label": "Reference 15",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"16": {
			"label": "Reference 16",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"17": {
			"label": "Reference 17",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"18": {
			"label": "Reference 18",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"19": {
			"label": "Reference 19",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"20": {
			"label": "Reference 20",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"21": {
			"label": "Reference 21",
			"description": "A reference that could be used to expand this article",
			"type": "line"
		},
		"small": {
			"description": "If true, makes the banner smaller",
			"type": "boolean",
			"default": "false",
			"label": "Small"
		},
		"state": {
			"description": "Can be used to collapse or shorten the banner",
			"suggestedvalues": [
				"collapsed ",
				"plain"
			],
			"label": "State",
			"type": "string",
			"default": "plain"
		},
		"comment": {
			"description": "Comment to append to the end of the banner",
			"type": "string",
			"label": "Comment",
			"example": "These articles have good quotations."
		},
		"f1": {
			"label": "Free reference 1",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line",
			"example": "[https://www.example.com/cc-by-sa-page Some free source]. CC BY-SA 3.0."
		},
		"f2": {
			"label": "Free reference 1",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f3": {
			"label": "Free reference 2",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f4": {
			"label": "Free reference 3",
			"description": "A [[free contente]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f5": {
			"label": "Free reference 4",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f6": {
			"label": "Free reference 5",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f7": {
			"label": "Free reference 6",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f8": {
			"label": "Free reference 7",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f9": {
			"label": "Free reference 8",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f10": {
			"label": "Free reference 9",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f11": {
			"label": "Free reference 10",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f12": {
			"label": "Free reference 11",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f13": {
			"label": "Free reference 12",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f14": {
			"label": "Free reference 13",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f15": {
			"label": "Free reference 14",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f16": {
			"label": "Free reference 15",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f17": {
			"label": "Free reference 16",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f18": {
			"label": "Free reference 17",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f19": {
			"label": "Free reference 18",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f21": {
			"label": "Free reference 19",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"f20": {
			"label": "Free reference 20",
			"description": "A [[free content]] reference that is not currently used in the article, but could be",
			"type": "line"
		},
		"u1": {
			"label": "Used free reference 1",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line",
			"example": "[https://www.example.com/cc-by-sa-page Some free source]. CC BY-SA 3.0."
		},
		"u2": {
			"label": "Used free reference 2",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u3": {
			"label": "Used free reference 3",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u4": {
			"label": "Used free reference 4",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u5": {
			"label": "Used free reference 5",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u6": {
			"label": "Used free reference 6",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u7": {
			"label": "Used free reference 7",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u8": {
			"label": "Used free reference 8",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u9": {
			"label": "Used free reference 9",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u10": {
			"label": "Used free reference 10",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u11": {
			"label": "Used free reference 11",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u12": {
			"label": "Used free reference 12",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u13": {
			"label": "Used free reference 13",
			"description": "A [[free content] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u14": {
			"label": "Used free reference 14",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u15": {
			"label": "Used free reference 15",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u16": {
			"label": "Used free reference 16",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u17": {
			"label": "Used free reference 17",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u18": {
			"label": "Used free reference 18",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u19": {
			"label": "Used free reference 19",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u20": {
			"label": "Used free reference 20",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		},
		"u21": {
			"label": "Used free reference 21",
			"description": "A [[free content]] reference already used in the article, but could still be used to expand it.",
			"type": "line"
		}
	},
	"format": "block",
	"description": "A talk page banner that lists references that could be used to expand the article",
	"paramOrder": [
		"small",
		"state",
		"comment",
		"1",
		"2",
		"3",
		"4",
		"5",
		"6",
		"7",
		"8",
		"9",
		"10",
		"11",
		"12",
		"13",
		"14",
		"15",
		"16",
		"17",
		"18",
		"19",
		"20",
		"21",
		"f1",
		"f2",
		"f3",
		"f4",
		"f5",
		"f6",
		"f7",
		"f8",
		"f9",
		"f10",
		"f11",
		"f12",
		"f13",
		"f14",
		"f15",
		"f16",
		"f17",
		"f18",
		"f19",
		"f21",
		"f20",
		"u1",
		"u2",
		"u3",
		"u4",
		"u5",
		"u6",
		"u7",
		"u8",
		"u9",
		"u10",
		"u11",
		"u12",
		"u13",
		"u14",
		"u15",
		"u16",
		"u17",
		"u18",
		"u19",
		"u20",
		"u21"
	]
}
</templatedata>

== See also ==
* [[:Category:Articles which could have free content incorporated from elsewhere]]

<includeonly>{{Sandbox other||
<!-- Categories go here and interwikis go in Wikidata. -->
[[Category:Non-subject-matter-related article-talk header templates]]
[[Category:External link templates]]
}}</includeonly>