Template:Semantic markup templates: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>SamB
add an example
meta>Sardanaphalus
table, a few rephrasings, added {{param}}
Line 1: Line 1:
<!-- This is transcluded into all these templates' /doc pages to save time. -->
<!--
<div style="float: right; padding: 0 1em;">{{navbar|Semantic templates see also|plain=y}}</div>
  Transcluded by the /doc pages of the templates listed
* {{tl|strong}} &ndash; For semantically indicating {{strong|strong emphasis}} instead of simple typographical boldfacing.
--->
* {{tl|strongbad}} &ndash; Same as {{tnull|strong}} but red like this: "{{strongbad|Never}} use {{tnull|strongbad}} in articles."
<div style="float:right;padding:0 1.0em;">{{navbar|Semantic templates see also|plain=y}}</div>
* {{tl|stronggood}} &ndash; Same as {{tnull|strongbad}} but green like this: "{{stronggood|Only}} use {{tnull|stronggood}} on non-article pages."
{| cellspacing="0" cellpadding="1"
* {{tl|em}} &ndash; Similar template for semantically indicating {{em|mild emphasis}} instead of simple typographical italicization.
|- style="font-size:115%;line-height:1.8em;"
* {{tl|var}} &ndash; Same as {{tl|varserif}} use for all variables (e.g. {{var|strIllustratePrefix}}), except for "I" (upper-case i) and "l" (lower-case L), for which use {{tl|varserif}}.
|style="width:9.0em;"| '''Template''' ||style="width:19.5em;"| '''Examples''' || '''Use'''
* {{tl|varserif}} &ndash; Same as {{tl|var}} but uses serif font (e.g. {{varserif|strIllustratePrefix}}), especially for distinguishing between "I" (upper-case i) and "l" (lower-case L) as variables.
|-
* {{tl|wikivar}} &ndash; For displaying wikicode variables and magicwords as they would appear in source code, e.g. {{wikivar|PAGENAME}}, {{wikivar|DEFAULTSORT|Lastname, Firstname}}.
| {{tl|strong}}
* {{tl|para}} &ndash; For displaying wiki template parameters ({{para|title}}) or parameters and values ({{para|year|2008}}).
| {{strong|strong semantic emphasis}}
* {{tl|tlx}} and related &ndash; For displaying entire templates (with or without parameters and values) as code.
| To indicate [[HTML element#strong|<nowiki><strong></nowiki>]] emphasis instead of (or as well as) simple typographical boldfacing. </tr>
* {{tl|tag}} – For using HTML elements ("tags") in prose (e.g. "When coding HTML {{tag|img}} tags, always include …").
| {{tl|strongbad}} || "{{strongbad|Never}} use..."  || Same as {{braces|strong}} but in red. </tr>
* {{tl|code}} &ndash; For computer source code (e.g. "always include the {{code|1=alt=}} parameter"). (Note: to nest other templates like {{tnull|var}} inside, use {{tag|code}} instead of {{tnull|code}}.)
| {{tl|stronggood}} || "{{stronggood|Only}} use..."  || Same as {{braces|strongbad}} but in green. </tr>
* {{tl|syntaxhighlight}} or {{tl|sxhl}} Wrapper for {{tag|syntaxhighlight}}, but will wrap overflowing text.
|-
* {{tl|deprecated code}} or {{tl|dc2}} &ndash; For deprecated source code in template documentation, articles on [[HTML]] specs, etc. (e.g. "do not use {{dc2|{{tag|blink}}}}").
| {{tl|em}}
* {{tl|pre}} For larger blocks of source code and other pre-formatted text.
| {{em|mild semantic emphasis}}
* {{tl|bq}} &ndash; For indented blocks of content, such as block quotations, examples, poems, etc.
|style="line-height:1.3em;"| As per {{braces|strong}} but for the milder [[HTML element#em|<nowiki><em></nowiki>]] emphasis (instead of{{\}}as well as typographical italicization). </tr>
* {{tl|kbd}} &ndash; For indicating {{kbd|user input}}.
|-
* {{tl|key press}} &ndash; For indicating the input of specific keystrokes, e.g. {{key press|Ctrl}}{{key press|X}}.
|style="vertical-align:top;"| {{tl|var}}
* {{tl|PlayStation key press}} &ndash; For indicating PlayStation-style gamepad key presses, e.g. {{pskeypress|x}}.
|style="vertical-align:top;"| {{var|strIllustratePrefix}}
* {{tl|samp}} &ndash; For {{samp|example output}}.<!--
|style="vertical-align:top;line-height:1.3em;"| To indicate text is a variable name. Use for any variables except those whose names include "I" (uppercase&nbsp;i) and/or "l" (lowercase&nbsp;L), where {{braces|varserif}} below should be used instead to ensure a distinction between these letters. </tr>
--><noinclude>
| {{tl|varserif}} || {{varserif|strIllustratePrefix}} || (see {{braces|var}} above). </tr>
<!-- ADD CATEGORIES AND INTERWIKIS LINKS TO THE /doc PAGE, NOT HERE, THANKS -->
|-
{{documentation}}
| {{tl|wikivar}}
</noinclude>
|style="white-space:nowrap;"| {{wikivar|PAGENAME}}{{nbsp|2}}{{wikivar|DEFAULTSORT|Y, X}}
| To display wikicode variables and [[Help:Magic words|magic words]] as they would appear in code.
|-
| {{tl|para}}
| {{para|title}}{{nbsp|2}}{{para|year|2008}}
| To display template parameters with or without values.
|-
| {{tl|param}}
| {{param|title}}{{nbsp|2}}{{param|title|alt}}{{nbsp|2}}etc.
|style="line-height:1.3em;"| To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{braces|para}} above.
|-
| {{tl|tlx}} etc.
| {{tlx|Template|''first parameter''|...}}
| To display a template call (with or without parameters and values) as code.
|-
| {{tl|tag}}
|style="white-space:nowrap;"| "With HTML {{tag|img}} tags..."
| To render [[HTML element]]s ("tags") as prose.
|-
| {{tl|code}}
| "Always include the {{code|1=alt=}} parameter..."
|style="line-height:1.3em;"| To indicate text is source code. To nest other templates within {{braces|code}}, use {{tag|code}}.
|-
| {{tl|syntaxhighlight}} ||  ||style="line-height:1.3em;"| ''(&thinsp;or {{tl|sxhl}}&thinsp;)''&nbsp; Wrapper for {{tag|syntaxhighlight}}, but will wrap overflowing text.
|-
| {{tl|deprecated code}}
|style="white-space:nowrap;"| "Do not use {{dc2|{{tag|blink}}}}..."
|style="line-height:1.3em;" | ''(&thinsp;or {{tl|dc2}}&thinsp;)''&nbsp; To indicate [[Deprecation|deprecated]] source code in template documentation, articles on HTML specs, etc.
|-
| {{tl|pre}} ||  || For larger blocks of source code and other pre-formatted text. </tr>
| {{tl|bq}}   ||  || For indented blocks of content, such as block quotations, examples, poems, etc. </tr>
| {{tl|kbd}} || {{kbd|user input}} || To indicate user input. </tr>
| {{tl|key press}} || {{key press|Ctrl}}{{key press|X}} || To indicate specific keystroke/s input. </tr>
| {{tl|pskeypress}} || {{lower|0.2em|{{pskeypress|x}}}}  || To indicate PlayStation-style gamepad key presses. </tr>
| {{tl|samp}} || {{samp|example output}} || To indicate sample or example output. </tr>
|-
|}<noinclude>{{Documentation}}</noinclude>

Revision as of 21:54, 24 May 2014

Template Examples 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 {{strongbad}} but in green.
{{em}} mild semantic emphasis As per {{strong}} but for the milder <em> emphasis (instead of / as well as typographical italicization).
{{var}} strIllustratePrefix To indicate text is a variable name. Use for any variables except those whose names include "I" (uppercase i) and/or "l" (lowercase L), where {{varserif}} below should be used instead to ensure a distinction between these letters.
{{varserif}} Template:Varserif (see {{var}} above).
{{wikivar}} Template:WikivarTemplate:NbspTemplate:Wikivar To display wikicode variables and magic words as they would appear in code.
{{para}} |title=Template:Nbsp|year=2008 To display template parameters with or without values.
{{param}} {{{title}}}Template:Nbsp{{{title|alt}}}Template:Nbspetc. 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|first parameter|...}} To display a template call (with or without parameters and values) as code.
{{tag}} "With HTML <img>...</img> tags..." To render HTML elements ("tags") as prose.
{{code}} "Always include the alt= parameter..." To indicate text is source code. To nest other templates within {{code}}, use <code>...</code>.
{{syntaxhighlight}} ( or {{sxhl}} )  Wrapper for <syntaxhighlight>...</syntaxhighlight>, but will wrap overflowing text.
{{deprecated code}} "Do not use <blink>...</blink>..." ( or {{dc2}} )  To indicate deprecated source code in template documentation, articles on HTML specs, etc.
{{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/s input.
{{pskeypress}} Template:Pskeypress To indicate PlayStation-style gamepad key presses.
{{samp}} example output To indicate sample or example output.