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.

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 File:Wikipedia-logo-v2.svg Style Sheets 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>...</code> or <source>...</source> for code and <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 {{Monoblock}} 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 File:Wikipedia-logo-v2.svg bots or File:Wikipedia-logo-v2.svg 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>.