View source for Template:Physics particle/doc

{{documentation subpage}}
{{COinS safe|n}}
== Purpose ==
Template for creating symbols for physics particles.

== Arguments ==

:'''1''' The main symbol character(s) for the particle

Named arguments:
:'''TL'''  = What goes into the top left corner (optional)
:'''BL'''  = What goes into the bottom left corner (optional)
:'''TR'''  = What goes into the top right corner (optional)
:'''BR'''  = What goes into the bottom right corner (optional)
:'''anti''' = yes &ndash; this puts a bar over the symbol
:'''link''' = Page to which the symbol should link
Deprecated:
:''BLc'' = ''Originally used to supply the count of characters in BL argument.''
:''BRc'' = ''Originally used to supply the count of characters in BR argument.''

Here's a diagram:

:{{huge|{{Physics particle|anti=yes|X|TR=TR|BR=BR|BRc=2.5|TL=TL|BL=BL|BLc=2}}}}

== Examples ==
[[Template:Subatomic particle]] uses this template to display particles, e.g.:

<code><nowiki>{{Subatomic particle|link=yes|Electron}}</nowiki></code> → {{Subatomic particle|link=yes|Electron}} is the same as
:<code><nowiki>{{Physics particle|e|TR=&minus;|link=Electron}}</nowiki></code> &rarr; {{Physics particle|e|TR=&minus;|link=Electron}} (an [[electron]])
<code><nowiki>{{Subatomic particle|Strange antib0}}</nowiki></code> → {{Subatomic particle|Strange antib0}} is the same as
:<code><nowiki>{{Physics particle|anti=yes|B|TR=0|BR=s|BRc=1}}</nowiki></code> &rarr; {{Physics particle|anti=yes|B|TR=0|BR=s|BRc=1}} (a [[List of mesons|meson]])

The templates in [[:Category:Nuclide templates]] use this template to display nuclides, e.g.:

<code><nowiki>{{ComplexNuclide|deuterium|link=yes}}</nowiki></code> → {{ComplexNuclide|deuterium|link=yes}} is the same as
:<code><nowiki>{{Physics particle|D|TL=2|BL=1|BR=1|link=deuterium}}</nowiki></code> &rarr; {{Physics particle|D|TL=2|BL=1|BR=1|link=deuterium}}

==Template data==
{{template data header}}

<includeonly>{{Sandbox other||
[[Category:Wikipedia formatting templates|{{PAGENAME}}]]
[[Category:Physics formatting templates]]
[[Category:Nuclide templates|P]]
}}</includeonly>
<templatedata>
{
	"params": {
		"1": {
			"label": "Particle symbol",
			"description": "The main symbol character(s) for the particle",
			"type": "string",
			"required": true
		},
		"link": {
			"label": "Wikilink",
			"description": "Page to which the symbol will link",
			"type": "wiki-page-name"
		},
		"TL": {
			"label": "Top left",
			"description": "What goes into the top left corner"
		},
		"BL": {
			"label": "Bottom left",
			"description": "What goes into the bottom left corner"
		},
		"anti": {
			"label": "Anti",
			"description": "Adds a bar over the symbol when set to 'yes'",
			"type": "string"
		},
		"TR": {
			"label": "Top right",
			"description": "What goes into the top right corner"
		},
		"BR": {
			"label": "Bottom right",
			"description": "What goes into the bottom right corner"
		},
		"texhtml": {
			"label": "texhtml",
			"description": "Adds the texhtml CSS class defined at MediaWiki:Common.css",
			"type": "string"
		},
		"class": {
			"label": "CSS class",
			"description": "Adds arbitrary CSS class(es) to wrapping <span> tag",
			"type": "string"
		}
	},
	"paramOrder": [
		"1",
		"TL",
		"BL",
		"TR",
		"BR",
		"anti",
		"link",
		"texhtml",
		"class"
	],
	"description": "Template for creating symbols for physics particles. "
}
</templatedata>