Template:Mono/doc: Difference between revisions
From The Kodiak Republic Wiki
no edit summary
(Created page with "→{{pp-template}}: .monospaced { →"monospace, monospace" per [[WP:MONO]]: font-family: monospace, monospace; }") |
No edit summary |
||
Line 1:
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
{{tlr|clear=right|monospace}}{{tsh|clear=right|tt|ttt}}
{{used in system|in [[MediaWiki:Abusefilter-disallowed-semicolon]]}}
{{Uses TemplateStyles |Template:Mono/styles.css}}
{{COinS safe|n}}
{{-}}
== Usage ==
{{tlx|mono|<var>text to format here</var>}}
renders as:
{{mono|text to format here}}
This template is for formatting short bits of content (the only parameter) as monospaced (nonproportional) text. It is simply a quick shorthand for the necessary [[Cascading Style Sheets|CSS]] code. It is a replacement for {{tag|tt}}, which is an obsolete element under HTML5. ([http://www.w3.org/TR/html5/obsolete.html#non-conforming-features Non-conforming features])
This template {{em|should}} be used where the content is being rendered in monospaced text for purely stylistic/display reasons, where this display has no particular semantic significance.
It {{em|should not}} be used to indicate information with these semantics:
* source code, use {{tl|code}} or {{tag|code}} instead
* variables or variable input, use {{tl|var}} or {{tag|var}} instead
* keyboard input, use {{tl|kbd}} or {{tag|kbd}} instead
* sample output, use {{tl|samp}} or {{tag|samp}} instead
It {{em|cannot}} be used to mark up multiple paragraphs, sections or other block elements, as it uses {{tag|span|o}}, which is an inline element. Use {{tl|monodiv}} and {{tl|pre}} for multiple blocks of text, or use multiple instances of {{tl|Mono}} for each individual line.
When the content ends with a single closing curly brace (<code><nowiki>}</nowiki></code>), the content should be followed by <code><nowiki><nowiki/></nowiki></code>, for example, to mark up <code><nowiki>{foo}</nowiki></code>, use {{tlc|mono|<nowiki>{foo}<nowiki/></nowiki>}} or {{tlc|mono|<nowiki><nowiki>{foo}</nowiki></nowiki>}}.
If the content contains pipe characters (<code>|</code>) not surrounded by {{tag|nowiki}}, they must be escaped with <code>&#124;</code> or <code><nowiki>{{!}}</nowiki></code>.
=== Parameters ===
There are two parameters:
;{{para|1}} or unnamed
: The content to format as monospaced. If the content contains a <code>=</code> character, the parameter must be numbered or the template will break. (The parameter does not need to be numbered if the <code>=</code> character is surrounded by {{tag|nowiki}}, or if it is escaped as <code>&#61;</code>.) For backward compatibility with an old, merged-in template, this parameter can also be called {{para|2}}.
;{{para|needs_review|yes}}
: Used (e.g. by [[WP:Bot|bots]] or [[WP:AWB|AWB]] scripts) to indicate replacement of now-obsolete {{tag|tt}} markup with {{tnull|mono|...}} markup. This template displays nothing and presently does no categorization, though a cleanup category can be created if necessary. It indicates that the markup may need to be changed to something more semantically meaningful, such as {{tag|code}}, {{tag|samp}}, or {{tag|kbd}}.
== TemplateData ==
{{Format TemplateData|<templatedata>
{
"description": "This template is for formatting short bits of content as monospaced text.",
"format": "inline",
"params": {
"1": {
"aliases": [
"2"
],
"label": "Content",
"description": "The content to format as monospaced.",
"required": true,
"type": "line"
},
"needs_review": {
"label": "Needs Review?",
"description": "Used (e.g. by [[WP:Bot|bots]] or [[WP:AWB|AWB]] scripts) to indicate replacement of now-obsolete <code><!--nostrip--><tt>...</tt></code><!--nostrip--> markup with <code><!--nostrip-->{{mono|...}}</code><!--nostrip--> markup. This template displays nothing and presently does no categorization, though a cleanup category can be created if necessary. It indicates that the markup may need to be changed to something more semantically meaningful, such as <code><!--nostrip--><code>...</code></code><!--nostrip-->, <code><!--nostrip--><samp>...</samp></code><!--nostrip-->, or <code><!--nostrip--><kbd>...</kbd></code><!--nostrip-->.",
"autovalue": "yes",
"type": "boolean"
}
}
}
</templatedata>}}
== See also ==
* {{tl|pre}}
* {{tl|code}}
* {{tl|kbd}}
* {{tl|syntaxhighlight}}
* {{tl|samp}}
* {{tl|var}}
* {{tl|param value}}
{{Semantic markup templates|show}}
<includeonly>{{Sandbox other||
<!-- CATEGORIES HERE, THANKS -->
[[Category:Typing-aid templates|{{PAGENAME}}]]
}}</includeonly>
| |||
