Template:Var/doc - Revision history

Casiope at 16:05, 21 July 2020

2020-07-21T16:05:35Z

← Older revision		Revision as of 16:05, 21 July 2020
Line 1:		Line 1:
	The {{tl\|var}} ~~template~~ facilitates the displaying of variable names (in mathematics, computer source code, wikimarkup in template documentation, metasyntactic variables, etc.) with the semantically correct {{tag\|var}} tags, which also renders the variable in italics, as is customary. This method is preferred to simply italicizing for many reasons, including accessibility, separation of presentation and content, semantic Web, and metadata; In XHTML and HTML, the {{tag\|var\|o}} element has semantic meaning, while simple italicization does not. This template provides a tiny hint of kerning to compensate for the italicization and enhance readability.		The template {{tlg\|var}} facilitates the displaying of variable names (in mathematics, computer source code, wikimarkup in template documentation, metasyntactic variables, etc.) with the semantically correct {{tag\|var}} tags, which also renders the variable in italics, as is customary. This method is preferred to simply italicizing for many reasons, including accessibility, separation of presentation and content, semantic Web, and metadata; In XHTML and HTML, the {{tag\|var\|o}} element has semantic meaning, while simple italicization does not. This template provides a tiny hint of kerning to compensate for the italicization and enhance readability.

	“Variable” in this sense may include arbitrary or unknown names or terms, examples of human input, arithmetical variables in equations, etc. This template (and the underlying XHTML) are generally not used if MediaWiki’s {{tag\|math}} tags (or any other stand‐alone mathematical markup) are being used.		“Variable” in this sense may include arbitrary or unknown names or terms, examples of human input, arithmetical variables in equations, etc. This template (and the underlying XHTML) are generally not used if MediaWiki’s {{tag\|math}} tags (or any other stand‐alone mathematical markup) are being used.
Line 5:		Line 5:
	== Usage ==		== Usage ==

	: {{~~tlc~~\|var\|username}}		: {{tlg\|code=yes\|nolink=yes\|var\|username}}
	Outputs the following HTML:		Outputs the following HTML:
	: {{tag\|var\|content=username}}		: {{tag\|var\|content=username}}
Line 19:		Line 19:
	! Renders as		! Renders as
	\|-		\|-
	\| <nowiki>The HTML code {{tag\|var\|content=username}} renders as {{var\|username}}</nowiki~~><br~~>		\| <nowiki>The HTML code {{tag\|var\|content=username}} renders as {{var\|username}}</nowiki>
	\| The HTML code {{tag\|var\|content=username}} renders as {{var\|username}}		\| The HTML code {{tag\|var\|content=username}} renders as {{var\|username}}
	\|-		\|-

Casiope: /* Usage */

2020-07-11T13:47:59Z

Usage

← Older revision		Revision as of 13:47, 11 July 2020
Line 5:		Line 5:
	== Usage ==		== Usage ==

	: {{~~tlx~~\|var\|username}}		: {{tlc\|var\|username}}
	Outputs the following HTML:		Outputs the following HTML:
	: {{tag\|var\|content=username}}		: {{tag\|var\|content=username}}

Casiope at 13:47, 11 July 2020

2020-07-11T13:47:43Z

← Older revision		Revision as of 13:47, 11 July 2020
Line 1:		Line 1:
	~~== Purpose ==~~		The {{tl\|var}} template facilitates the displaying of variable names (in mathematics, computer source code, wikimarkup in template documentation, metasyntactic variables, etc.) with the semantically correct {{tag\|var}} tags, which also renders the variable in italics, as is customary. This method is preferred to simply italicizing for many reasons, including accessibility, separation of presentation and content, semantic Web, and metadata; In XHTML and HTML, the {{tag\|var\|o}} element has semantic meaning, while simple italicization does not. This template provides a tiny hint of kerning to compensate for the italicization and enhance readability.

	~~This~~ template ~~is to help facilitate~~ the displaying of variable names (in mathematics, computer source code, wikimarkup in template documentation, metasyntactic variables, etc.) with the semantically correct {{tag\|var}} tags, which also renders the variable in italics, as is customary. This method is preferred to simply italicizing for many reasons, including accessibility, separation of presentation and content, semantic Web, and metadata; In XHTML and HTML, the {{tag\|var\|o}} element has semantic meaning, while simple italicization does not. This template provides a tiny hint of kerning to compensate for the italicization and enhance readability.

	“Variable” in this sense may include arbitrary or unknown names or terms, examples of human input, arithmetical variables in equations, etc. This template (and the underlying XHTML) are generally not used if MediaWiki’s {{tag\|math}} tags (or any other stand‐alone mathematical markup) are being used.		“Variable” in this sense may include arbitrary or unknown names or terms, examples of human input, arithmetical variables in equations, etc. This template (and the underlying XHTML) are generally not used if MediaWiki’s {{tag\|math}} tags (or any other stand‐alone mathematical markup) are being used.
Line 34:		Line 32:
	\|}		\|}

	[[Category:Templates]]		[[Category:Templates]][[Category:Semantic markup templates]][[Category:Templates documentation]]
	[[Category:Templates documentation]]

Casiope: /* Examples */

2020-07-10T23:33:20Z

Examples

← Older revision		Revision as of 23:33, 10 July 2020
Line 21:		Line 21:
	! Renders as		! Renders as
	\|-		\|-
	\| <nowiki>The HTML code~~:</nowiki><br><nowiki>:~~ {{tag\|var\|content=username}}~~</nowiki><br>~~		\| <nowiki>The HTML code {{tag\|var\|content=username}} renders as {{var\|username}}</nowiki><br>
	~~<nowiki>~~renders as~~:</nowiki><br><nowiki>:~~ {{var\|username}}</nowiki><br>		\| The HTML code {{tag\|var\|content=username}} renders as {{var\|username}}
	\| The HTML code:
	: {{tag\|var\|content=username}}~~<br>~~
	~~Renders~~ as~~:<br>~~
	: {{var\|username}}
	\|-		\|-
	\| <nowiki>The commandline should read: {{samp\|%}} {{kbd\|1=ssh {{var\|hostname}}}}~~<br>(~~where {{var\|hostname}} is the IP address ~~or ..~~.~~)<br>~~If it is correct, press {{key press\|Enter}}.</nowiki>		\| <nowiki>The commandline should read {{samp\|%}} {{kbd\|1=ssh {{var\|hostname}}}} where {{var\|hostname}} is the IP address. If it is correct, press {{key press\|Enter}}.</nowiki>
	\| The commandline should read: {{samp\|%}} {{kbd\|1=ssh {{var\|hostname}}}}~~<br>(~~where {{var\|hostname}} is the IP address ~~or ..~~.~~)<br>~~If it is correct, press {{key press\|Enter}}.		\| The commandline should read {{samp\|%}} {{kbd\|1=ssh {{var\|hostname}}}} where {{var\|hostname}} is the IP address. If it is correct, press {{key press\|Enter}}.
	\|-		\|-
	\| <nowiki>in this equation, let {{var\|x}}{{=}}1 and {{var\|y}}{{=}}120.</nowiki>		\| <nowiki>In this equation, let {{var\|x}} = 1 and {{var\|y}} = 120.</nowiki>
	\| in this equation, let {{var\|x}} {{=}} 1 and {{var\|y}} {{=}} 120.		\| In this equation, let {{var\|x}} = 1 and {{var\|y}} = 120.
	\|-		\|-
	\| <nowiki>{{para\|accessdate\|{{var\|todays_date}}}}</nowiki>		\| <nowiki>{{para\|accessdate\|{{var\|todays_date}}}}</nowiki>

Casiope at 21:15, 10 July 2020

2020-07-10T21:15:49Z

← Older revision		Revision as of 21:15, 10 July 2020
Line 1:		Line 1:
	== Purpose ==		== Purpose ==

	This template is to help facilitate the displaying of variable names (in mathematics, computer source code, wikimarkup in template documentation, metasyntactic variables, etc.) with the ~~[[wikipedia:Semantic HTML\|~~semantically correct]] {{tag\|var}} tags, which also renders the variable in italics, as is customary. This method is preferred to simply italicizing for many reasons, including accessibility, separation of presentation and content, semantic Web, and metadata; In ~~[[wikipedia:~~XHTML]] and ~~[[wikipedia:~~HTML]], the {{tag\|var\|o}} element has semantic meaning, while simple italicization does not. This template provides a tiny hint of ~~[[wikipedia:~~kerning]] to compensate for the italicization and enhance readability.		This template is to help facilitate the displaying of variable names (in mathematics, computer source code, wikimarkup in template documentation, metasyntactic variables, etc.) with the semantically correct {{tag\|var}} tags, which also renders the variable in italics, as is customary. This method is preferred to simply italicizing for many reasons, including accessibility, separation of presentation and content, semantic Web, and metadata; In XHTML and HTML, the {{tag\|var\|o}} element has semantic meaning, while simple italicization does not. This template provides a tiny hint of kerning to compensate for the italicization and enhance readability.

	~~"Variable"~~ in this sense may include arbitrary or unknown names or terms, examples of human input, arithmetical variables in equations, etc. This template (and the underlying XHTML) are generally not used if ~~MediaWiki's~~ {{tag\|math}} tags (or any other ~~stand-alone~~ mathematical markup) are being used.		“Variable” in this sense may include arbitrary or unknown names or terms, examples of human input, arithmetical variables in equations, etc. This template (and the underlying XHTML) are generally not used if MediaWiki’s {{tag\|math}} tags (or any other stand‐alone mathematical markup) are being used.

	== Usage ==		== Usage ==

	: {{tlx\|var\|username}}		: {{tlx\|var\|username}}
	~~outputs~~ the following HTML:		Outputs the following HTML:
	: {{tag\|var\|content=username}}		: {{tag\|var\|content=username}}
	~~which~~ renders as:		Which renders as:
	: {{var\|username}}		: {{var\|username}}

Line 31:		Line 31:
	\| The commandline should read: {{samp\|%}} {{kbd\|1=ssh {{var\|hostname}}}}<br>(where {{var\|hostname}} is the IP address or ...)<br>If it is correct, press {{key press\|Enter}}.		\| The commandline should read: {{samp\|%}} {{kbd\|1=ssh {{var\|hostname}}}}<br>(where {{var\|hostname}} is the IP address or ...)<br>If it is correct, press {{key press\|Enter}}.
	\|-		\|-
	\| <nowiki>in this equation, let {{var\|x}}{{=}}1 and {{var\|y}}{{=}}120..</nowiki>		\| <nowiki>in this equation, let {{var\|x}}{{=}}1 and {{var\|y}}{{=}}120.</nowiki>
	\| in this equation, let {{var\|x}} {{=}} 1 and {{var\|y}} {{=}} 120.		\| in this equation, let {{var\|x}} {{=}} 1 and {{var\|y}} {{=}} 120.
	\|-		\|-

Casiope: /* Examples */

2020-07-10T21:13:36Z

Examples

← Older revision		Revision as of 21:13, 10 July 2020
Line 25:		Line 25:
	\| The HTML code:		\| The HTML code:
	: {{tag\|var\|content=username}}<br>		: {{tag\|var\|content=username}}<br>
	~~renders~~ as:<br>		Renders as:<br>
	: {{var\|username}}		: {{var\|username}}
	\|-		\|-
	\| <nowiki>The commandline should read: {{samp\|%}} {{kbd\|1=ssh {{var\|hostname}}}}<br />(where {{var\|hostname}} is the IP address or ...)<br />If it is correct, press ~~<kbd>~~Enter~~</kbd>~~.</nowiki>		\| <nowiki>The commandline should read: {{samp\|%}} {{kbd\|1=ssh {{var\|hostname}}}}<br>(where {{var\|hostname}} is the IP address or ...)<br>If it is correct, press {{key press\|Enter}}.</nowiki>
	\| The commandline should read: {{samp\|%}} {{kbd\|1=ssh {{var\|hostname}}}}<br />(where {{var\|hostname}} is the IP address or ...)<br />If it is correct, press {{key press\|Enter}}.		\| The commandline should read: {{samp\|%}} {{kbd\|1=ssh {{var\|hostname}}}}<br>(where {{var\|hostname}} is the IP address or ...)<br>If it is correct, press {{key press\|Enter}}.
	\|-		\|-
	\| <nowiki>in this equation, let {{var\|x}}{{=}}1 and {{var\|y}}{{=}}120 ...</nowiki>		\| <nowiki>in this equation, let {{var\|x}}{{=}}1 and {{var\|y}}{{=}}120..</nowiki>
	\| in this equation, let {{var\|x}}{{=}}1 and {{var\|y}}{{=}}120 ...		\| in this equation, let {{var\|x}} {{=}} 1 and {{var\|y}} {{=}} 120.
	\|-		\|-
	\| <nowiki>{{para\|accessdate\|{{var\|todays_date}}}}</nowiki>		\| <nowiki>{{para\|accessdate\|{{var\|todays_date}}}}</nowiki>

Casiope at 11:56, 3 July 2019

2019-07-03T11:56:23Z

← Older revision		Revision as of 11:56, 3 July 2019
Line 38:		Line 38:
	\|}		\|}

			[[Category:Templates]]
	[[Category:Templates documentation]]		[[Category:Templates documentation]]

Casiope at 11:37, 3 July 2019

2019-07-03T11:37:59Z

← Older revision		Revision as of 11:37, 3 July 2019
Line 38:		Line 38:
	\|}		\|}

	[[Category:~~Documentation subpages~~]]		[[Category:Templates documentation]]

Casiope at 23:15, 9 June 2019

2019-06-09T23:15:30Z

← Older revision		Revision as of 23:15, 9 June 2019
Line 1:		Line 1:
			== Purpose ==

	This template is to help facilitate the displaying of variable names (in mathematics, computer source code, wikimarkup in template documentation, metasyntactic variables, etc.) with the [[wikipedia:Semantic HTML\|semantically correct]] {{tag\|var}} tags, which also renders the variable in italics, as is customary. This method is preferred to simply italicizing for many reasons, including accessibility, separation of presentation and content, semantic Web, and metadata; In [[wikipedia:XHTML]] and [[wikipedia:HTML]], the {{tag\|var\|o}} element has semantic meaning, while simple italicization does not. This template provides a tiny hint of [[wikipedia:kerning]] to compensate for the italicization and enhance readability.		This template is to help facilitate the displaying of variable names (in mathematics, computer source code, wikimarkup in template documentation, metasyntactic variables, etc.) with the [[wikipedia:Semantic HTML\|semantically correct]] {{tag\|var}} tags, which also renders the variable in italics, as is customary. This method is preferred to simply italicizing for many reasons, including accessibility, separation of presentation and content, semantic Web, and metadata; In [[wikipedia:XHTML]] and [[wikipedia:HTML]], the {{tag\|var\|o}} element has semantic meaning, while simple italicization does not. This template provides a tiny hint of [[wikipedia:kerning]] to compensate for the italicization and enhance readability.

	"Variable" in this sense may include arbitrary or unknown names or terms, examples of human input, arithmetical variables in equations, etc. This template (and the underlying XHTML) are generally not used if MediaWiki's {{tag\|math}} tags (or any other stand-alone mathematical markup) are being used.		"Variable" in this sense may include arbitrary or unknown names or terms, examples of human input, arithmetical variables in equations, etc. This template (and the underlying XHTML) are generally not used if MediaWiki's {{tag\|math}} tags (or any other stand-alone mathematical markup) are being used.

	~~; Example:~~		== Usage ==

	: {{tlx\|var\|username}}		: {{tlx\|var\|username}}
	outputs the following HTML:		outputs the following HTML:
Line 12:		Line 15:
	Note that on the screen or in print, this renders as simple italicization, as does <code><nowiki>''username''</nowiki></code> (using pairs of apostrophes) or {{tag\|i\|content=username}} (using HTML), yet it carries more semantic meaning than either of these methods.		Note that on the screen or in print, this renders as simple italicization, as does <code><nowiki>''username''</nowiki></code> (using pairs of apostrophes) or {{tag\|i\|content=username}} (using HTML), yet it carries more semantic meaning than either of these methods.

	At times, you may wish to use a serif font. This is especially true when attempting to render single-letter variables like "I" (upper-case "i") and "l" (lower-case "L"), since they are nearly indistinguishable (if at all). In such situations, use the {{tlx\|var serif}} template instead of {{tl\|var}}, to make them more distinguishable, like these serif examples: {{var serif\|I}}, {{var serif\|l}}.		== Examples ==

	~~; More examples:~~
	{\|class=wikitable		{\|class=wikitable
	! Markup		! Markup
Line 26:		Line 28:
	: {{var\|username}}		: {{var\|username}}
	\|-		\|-
	\| <nowiki>The commandline should read: % {{kbd\|1=ssh {{var\|hostname}}}}<br />(where {{var\|hostname}} is the IP address or ...)<br />If it is correct, press <kbd>Enter</kbd>.</nowiki>		\| <nowiki>The commandline should read: {{samp\|%}} {{kbd\|1=ssh {{var\|hostname}}}}<br />(where {{var\|hostname}} is the IP address or ...)<br />If it is correct, press <kbd>Enter</kbd>.</nowiki>
	\| The commandline should read: % {{kbd\|1=ssh {{var\|hostname}}}}<br />(where {{var\|hostname}} is the IP address or ...)<br />If it is correct, press {{key press\|Enter}}.		\| The commandline should read: {{samp\|%}} {{kbd\|1=ssh {{var\|hostname}}}}<br />(where {{var\|hostname}} is the IP address or ...)<br />If it is correct, press {{key press\|Enter}}.
	\|-		\|-
	\| <nowiki>in this equation, let {{var\|x}}{{=}}1 and {{var\|y}}{{=}}120 ...</nowiki>		\| <nowiki>in this equation, let {{var\|x}}{{=}}1 and {{var\|y}}{{=}}120 ...</nowiki>

Casiope at 20:25, 9 June 2019

2019-06-09T20:25:02Z

← Older revision		Revision as of 20:25, 9 June 2019
Line 12:		Line 12:
	Note that on the screen or in print, this renders as simple italicization, as does <code><nowiki>''username''</nowiki></code> (using pairs of apostrophes) or {{tag\|i\|content=username}} (using HTML), yet it carries more semantic meaning than either of these methods.		Note that on the screen or in print, this renders as simple italicization, as does <code><nowiki>''username''</nowiki></code> (using pairs of apostrophes) or {{tag\|i\|content=username}} (using HTML), yet it carries more semantic meaning than either of these methods.

	At times, you may wish to use a serif font. This is especially true when attempting to render single-letter variables like "I" (upper-case "i") and "l" (lower-case "L"), since they are nearly indistinguishable (if at all). In such situations, use the {{tlx\|~~varserif~~}} template instead of {{tl\|var}}, to make them more distinguishable, like these serif examples: {{~~varserif~~\|I}}, {{~~varserif~~\|l}}.		At times, you may wish to use a serif font. This is especially true when attempting to render single-letter variables like "I" (upper-case "i") and "l" (lower-case "L"), since they are nearly indistinguishable (if at all). In such situations, use the {{tlx\|var serif}} template instead of {{tl\|var}}, to make them more distinguishable, like these serif examples: {{var serif\|I}}, {{var serif\|l}}.

	; More examples:		; More examples:
			{\|class=wikitable
	~~<div style~~=~~"background:#FFFFFF;">~~		! Markup
	{{Markup		! Renders as
	\| <nowiki>The HTML code:		\|-
	: {{tag\|var\|content=username}}		\| <nowiki>The HTML code:</nowiki><br><nowiki>: {{tag\|var\|content=username}}</nowiki><br>
	renders as:		<nowiki>renders as:</nowiki><br><nowiki>: {{var\|username}}</nowiki><br>
	: {{var\|username}}</nowiki>
	\| The HTML code:		\| The HTML code:
	: {{tag\|var\|content=username}}		: {{tag\|var\|content=username}}<br>
	renders as:		renders as:<br>
	: {{var\|username}}		: {{var\|username}}
			\|-
	\| <nowiki>The commandline should read: ~~{{samp\|~~%}} {{kbd\|1=ssh {{var\|hostname}}}}<br />(where {{var\|hostname}} is the IP address or ...)<br />If it is correct, press ~~{{key press\|~~Enter}}.</nowiki>		\| <nowiki>The commandline should read: % {{kbd\|1=ssh {{var\|hostname}}}}<br />(where {{var\|hostname}} is the IP address or ...)<br />If it is correct, press <kbd>Enter</kbd>.</nowiki>
	\| The commandline should read: ~~{{samp\|~~%}} {{kbd\|1=ssh {{var\|hostname}}}}<br />(where {{var\|hostname}} is the IP address or ...)<br />If it is correct, press {{key press\|Enter}}.		\| The commandline should read: % {{kbd\|1=ssh {{var\|hostname}}}}<br />(where {{var\|hostname}} is the IP address or ...)<br />If it is correct, press {{key press\|Enter}}.
			\|-
	\| <nowiki>in this equation, let {{var\|x}}{{=}}1 and {{var\|y}}{{=}}120 ...</nowiki>		\| <nowiki>in this equation, let {{var\|x}}{{=}}1 and {{var\|y}}{{=}}120 ...</nowiki>
	\| in this equation, let {{var\|x}}{{=}}1 and {{var\|y}}{{=}}120 ...		\| in this equation, let {{var\|x}}{{=}}1 and {{var\|y}}{{=}}120 ...
			\|-
	\| <nowiki>{{para\|accessdate\|{{var\|todays_date}}}}</nowiki>		\| <nowiki>{{para\|accessdate\|{{var\|todays_date}}}}</nowiki>
	\| {{para\|accessdate\|{{var\|todays_date}}}}		\| {{para\|accessdate\|{{var\|todays_date}}}}
	}}		\|}
	~~</div>~~


	[[Category:Documentation subpages]]		[[Category:Documentation subpages]]