Template:Code: Difference between revisions

From Zoophilia Wiki

Jump to navigation Jump to search

Revision as of 13:50, 19 May 2009

<code>{{nw|{{{1}}}}}</code>

Template documentation[view] [edit] [history] [purge]

This template is used on 35,000+ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

Usage

Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use <pre>...</pre> or <syntaxhighlight>...</syntaxhighlight>. See 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|1=date=30 Feb 2010}}.

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

(I am not watching this page, so please ping me if you want my attention.)

However, {{code|a {{template}} call}} will still invoke the template:

(I am not watching this page, so please ping me if you want my attention.)

Use <nowiki>...</nowiki> around the template name to avoid this problem:

(I am not watching this page, so please ping me if you want my attention.)

When used inline with regular text, {{code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:

(I am not watching this page, so please ping me if you want my attention.)

is well spaced:

foo (I am not watching this page, so please ping me if you want my attention.) quux.

versus:

(I am not watching this page, so please ping me if you want my attention.)

which is going to be visually confusing for many:

foo (I am not watching this page, so please ping me if you want my attention.) quux.

because "foo" and "(I am not watching this page, so please ping me if you want my attention.)" will seem more closely associated than "(I am not watching this page, so please ping me if you want my attention.)" and "(I am not watching this page, so please ping me if you want my attention.)"; the width of the space character in a monospaced font is almost always larger than in a proportional font.

Use parameter {{{2}}} (unnamed, as |2=, or more explicitly as |lang=) to specify a language for mw:Extension:SyntaxHighlight GeSHi. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though (I am not watching this page, so please ping me if you want my attention.) and (I am not watching this page, so please ping me if you want my attention.) are valid values, as are (I am not watching this page, so please ping me if you want my attention.), (I am not watching this page, so please ping me if you want my attention.), (I am not watching this page, so please ping me if you want my attention.), (I am not watching this page, so please ping me if you want my attention.), (I am not watching this page, so please ping me if you want my attention.) 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 substituted.

Examples

Markup	Renders as
Lorem {{code\|ipsum '''dolor'''}} sit amet	Lorem `(I am not watching this page, so please ping me if you want my attention.)` sit amet
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 `(I am not watching this page, so please ping me if you want my attention.)` is the prototype for a function defined later.
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}}}; see also [[:bugzilla:5138]].	If the code contains an equals sign, such as `(I am not watching this page, so please ping me if you want my attention.)`, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}; see also bugzilla:5138.

Included templates

Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, which can contain templates such as {{var}} and {{samp}}, use <code>...</code> as a wrapper instead of this template.

Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:

Markup	Renders as
{{code\| {{cite web \|title=Title \|url=http://example.org}} }}	`(I am not watching this page, so please ping me if you want my attention.)`

The above example shows the HTML rendered by the citation template, including the hidden metadata.

See also

{{codett}}, wrapper for this template that removes background and border styling
{{mono}}, monospaced font only
{{Syntaxhighlight}}
Help:Wiki markup

Semantic markup templates

Template	Example output	Use
`{{strong}}`	Important!	To indicate <strong> importance, seriousness, or urgency instead of just simple typographical boldfacing
`{{strongbad}}`	"Never use ..."	Same as {{strong}} but in red
`{{stronggood}}`	"Only use ..."	Same as {{strong}} but in green
`{{em}}`	"An emphatic phrase"	To indicate <em> stress emphasis (not just purely typographical italicization like for book titles or foreign terms)
`{{var}}`	`strPrefix`	To indicate text is a variable name. Use for any variable names except those including "I" (uppercase i) and/or "l" (lowercase L); for these, {{var serif}} should be used to ensure a noticeable distinction
`{{var serif}}`	`strIllustratePrefix`	(see {{var}} above)
`{{tld}}`	`{{DEFAULTSORT:Y, X}}`	To display wikicode variables and magic words as they would appear in code
`{{para}}`	`\|year=2008`	To display template parameters with or without values
`{{param}}`	`{{{title\|alt}}}`	To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{para}} above
`{{tlx}}` etc.	`{{Template\|1\|2\|...\|10}}`	To display a template call (with or without parameters and values) as code
`{{tag}}`	"The `<img>...</img>` tags ..."	To render HTML elements ("tags") in prose
`{{code}}`/`{{codett}}`	"Ensure the `(I am not watching this page, so please ping me if you want my attention.)` parameter ..."	To indicate text is source code. To nest other templates within {{code}}, use `<code>...</code>`. {{codett}} differs only in styling: `(I am not watching this page, so please ping me if you want my attention.)` becomes `(I am not watching this page, so please ping me if you want my attention.)`
`{{subst:codenowiki}}`	`{{small\|small text}}`	To wrap example code in `(I am not watching this page, so please ping me if you want my attention.)`
`{{subst:kbdnowiki}}`	`{{big\|big text}}`	To wrap example code in `(I am not watching this page, so please ping me if you want my attention.)`
`{{syntaxhighlight}}`	_{[this is a block template]}	( or `{{sxhl}}` ) Wrapper for `<syntaxhighlight>...</syntaxhighlight>`, but will wrap overflowing text
`{{deprecated code}}`	"Do not use `<blink>`."	( or `{{dc}}` ) To indicate deprecated source code in template documentation, articles on HTML specs, etc. The `{{dc2}}` variant uses strike-through (`<blink>`) while `{{dcr}}` uses red (`<blink>`).
`{{pre}}`	_{[this is a block template]}	For larger blocks of source code and other pre-formatted text
`{{quote}}`	_{[this is a block template]}	For block quotations (only – never for non-quotations)
`{{block indent}}`	_{[this is a block template]}	For indented blocks of material; visually identical to `{{quote}}` but without quote markup
`{{kbd}}`	`user input`	To indicate user input
`{{key press}}`	`Ctrl`+`x`	To indicate specific-keystroke input, including combinations
`{{key top}}`	`Left shift`	Similar; includes more symbols, but does not directly support combinations
`{{PlayStation key press}}`	`□`	To indicate PlayStation-style gamepad key presses
`{{button}}`	`Don't save`	To indicate a button in a user interface
`{{samp}}`	`example output`	To indicate sample or example output

The above documentation is transcluded from Template:Code/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.

Retrieved from "https://zoophilia.wiki/index.php?title=Template:Code&oldid=27712"

Navigation menu