Template:Refideas/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

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.

The syntax is as follows:

{{Refideas
| (reference1)
| (reference2)
...
}}

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:

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

produces:

There is also a "comment" parameter. For example:

{{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.
}}

produces:

URLs containing equals signs

When an equals sign appears in an unnamed parameter, the template treats everything before the equals sign as a parameter name. Use |1= (and |2=, etc.) before the parameter value if the text contains an equals sign (such as in a URL):

{{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
}}

produces:

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:

{{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.
}}

produces:

Already-used free resources can also be included in a separate section, by adding them with the parameter "u#" rather than "f#". For example:

{{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.
}}

produces:

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 – meaning if there are a lot of entries, it can take up a lot of space on the page. The parameter |state= can be used in this case.

For example:

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

}}

produces:

Article edit notices

Since November 2023, {{Refideas editnotice}} is automatically added to articles which have {{Refideas}} on their talk page. Further information regarding its implementation can be found here and here.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Refideas in articles based on its TemplateData.

TemplateData for Refideas

<templatedata> { "params": { "1": { "label": "Reference 1", "description": "A reference that could be used to expand this article", "type": "line", "suggested": true }, "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" }, "state": { "description": "Can be used to collapse or shorten the banner", "suggestedvalues": [ "collapsed ", "plain" ] }, "comment": { "description": "Comment to append to the end of the banner", "type": "string" }, "f1": { "label": "Free reference 1", "description": "A free content reference that is not currently used in the article, but could be", "type": "line" }, "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" }, "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" } </templatedata>

See also