Template:Mono/doc

The pages listed in this category are templates.

This page is part of OODA WIKI's administration and not part of the encyclopedia.

Further template category notes

This category contains pages in the template namespace. It should not be used to categorize articles or pages in other namespaces.

To add a template to this category:

• If the template has a separate documentation page (usually called "Template:template name/doc"), add
•  [[Template:Mono/doc]]
• to the <includeonly> section at the bottom of that page. Otherwise, add
•  <noinclude>[[Template:Mono/doc]]</noinclude>
• to the end of the template code, making sure it starts on the same line as the code's last character.

This category is an index of templates which use TemplateStyles. It is automatically populated by {{Uses TemplateStyles}}.

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 information with these semantics:

• source code, use {{code}} or ‎<code>...‎</code> instead
• variables or variable input, use {{var}} or ‎<var>...‎</var> instead
• keyboard input, use {{kbd}} or ‎<kbd>...‎</kbd> instead
• sample output, use {{samp}} or ‎<samp>...‎</samp> instead

It cannot be used to mark up multiple paragraphs, sections or other block elements, as it uses ‎<span>, which is an inline element. Use {{monodiv}} and {{pre}} for multiple blocks of text, or use multiple instances of {{Mono}} for each individual line.

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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Mono

This template is for formatting short bits of content as monospaced text.

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>. Auto value yes	Boolean	optional

Format: inline

See also

• {{pre}}
• {{code}}
• {{kbd}}
• {{syntaxhighlight}}
• {{samp}}
• {{var}}
• {{param value}}