Template:Para/doc - Revision history

Sware at 11:57, 18 June 2023

2023-06-18T11:57:17Z

← Older revision		Revision as of 11:57, 18 June 2023
Line 1:		Line 1:
	{{documentation subpage}}		{{documentation subpage}}
	<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->		<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

	== Usage ==		== Usage ==
	This template simply displays a parameter name between a vertical line and an equal sign, as is seen in [[wikt:Wiktionary:Templates\|template]] calls. (This is useful in template documentation and in talk page discussions of templates.)		This template simply displays a parameter name between a vertical line and an equal sign, as is seen in [[wikt:Wiktionary:Templates\|template]] calls. (This is useful in template documentation and in talk page discussions of templates.)

Sware at 11:56, 18 June 2023

2023-06-18T11:56:43Z

← Older revision		Revision as of 11:56, 18 June 2023
Line 1:		Line 1:
	{{~~Documentation~~ subpage}}		{{documentation subpage}}
	<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->		<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

	== Usage ==		== Usage ==
	This template is ~~for giving examples of~~ [[~~Wikipedia~~:~~Template messages~~\|template]] ~~parameter source code~~ (useful in template documentation and talk page discussions of template ~~code). It must have one or two~~ parameters ~~itself. The first~~ is the name of the ~~example~~ parameter ~~to display (this may be~~ ''~~empty'', but it '''must''' be~~ ''present~~''), and the second (optional) one is~~ a value for the ~~first example~~ parameter~~, or (if the first~~ {{~~tlx~~\|para}} parameter is ~~empty) an unnamed example~~ parameter.		This template simply displays a parameter name between a vertical line and an equal sign, as is seen in [[wikt:Wiktionary:Templates\|template]] calls. (This is useful in template documentation and in talk page discussions of templates.)

			===Parameters===
			This template takes the following parameters:
			*{{para\|1\|\|''may be empty'' if second parameter is present}}: the name of the parameter
			*{{para\|2\|\|''optional'' if first parameter is present}}: a corresponding value for the parameter
			*{{para\|3\|opt=1}}: additional usage text
			*{{para\|req\|1}}: indicate that the parameter is required
			*{{para\|opt\|1}}: indicate that the parameter is optional

	===Examples===		===Examples===
	#~~  ~~{{~~tlx~~\|para\|name}}		# {{temp\|para\|name}}
	#:~~renders as~~		#: Result: {{para\|name}}
	#:{{para\|name}}		# {{temp\|para\|name\|req=1}}
	#~~  ~~{{~~tlx~~\|para\|~~title~~\|~~<var>book title</var>~~}}		#: Result: {{para\|name\|req=1}}
	#:~~renders as~~		# {{temp\|para\|name\|opt=1}}
	#:{{para\|title\|<var>book title</var>}}		#: Result: {{para\|name\|opt=1}}
	#~~  ~~{{~~tlx\|~~para\|~~3=section~~\|2=<~~span style="font-size: 1pt;"~~>~~ ~~</~~span~~>}}		# {{temp\|para\|opt\|1}}
	#~~:renders as~~		#: Result: {{para\|opt\|1}}
	#:{{para\|\|section}}		# {{temp\|para\|title\|<nowiki><var>book title</var></nowiki>}}
	~~#:(~~for unnamed parameters ~~in the example code~~; note the empty first parameter in the ~~{{tlx\|para}}~~ template)		#: Result: {{para\|title\|<var>book title</var>}}
	#~~  ~~{{~~tlx~~\|para\|~~<~~var~~>~~parameter~~<~~/var~~>~~\|~~<~~var~~>~~value~~<~~/var~~>~~}}		# {{temp\|para\|\|section}}
	#:~~renders as~~		#: Result: {{para\|\|section}}. This is useful for referring to values of unnamed parameters; note the empty first parameter in the template call.
	#:{{para\|<var>parameter</var>\|<var>value</var>}}		# {{temp\|para\|<nowiki><var>parameter</var></nowiki>\|<nowiki><var>value</var></nowiki>}}
			#: Result: {{para\|<var>parameter</var>\|<var>value</var>}}
	~~When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <tt>~~<nowiki>~~<var>value</var>~~</nowiki>~~</tt> (appearance as in example~~ 2~~), and the same should be done for non-literal, example parameters (as in example 4).~~		# {{temp\|para\|=\|foo}}
			#: Result: {{para\|=\|foo}}
			# {{temp\|para\|2\|\|<nowiki>''optional'' if first parameter is present</nowiki>}}
			#: Result: {{para\|2\|\|''optional'' if first parameter is present}}

			When using literal, pre-specified values, simply provide the value (appearance as in example 6). When illustrating hypothetical, variable or user-definable values, use <code><var>value</var></code> (appearance as in example 5), and the same should be done for non-literal, example parameters (as in example 7).
	== See also ==		== See also ==
	* [[Template:~~Tlx~~]] – for providing examples of entire-template code with included parameters		* [[Template:tlx]] – for providing examples of entire-template code with included parameters
	<noinclude>		<noinclude>[[Category:Templates]][[Category:Template documentation]]</noinclude>
	[[Category:Templates]][[Category:Template documentation]]</noinclude>

Waahlis: Created page with "{{Documentation subpage}} == Usage == This template is for giving examples of [[Wikipedia:Template me..."

2012-11-11T22:25:28Z

Created page with "{{Documentation subpage}}  == Usage == This template is for giving examples of [[Wikipedia:Template me..."

New page

{{Documentation subpage}}


== Usage ==
This template is for giving examples of [[Wikipedia:Template messages|template]] parameter source code (useful in template documentation and talk page discussions of template code). It must have one or two parameters itself. The first is the name of the example parameter to display (this may be ''empty'', but it '''must''' be ''present''), and the second (optional) one is a value for the first example parameter, or (if the first {{tlx|para}} parameter is empty) an unnamed example parameter.

===Examples===
#  {{tlx|para|name}}
#:renders as
#:{{para|name}}
#  {{tlx|para|title|<var>book title</var>}}
#:renders as
#:{{para|title|<var>book title</var>}}
#  {{tlx|para|3=section|2=<span style="font-size: 1pt;"> </span>}}
#:renders as
#:{{para||section}}
#:(for unnamed parameters in the example code; note the empty first parameter in the {{tlx|para}} template)
#  {{tlx|para|<var>parameter</var>|<var>value</var>}}
#:renders as
#:{{para|<var>parameter</var>|<var>value</var>}}

When using literal, pre-specified values, simply provide the value (appearance as in example 3). When illustrating hypothetical, variable or user-definable values, use <tt><nowiki><var>value</var></nowiki></tt> (appearance as in example 2), and the same should be done for non-literal, example parameters (as in example 4).

== See also ==
* [[Template:Tlx]] – for providing examples of entire-template code with included parameters
<noinclude>
[[Category:Templates]][[Category:Template documentation]]</noinclude>