View source for Template:Mono/doc

{{Documentation subpage}}
<!--Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see [[Wikipedia:Wikidata]])-->
{{tlr|clear=right|monospace}}{{tsh|clear=right|tt|ttt}}
{{high-use}}
{{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>&lt;nowiki/&gt;</nowiki></code>, for example, to mark up <code><nowiki>{foo}</nowiki></code>, use {{tlc|mono|<nowiki>{foo}&lt;nowiki/&gt;</nowiki>}} or {{tlc|mono|<nowiki>&lt;nowiki&gt;{foo}&lt;/nowiki&gt;</nowiki>}}.

If the content contains pipe characters (<code>|</code>) not surrounded by {{tag|nowiki}}, they must be escaped with <code>&amp;#124;</code> or <code><nowiki>{{!}}</nowiki></code>.

This template should not be used in links as it can affect later transclusions.

=== 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>&amp;#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-->&lt;tt&gt;...&lt;/tt&gt;</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-->&lt;code&gt;...&lt;/code&gt;</code><!--nostrip-->, <code><!--nostrip-->&lt;samp&gt;...&lt;/samp&gt;</code><!--nostrip-->, or&nbsp;<code><!--nostrip-->&lt;kbd&gt;...&lt;/kbd&gt;</code><!--nostrip-->.",
			"autovalue": "yes",
			"type": "boolean"
		}
	}
}
</templatedata>}}

== See also ==
* {{tl|pre}}
* {{tl|var}}
* {{tl|code}}, which only provides syntax higlighting, without forbidding line breaks
* {{tl|Codett}}, wrapper for this template that removes background and border styling
* {{tl|PreCode}}, which forbids line breaks inside the code
* {{tl|param value}}, monospaced; friendly handling for blank space
* {{tl|Syntaxhighlight}}
* {{tl|kbd}}, for keyboard input

{{Semantic markup templates|show}}

<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata, thanks -->

[[Category:Typing-aid templates|{{PAGENAME}}]]
}}</includeonly>