Template:Mono/doc: Difference between revisions

shortcuts: {{tt}} {{ttt}}
From wikiNonStop
Content added Content deleted
(překlad a editace)
 
(Noting problem with template in links)
Line 1: Line 1:
{{Languages|Template:Mono/doc}}
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{tlr|clear=right|monospace}}{{tsh|clear=right|tt|ttt}}
{{Uses TemplateStyles|Template:Mono/styles.css}}
{{tsh|tt|ttt}}
{{high-use}}
{{Uses TemplateStyles |Template:Mono/styles.css}}
{{COinS safe|n}}
{{-}}
== Usage ==


{{tlx|mono|<var>text to format here</var>}}
This template is for formatting short bits of content (the only parameter) as monospaced (nonproportional) text.

It is a replacement for <syntaxhighlight inline lang="html"><tt>...</tt></syntaxhighlight>, which is an obsolete element under HTML5.
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 ==
== TemplateData ==
{{Format TemplateData|<templatedata>
{{TemplateData header}}
<templatedata>
{
{
"description": "This template is for formatting short bits of content as monospaced text.",
"description": {
"en": "This template is for formatting short bits of content as monospaced text.",
"cs": "Tato šablona je určena pro formátování krátkých částí obsahu jako textu s neproporcionálním rozložením."
},
"format": "inline",
"format": "inline",
"params": {
"params": {
"1": {
"1": {
"label": {
"aliases": [
"en": "Content",
"2"
],
"cs": "Obsah"
"label": "Content",
},
"description": {
"description": "The content to format as monospaced.",
"en": "The content to format as monospaced.",
"cs": "Obsah, který se má formátovat jako jednoprostorový."
},
"required": true,
"required": true,
"type": "line"
"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>
</templatedata>}}


== See also ==
== See also ==
* {{tlx|code|inline{{=}}1}}
* {{tl|pre}}
* {{tlx|inline-code}}
* {{tl|code}}
* {{tlx|kbd}}
* {{tl|kbd}}
* {{tlx|samp}}
* {{tl|syntaxhighlight}}
* {{tlx|var}}
* {{tl|samp}}
* {{tl|var}}
* {{tl|param value}}

{{Semantic markup templates|show}}

<includeonly>{{Sandbox other||
<includeonly>{{Sandbox other||
<!-- CATEGORIES HERE, THANKS -->
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Formatting templates{{#translation:}}]]
[[Category:Typing-aid templates|{{PAGENAME}}]]
}}</includeonly>
}}</includeonly>

Revision as of 14:43, 26 April 2024

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 &#124; or {{!}}.

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

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 &#61;.) 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 documentation for this template used by VisualEditor and other tools.

Mono

INTERNAL: Fetch(Module:Text) package.lua:80: module 'Module:Text' not found

See also