Template:Code/doc - Revision history

Casiope at 15:59, 21 July 2020

2020-07-21T15:59:48Z

← Older revision		Revision as of 15:59, 21 July 2020
Line 51:		Line 51:
	== Included templates ==		== Included templates ==

	Embedded templates do not function as expected inside {{tlg\|code=yes\|nolink=yes\|code}}; for longer, free‐form blocks of code, which can contain templates such as {{~~tlx~~\|var}} and {{~~tlx~~\|samp}}, use {{tag\|code}} as a wrapper instead of this template.		Embedded templates do not function as expected inside {{tlg\|code=yes\|nolink=yes\|code}}; for longer, free‐form blocks of code, which can contain templates such as {{tlg\|code=yes\|var}} and {{tlg\|code=yes\|samp}}, use {{tag\|code}} as a wrapper instead of this template.

	Templates used inside {{tlg\|code=yes\|nolink=yes\|code}} expose the rendered HTML - this can be useful.		Templates used inside {{tlg\|code=yes\|nolink=yes\|code}} expose the rendered HTML - this can be useful.

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

Casiope at 14:56, 21 July 2020

2020-07-21T14:56:48Z

← Older revision		Revision as of 14:56, 21 July 2020
Line 1:		Line 1:
	The template {{tl\|code}} wraps a short span of text in {{tag\|syntaxhighlight\|open}} tags (see [[mw:Extension:SyntaxHighlight\|Extension SyntaxHighlight]]).		The template {{tlg\|code}} wraps a short span of text in {{tag\|syntaxhighlight\|open}} tags (see [[mw:Extension:SyntaxHighlight\|Extension SyntaxHighlight]]).

	== Usage ==		== Usage ==
Line 5:		Line 5:
	It should be used for short samples; longer content should use {{tag\|pre}} or {{tag\|syntaxhighlight}}. See [[wikipedia:Help:Wiki markup\|Help:Wiki markup]] for an explanation of what the various tags do.		It should be used for short samples; longer content should use {{tag\|pre}} or {{tag\|syntaxhighlight}}. See [[wikipedia:Help:Wiki markup\|Help:Wiki markup]] for an explanation of what the various tags do.

	If the content includes an equals sign “=”, you must specify the parameter explicitly: {{~~tlc~~\|code\|1{{=}}date{{=}}30 Feb 2010}}.		If the content includes an equals sign “=”, you must specify the parameter explicitly: {{tlg\|code=yes\|nolink=yes\|code\|1{{=}}date{{=}}30 Feb 2010}}.

	The template uses the {{tag\|syntaxhighlight\|open}} tag with the attribute {{code\|inline{{=}}1}}. This works like the combination of the {{tag\|code\|open}} and {{tag\|wiki\|open}} tags, applied to the expanded wikitext. For example, {{nowrap\|<code><nowiki>{{code\|some '''wiki''' text}}</nowiki></code>}} will {{strong\|not}} render the word “wiki” in bold, and will render the tripled‐single quotes:		The template uses the {{tag\|syntaxhighlight\|open}} tag with the attribute {{code\|inline{{=}}1}}. This works like the combination of the {{tag\|code\|open}} and {{tag\|wiki\|open}} tags, applied to the expanded wikitext. For example, {{nowrap\|<code><nowiki>{{code\|some '''wiki''' text}}</nowiki></code>}} will {{strong\|not}} render the word “wiki” in bold, and will render the tripled‐single quotes:
Line 19:		Line 19:
	: {{code\|a <nowiki>{{template}}</nowiki> call}}		: {{code\|a <nowiki>{{template}}</nowiki> call}}

	When used inline with regular text, {{~~tnull~~\|code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:		When used inline with regular text, {{tlg\|code=yes\|nolink=yes\|code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:
	: {{code\|foo  <nowiki>{{code\|bar baz}}</nowiki>  quux.}}		: {{code\|foo  <nowiki>{{code\|bar baz}}</nowiki>  quux.}}
	is well spaced:		is well spaced:
Line 51:		Line 51:
	== Included templates ==		== Included templates ==

	Embedded templates do not function as expected inside {{~~tlc~~\|code}}; for longer, free‐form blocks of code, which can contain templates such as {{tlx\|var}} and {{tlx\|samp}}, use {{tag\|code}} as a wrapper instead of this template.		Embedded templates do not function as expected inside {{tlg\|code=yes\|nolink=yes\|code}}; for longer, free‐form blocks of code, which can contain templates such as {{tlx\|var}} and {{tlx\|samp}}, use {{tag\|code}} as a wrapper instead of this template.

	Templates used inside {{~~tlc~~\|code}} expose the rendered HTML - this can be useful.		Templates used inside {{tlg\|code=yes\|nolink=yes\|code}} expose the rendered HTML - this can be useful.

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

Casiope: /* Usage */

2020-07-20T13:13:26Z

Usage

← Older revision		Revision as of 13:13, 20 July 2020
Line 29:		Line 29:
	because “foo” and “{{code\|bar}}” will seem more closely associated than “{{code\|bar}}” and “{{code\|baz}}”; the width of the space character in a monospaced font is almost always larger than in a proportional font.		because “foo” and “{{code\|bar}}” will seem more closely associated than “{{code\|bar}}” and “{{code\|baz}}”; the width of the space character in a monospaced font is almost always larger than in a proportional font.

	Use parameter {{{2}}} (unnamed, as {{para\|2}}, or more explicitly as {{para\|lang}}) to specify a language for [[mw:Extension:SyntaxHighlight\|Extension:SyntaxHighlight]]. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though {{code\|html4strict}} and {{code\|html5}} are valid values, as are {{code\|php}}, {{code\|perl}}, {{code\|css}}, {{code\|javascript}}, {{code\|mysql}} and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.		Use parameter {{{2}}} (unnamed, as {{para\|2}}, or more explicitly as {{para\|lang}}) to specify a language for [[mw:Extension:SyntaxHighlight\|Extension:SyntaxHighlight]]. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though {{code\|html4strict}} and {{code\|html5}} are valid values, as are {{code\|php}}, {{code\|perl}}, {{code\|css}}, {{code\|javascript}}, {{code\|mysql}} and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.

	This template does not need to be [[Wikipedia:Template substitution\|substituted]].		This template does not need to be [[Wikipedia:Template substitution\|substituted]].

Casiope: /* Examples */

2020-07-20T13:11:37Z

Examples

← Older revision		Revision as of 13:11, 20 July 2020
Line 39:		Line 39:
	! Renders as		! Renders as
	\|-		\|-
	\| ~~<code>~~<nowiki>Lorem {{code\|ipsum '''dolor'''}} sit amet</nowiki~~></code~~>		\| <nowiki>Lorem {{code\|ipsum '''dolor'''}} sit amet</nowiki>
	\| Lorem {{code\|ipsum '''dolor'''}} sit amet		\| Lorem {{code\|ipsum '''dolor'''}} sit amet
	\|-		\|-
	\| ~~<code>~~<nowiki>The declaration {{code \|lang=cpp \|int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later.</nowiki~~></code~~>		\| <nowiki>The declaration {{code\|lang=cpp\|int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later.</nowiki>
	\| The declaration {{code \|lang=cpp \|int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later.		\| The declaration {{code\|lang=cpp\|int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later.
	\|-		\|-
	\| ~~<code>~~<nowiki>If the code contains an equals sign, such as {{code \|lang=javascript \|code=var img = document.getElementsByTagName("img");}}, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}.</nowiki~~></code~~>		\| <nowiki>If the code contains an equals sign, such as {{code\|lang=javascript\|code=var img = document.getElementsByTagName("img");}}, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}.</nowiki>
	\| If the code contains an equals sign, such as {{code \|lang=javascript \|code=var img = document.getElementsByTagName("img");}}, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}.		\| If the code contains an equals sign, such as {{code \|lang=javascript \|code=var img = document.getElementsByTagName("img");}}, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}.
	\|}		\|}

Casiope: /* Usage */

2020-07-20T12:46:57Z

Usage

← Older revision		Revision as of 12:46, 20 July 2020
Line 5:		Line 5:
	It should be used for short samples; longer content should use {{tag\|pre}} or {{tag\|syntaxhighlight}}. See [[wikipedia:Help:Wiki markup\|Help:Wiki markup]] for an explanation of what the various tags do.		It should be used for short samples; longer content should use {{tag\|pre}} or {{tag\|syntaxhighlight}}. See [[wikipedia:Help:Wiki markup\|Help:Wiki markup]] for an explanation of what the various tags do.

	If the content includes an equals sign “=”, you must specify the parameter explicitly: ~~<code><nowiki>~~{{code\|1=date=30 Feb 2010}}~~</nowiki></code>~~.		If the content includes an equals sign “=”, you must specify the parameter explicitly: {{tlc\|code\|1{{=}}date{{=}}30 Feb 2010}}.

	The template uses the ~~<code><nowiki><~~syntaxhighlight~~></nowiki></code>~~ tag with the attribute <code>inline=1~~</code>~~. This works like the combination of the <code~~><nowiki><code></nowiki></code>~~ and ~~<code><nowiki><nowiki></nowiki></code>~~ tags, applied to the expanded wikitext. For example, <code><nowiki>{{code\|some '''wiki''' text}}</nowiki></code> will {{strong\|not}} render the word “wiki” in bold, and will render the tripled‐single quotes:		The template uses the {{tag\|syntaxhighlight\|open}} tag with the attribute {{code\|inline{{=}}1}}. This works like the combination of the {{tag\|code\|open}} and {{tag\|wiki\|open}} tags, applied to the expanded wikitext. For example, {{nowrap\|<code><nowiki>{{code\|some '''wiki''' text}}</nowiki></code>}} will {{strong\|not}} render the word “wiki” in bold, and will render the tripled‐single quotes:

	: {{code\|some '''wiki''' text}}		: {{code\|some '''wiki''' text}}

Casiope at 21:11, 19 July 2020

2020-07-19T21:11:38Z

← Older revision		Revision as of 21:11, 19 July 2020
Line 1:		Line 1:
			The template {{tl\|code}} wraps a short span of text in {{tag\|syntaxhighlight\|open}} tags (see [[mw:Extension:SyntaxHighlight\|Extension SyntaxHighlight]]).

	== Usage ==		== Usage ==

	~~Wraps a short span of text in <code><nowiki><syntaxhighlight></nowiki></code> tags (see [[mw:Extension:SyntaxHighlight\|Extension SyntaxHighlight]]). This template~~ should be used for short samples; longer content should use {{tag\|pre}} or {{tag\|syntaxhighlight}}. See [[wikipedia:Help:Wiki markup\|Help:Wiki markup]] for an explanation of what the various tags do.		It should be used for short samples; longer content should use {{tag\|pre}} or {{tag\|syntaxhighlight}}. See [[wikipedia:Help:Wiki markup\|Help:Wiki markup]] for an explanation of what the various tags do.

	If the content includes an equals sign “=”, you must specify the parameter explicitly: <code><nowiki>{{code\|1=date=30 Feb 2010}}</nowiki></code>.		If the content includes an equals sign “=”, you must specify the parameter explicitly: <code><nowiki>{{code\|1=date=30 Feb 2010}}</nowiki></code>.

Casiope at 13:49, 11 July 2020

2020-07-11T13:49:34Z

← Older revision		Revision as of 13:49, 11 July 2020
Line 31:		Line 31:
	This template does not need to be [[Wikipedia:Template substitution\|substituted]].		This template does not need to be [[Wikipedia:Template substitution\|substituted]].

	=== Examples ===		== Examples ==

	{\|class=wikitable style="width:100%;"		{\|class=wikitable style="width:100%;"
Line 47:		Line 47:
	\|}		\|}

	=== Included templates ===		== Included templates ==

	Embedded templates do not function as expected inside {{tlc\|code}}; for longer, free‐form blocks of code, which can contain templates such as {{tlx\|var}} and {{tlx\|samp}}, use {{tag\|code}} as a wrapper instead of this template.		Embedded templates do not function as expected inside {{tlc\|code}}; for longer, free‐form blocks of code, which can contain templates such as {{tlx\|var}} and {{tlx\|samp}}, use {{tag\|code}} as a wrapper instead of this template.

Casiope at 13:38, 11 July 2020

2020-07-11T13:38:17Z

← Older revision		Revision as of 13:38, 11 July 2020
Line 53:		Line 53:
	Templates used inside {{tlc\|code}} expose the rendered HTML - this can be useful.		Templates used inside {{tlc\|code}} expose the rendered HTML - this can be useful.

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

Casiope: /* Included templates */

2020-07-11T12:53:49Z

Included templates

← Older revision		Revision as of 12:53, 11 July 2020
Line 49:		Line 49:
	=== Included templates ===		=== Included templates ===

	Embedded templates do not function as expected inside {{tl\|code}}; for longer, free‐form blocks of code, which can contain templates such as {{tl\|var}} and {{tl\|samp}}, use {{tag\|code}} as a wrapper instead of this template.		Embedded templates do not function as expected inside {{tlc\|code}}; for longer, free‐form blocks of code, which can contain templates such as {{tlx\|var}} and {{tlx\|samp}}, use {{tag\|code}} as a wrapper instead of this template.

	Templates used inside {{tl\|code}} expose the rendered HTML - this can be useful.		Templates used inside {{tlc\|code}} expose the rendered HTML - this can be useful.

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

Casiope at 17:44, 10 July 2020

2020-07-10T17:44:28Z

← Older revision		Revision as of 17:44, 10 July 2020
Line 5:		Line 5:
	If the content includes an equals sign “=”, you must specify the parameter explicitly: <code><nowiki>{{code\|1=date=30 Feb 2010}}</nowiki></code>.		If the content includes an equals sign “=”, you must specify the parameter explicitly: <code><nowiki>{{code\|1=date=30 Feb 2010}}</nowiki></code>.

	The template uses the <code><nowiki><syntaxhighlight></nowiki></code> tag with the attribute <code>inline=1</code>. This works like the combination of the <code><nowiki><code></nowiki></code> and <code><nowiki><nowiki></nowiki></code> tags, applied to the expanded wikitext. For example, <code><nowiki>{{code\|some '''wiki''' text}}</nowiki></code> will ~~{{em\|~~{{strong\|not}}}} render the word “wiki” in bold, and will render the tripled‐single quotes:		The template uses the <code><nowiki><syntaxhighlight></nowiki></code> tag with the attribute <code>inline=1</code>. This works like the combination of the <code><nowiki><code></nowiki></code> and <code><nowiki><nowiki></nowiki></code> tags, applied to the expanded wikitext. For example, <code><nowiki>{{code\|some '''wiki''' text}}</nowiki></code> will {{strong\|not}} render the word “wiki” in bold, and will render the tripled‐single quotes:

	: {{code\|some '''wiki''' text}}		: {{code\|some '''wiki''' text}}

← Older revision		Revision as of 13:13, 20 July 2020
Line 29:		Line 29:
	because “foo” and “{{code\|bar}}” will seem more closely associated than “{{code\|bar}}” and “{{code\|baz}}”; the width of the space character in a monospaced font is almost always larger than in a proportional font.		because “foo” and “{{code\|bar}}” will seem more closely associated than “{{code\|bar}}” and “{{code\|baz}}”; the width of the space character in a monospaced font is almost always larger than in a proportional font.

	Use parameter {{{2}}} (unnamed, as {{para\|2}}, or more explicitly as {{para\|lang}}) to specify a language for [[mw:Extension:SyntaxHighlight\|Extension:SyntaxHighlight]]. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though {{code\|html4strict}} and {{code\|html5}} are valid values, as are {{code\|php}}, {{code\|perl}}, {{code\|css}}, {{code\|javascript}}, {{code\|mysql}} and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.		Use parameter {{{2}}} (unnamed, as {{para\|2}}, or more explicitly as {{para\|lang}}) to specify a language for [[mw:Extension:SyntaxHighlight\|Extension:SyntaxHighlight]]. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though {{code\|html4strict}} and {{code\|html5}} are valid values, as are {{code\|php}}, {{code\|perl}}, {{code\|css}}, {{code\|javascript}}, {{code\|mysql}} and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.

	This template does not need to be [[Wikipedia:Template substitution\|substituted]].		This template does not need to be [[Wikipedia:Template substitution\|substituted]].

← Older revision		Revision as of 12:46, 20 July 2020
Line 5:		Line 5:
	It should be used for short samples; longer content should use {{tag\|pre}} or {{tag\|syntaxhighlight}}. See [[wikipedia:Help:Wiki markup\|Help:Wiki markup]] for an explanation of what the various tags do.		It should be used for short samples; longer content should use {{tag\|pre}} or {{tag\|syntaxhighlight}}. See [[wikipedia:Help:Wiki markup\|Help:Wiki markup]] for an explanation of what the various tags do.

	If the content includes an equals sign “=”, you must specify the parameter explicitly: ~~<code><nowiki>~~{{code\|1=date=30 Feb 2010}}~~</nowiki></code>~~.		If the content includes an equals sign “=”, you must specify the parameter explicitly: {{tlc\|code\|1{{=}}date{{=}}30 Feb 2010}}.

	The template uses the ~~<code><nowiki><~~syntaxhighlight~~></nowiki></code>~~ tag with the attribute <code>inline=1~~</code>~~. This works like the combination of the <code~~><nowiki><code></nowiki></code>~~ and ~~<code><nowiki><nowiki></nowiki></code>~~ tags, applied to the expanded wikitext. For example, <code><nowiki>{{code\|some '''wiki''' text}}</nowiki></code> will {{strong\|not}} render the word “wiki” in bold, and will render the tripled‐single quotes:		The template uses the {{tag\|syntaxhighlight\|open}} tag with the attribute {{code\|inline{{=}}1}}. This works like the combination of the {{tag\|code\|open}} and {{tag\|wiki\|open}} tags, applied to the expanded wikitext. For example, {{nowrap\|<code><nowiki>{{code\|some '''wiki''' text}}</nowiki></code>}} will {{strong\|not}} render the word “wiki” in bold, and will render the tripled‐single quotes:

	: {{code\|some '''wiki''' text}}		: {{code\|some '''wiki''' text}}

← Older revision		Revision as of 17:44, 10 July 2020
Line 5:		Line 5:
	If the content includes an equals sign “=”, you must specify the parameter explicitly: <code><nowiki>{{code\|1=date=30 Feb 2010}}</nowiki></code>.		If the content includes an equals sign “=”, you must specify the parameter explicitly: <code><nowiki>{{code\|1=date=30 Feb 2010}}</nowiki></code>.

	The template uses the <code><nowiki><syntaxhighlight></nowiki></code> tag with the attribute <code>inline=1</code>. This works like the combination of the <code><nowiki><code></nowiki></code> and <code><nowiki><nowiki></nowiki></code> tags, applied to the expanded wikitext. For example, <code><nowiki>{{code\|some '''wiki''' text}}</nowiki></code> will ~~{{em\|~~{{strong\|not}}}} render the word “wiki” in bold, and will render the tripled‐single quotes:		The template uses the <code><nowiki><syntaxhighlight></nowiki></code> tag with the attribute <code>inline=1</code>. This works like the combination of the <code><nowiki><code></nowiki></code> and <code><nowiki><nowiki></nowiki></code> tags, applied to the expanded wikitext. For example, <code><nowiki>{{code\|some '''wiki''' text}}</nowiki></code> will {{strong\|not}} render the word “wiki” in bold, and will render the tripled‐single quotes:

	: {{code\|some '''wiki''' text}}		: {{code\|some '''wiki''' text}}