From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
Template documentationview · edit · history · purge ]
This documentation is transcluded from Template:Refbegin/doc.

No description yet available.


{{refbegin |colwidth= }}

I have suggested this template as an option for usage in the second and third of three options for citing notes on a wikipedia article. The original discussion can be found here. Below is a copy of the 3 suggested options...

Option 1 (only specific references) - see w:The Rule

== References ==


Option 2 (only general references) - see w:National Publications

== References ==

* general reference 1
* general reference 2

Option 3 (both specific and general references) - see w:Elephant

== References ==


* general reference 1
* general reference 2

Template parameters

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

Wikipedia's help about TemplateDataCommons-specific information

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

column count1

The number of columns the references appear in. This parameter is deprecated, as it doesn’t scale well on narrow screens; specify the column width instead.

column widthcolwidth

The minimal width of the reference list columns. Specify the unit as well, e.g. “15em” or “400px”. Prefer the “em” unit, as that usually provides better layout when the reader alters the font size (e.g. increases because of eye problems).


Additional information

The template is intended to be used in the following namespaces: no namespace specified

The template is intended to be used by the following user groups: no user group specified

See also


This template is not intended to be localized.