Template:Mono/doc
This is a documentation subpage for Template:Mono It may contain usage information, categories and other content that is not part of the original template page. |
This template is used in MediaWiki:Abusefilter-disallowed-semicolon. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid large-scale disruption, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this template. Please discuss any changes on the talk page before implementing them. |
This template uses TemplateStyles: |
This template should not be used in citation templates such as Citation Style 1 and Citation Style 2, because it includes markup that will pollute the COinS metadata they produce; see Wikipedia:COinS. |
Usage
{{mono|text to format here}}
renders as:
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 CSS code. It is a replacement for <tt>...</tt>
, which is an obsolete element under HTML5. (Non-conforming features)
This template 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 should not be used to indicate source code, nor for variables or variable input (use {{code}} or <code>...</code>
for code and {{var}} or <var>...</var>
for variables). For keyboard or samples, use <kbd>...</kbd>
or <samp>...</samp>
respectively.
It cannot be used to mark up multiple paragraphs, sections or other block elements, as it uses <span>
, which is an inline element. See {{monodiv}} and {{pre}} for a <div>
-based block version. Or, multiple instances of {{Mono}} can be invoked.
Parameters
There are two parameters:
|1=
or unnamed- The content to format as monospaced. If the content contains a
=
character, the parameter must be numbered or the template will break. For backward compatibility with an old, merged-in template, this parameter can also be called|2=
. |needs_review=yes
- Used (e.g. by bots or AWB scripts) to indicate replacement of now-obsolete
<tt>...</tt>
markup with{{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<code>...</code>
,<samp>...</samp>
, or<kbd>...</kbd>
.
See also