Difference between revisions of "Template:Mono/doc"
From LIMSWiki
Jump to navigationJump to searchShawndouglas (talk | contribs) (Created as needed.) |
Shawndouglas (talk | contribs) (Updated) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- PLEASE ADD CATEGORIES | <!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE --> | ||
{{Uses TemplateStyles |Template:Mono/styles.css}} | |||
== Usage == | == Usage == | ||
{{tlx| | {{tlx|mono|<var>text to format here</var>}} | ||
renders as: | renders as: | ||
{{ | {{mono|text to format here}} | ||
It | 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 ''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 {{tag|code}} for code and {{tag|var}} for variables). For keyboard or samples, use {{tag|kbd}} or {{tag|samp}} respectively. | |||
It ''cannot'' be used to mark up multiple paragraphs, sections or other block elements, as it uses {{tag|span|o}}, which is an inline element. See {{tl|Pre}} for a <code><div></code>-based block version. Or, multiple instances of {{tl|Mono}} can be invoked. | |||
:{{para|needs_review|yes}} | === 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. 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}}. | |||
== See also == | == See also == | ||
* [[Template: | * [[Template:Pre]] | ||
* [[Template: | * [[Template:Code]] | ||
* [[Template:Kbd]] | |||
* [[Template:Samp]] | |||
* [[Template:Var]] | |||
<includeonly> | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | ||
<!-- CATEGORIES | <!-- CATEGORIES HERE, THANKS --> | ||
[[Category:Typing-aid templates|{{PAGENAME}}]] | [[Category:Typing-aid templates|{{PAGENAME}}]] | ||
</includeonly> | }}</includeonly> | ||
Latest revision as of 17:33, 10 March 2020
 |
This is a documentation subpage for Template:Mono. It contains usage information, categories, interlanguage links, and other content that is not part of the original template page. |
 | This template uses TemplateStyles: |
Usage
{{mono|text to format here}}
renders as:
Page Template:Mono/styles.css must have content model "Sanitized CSS" for TemplateStyles (current model is "wikitext").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>...</code> 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 {{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
