Fyrimynd:Wikivar/doc

Hetta er ein dokumentatión undirsíða til Fyrimynd:Wikivar.
Hon inniheldur kunning um nýtsluna, bólkar og um annað innihald, ið ikki er við í uppruna fyrimynd síðuni.

This template facilitates the displaying of Wikipedia variables and built-in "magic word" (i.e. pseudo-template) names and, optionally, their :parameters. The variable/magic-word names are automatically uppercased:

{{wikivar|PAGENAME}} and {{wikivar|pagename}} both produce: {{PAGENAME}}

The second parameter supplied will be treated as the variable or magic word's parameter/s. For example:

{{DEFAULTSORT|Kusanagi, Motoko}} produces: {{DEFAULTSORT:Kusanagi, Motoko}}

To convert the variable or magic word's name into a link to the "Variables" section in Help:Magic words, set the parameter |link= as on / add / include / etc. For example:

{{wikivar|link=on|PAGENAME}} produces: {{PAGENAME}}

To remove the default border and background, set |style= as plain:

{{wikivar|style=plain|link=on|PAGENAME}} produces: {{PAGENAME}}

|style= may also be set to one or more CSS styles that are then applied to the template's output.

Comparison

[rætta wikitekst]

Input	Output
{{wikivar\|PAGENAME}}	`{{PAGENAME}}`
{{tld\|PAGENAME}}	`{{PAGENAME}}`
{{wikivar\|link=on\|PAGENAME}}	`{{PAGENAME}}`
{{tlx\|PAGENAME}}	`{{PAGENAME}}`
{{wikivar\|style=plain\|PAGENAME}}	`{{PAGENAME}}`
{{braces\|PAGENAME}}	{{PAGENAME}}
{{wikivar\|DEFAULTSORT\|Kusanagi, Motoko}}	`{{DEFAULTSORT:Kusanagi, Motoko}}`
{{tld\|DEFAULTSORT:Kusanagi, Motoko}}	`{{DEFAULTSORT:Kusanagi, Motoko}}`

Semantic markup templates

Template	Example output	Use
{{strong}}	strong semantic emphasis	To indicate <strong> emphasis instead of (or as well as) simple typographical boldfacing.
{{strongbad}}	"Never use..."	Same as {{strong}} but in red.
{{stronggood}}	"Only use..."	Same as {{strong}} but in green.
{{em}}	mild semantic emphasis	As per {{strong}} but for the milder <em> emphasis (instead of / as well as typographical italicization).
{{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, {{varserif}} should be used to ensure a noticeable distinction.
{{varserif}}	`strIllustratePrefix`	(see {{var}} above)
{{wikivar}}	`{{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") as prose.
{{code}}	"Ensure the `alt=` parameter..."	To indicate text is source code. To nest other templates within {{code}}, use `<code>...</code>`.
{{subst:codenowiki}}	<code><nowiki> `code` ... ...</nowiki></code>	To wrap example code in `<code>` and nested `<nowiki>` tags.
{{syntaxhighlight}}		( ) Wrapper for `<syntaxhighlight>...</syntaxhighlight>`, but will wrap overflowing text.
{{deprecated code}}	"Do not use ~~<blink>~~."	( ) To indicate deprecated source code in template documentation, articles on HTML specs, etc. The {{dc2}} variant uses strike-through (~~<blink>~~) while {{dc\|red{{=}}y}} uses red (~~<blink>~~).
{{pre}}		For larger blocks of source code and other pre-formatted text.
{{bq}}		For indented blocks of content, such as block quotations, examples, poems, etc.
{{kbd}}	`user input`	To indicate user input.
{{key press}}	`CtrlX`	To indicate specific-keystroke input.
{{PlayStation key press}}	Fyrimynd:PlayStation key press	To indicate PlayStation-style gamepad key presses.
{{samp}}	`example output`	To indicate sample or example output.