Template:Mono/doc
This is a documentation subpage for Template:Mono. It contains usage information, categories and other content that is not part of the original template page. |
This template is used in MediaWiki:Abusefilter-disallowed-semicolon, and on approximately 16,000 pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
Lua error: bad argument #1 to "get" (not a valid title).
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:
Page Template:Mono/styles.css has no content.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 sample output, 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.
When the content ends with a single closing curly brace (}
), the content should be followed by <nowiki/>
, for example, to mark up {foo}
, use {{mono|{foo}<nowiki/>}}
or {{mono|<nowiki>{foo}</nowiki>}}
.
If the content contains pipe characters (|
) not surrounded by <nowiki>...</nowiki>
, they must be escaped with |
or {{!}}
.
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. (The parameter does not need to be numbered if the=
character is surrounded by<nowiki>...</nowiki>
, or if it is escaped as=
.) 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>
.
TemplateData
TemplateData for Mono
Parameter | Description | Type | Status | |
---|---|---|---|---|
Content | 1 2 | The content to format as monospaced. | Line | required |
Needs Review? | needs_review | 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> .
| Boolean | optional |
Format: inline
See also