Difference between revisions of "Template:Nowrap/doc"

From Summertime Saga Wiki
Jump to: navigation, search
m (Usage)
m (Handling equals sign or bar)
 
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{tlx|Nowrap}} or {{tlx|nowrap}} stops wrapping of specific text. Use this template sparingly. It prevents word wraps (line breaks) within text or inside a link which contains spaces, hyphens ("-"), or, in some browsers, parentheses. The size of the nowrapped text becomes the minimum width of that paragraph and that can negatively influence the ability of the page to adapt to smaller screens, or alternate representations of the content.
+
{{tlg|nowrap}} stops wrapping of specific text. Use this template sparingly. It prevents word wraps (line breaks) within text or inside a link which contains spaces, hyphens, or, in some browsers, parentheses. The size of the nowrapped text becomes the minimum width of that paragraph and that can negatively influence the ability of the page to adapt to smaller screens or alternate representations of the content.
  
 
== Usage ==
 
== Usage ==
  
: {{tlx|nowrap|these words stay together}}
+
: {{tlg|code=yes|nolink=yes|nowrap|these words stay together}}
: {{tlx|nowrap|a, b, c, or d.}}
+
: {{tlg|code=yes|nolink=yes|nowrap|a, b, c, or d.}}
: {{tlx|nowrap|merry-go-round}}
+
: {{tlg|code=yes|nolink=yes|nowrap|merry-go-round}}
: {{tlx|nowrap|[[wikipedia:Cascading Style Sheets|CSS]]}}
+
: {{tlg|code=yes|nolink=yes|nowrap|[[wikipedia:Cascading Style Sheets|CSS]]}}
: {{tlx|nowrap|[[#Examples|Examples section]]}}
+
: {{tlg|code=yes|nolink=yes|nowrap|[[#Examples|Examples section]]}}
  
 
== Examples ==
 
== Examples ==
  
{|class=wikitable style="width: 100%;"
+
{|class=wikitable style="width:100%;"
| "<code>They held <nowiki>{{Nowrap|10 kg (22 lb)}}</nowiki> in total.</code>"
+
| <code>They held <nowiki>{{nowrap|10 kg (22 lb)}}</nowiki> in total.</code>
<br/> May render like this:
+
* May render like this:
: They held {{Nowrap|10 kg (22 lb)}} <br/>in total.
+
:: They held {{nowrap|10 kg (22 lb)}}<br>in total.
<br/> Or like this:
+
* Or like this:
: They held <br/>10 kg (22 lb) in total.
+
:: They held<br>10 kg (22 lb) in total.
<br/> But ''not'' render like this:
+
* But not like this:
: They held 10 kg (22 <br/>lb) in total.
+
:: They held 10 kg (22<br>lb) in total.
| "<code>He encountered <nowiki>{{Nowrap|a tiger}}</nowiki> in the woods.</code>"
+
| <code>He encountered <nowiki>{{nowrap|a tiger}}</nowiki> in the woods.</code>
<br/> May render like this:
+
* May render like this:
: He encountered a tiger <br/>in the woods.
+
:: He encountered a tiger <br>in the woods.
<br/> Or like this:
+
* Or like this:
: He encountered <br/>a tiger in the woods.
+
:: He encountered<br>a tiger in the woods.
<br/> But ''not'' like this:
+
* But not like this:
: He encountered a <br/>tiger in the woods.
+
:: He encountered a<br>tiger in the woods.
 
|}
 
|}
  
== Handling equal-sign or bar ==
+
== Handling equals sign or bar ==
  
Templates have problems with parameter data that contains equal-signs "<code>=</code>" or vertical bars "<code>|</code>" (pipes). Note that this does not apply if the equal-sign "<code>=</code>" or vertical bar "<code>|</code>" is inside a wikilink or another template.  In the case that there is a bare equal-sign "<code>=</code>" or vertical bar "<code>|</code>", consider using {{tl|nowrap begin}} + {{tl|nowrap end}} instead. However, there are also other workarounds:
+
Templates have problems with parameter data that contains equals signs =or vertical bar (pipe) “|” characters. Note that this does not apply if the equals sign or vertical bar is inside a wikilink or another template. However, there are workarounds:
  
For text that includes an equal-sign "=", precede the text with <code>1=</code>, use a triple-brace unnamed parameter <code><nowiki>{{{|=}}}</nowiki></code>, or the <code><nowiki>{{=}}</nowiki></code> template.
+
For text that includes an equal‐sign “=, precede the text with {{para|1}}, use the template {{tlg|{{=}}}}.
  
{|class=wikitable style="width: 100%;"
+
{|class=wikitable style="width:100%;"
! Markup
+
! style="width:50%;" | Markup
 
! Renders as
 
! Renders as
 
|-
 
|-
 
| <code><nowiki>{{nowrap|</nowiki>1=2 + 2 = 4}}</code>
 
| <code><nowiki>{{nowrap|</nowiki>1=2 + 2 = 4}}</code>
| {{nowrap|1=2 + 2 = 4}}
 
|-
 
| <code><nowiki>{{nowrap|2 + 2 {{{|=}}} 4}}</nowiki></code>
 
 
| {{nowrap|1=2 + 2 = 4}}
 
| {{nowrap|1=2 + 2 = 4}}
 
|-
 
|-
Line 48: Line 45:
 
|}
 
|}
  
For text that includes a vertical bar "|", escape the bar(s) with "<code><nowiki>&amp;#124;</nowiki></code>" or "<code><nowiki>{{pipe}}</nowiki></code>" or "<code><nowiki>{{abs}}</nowiki></code>". For instance, put two bars "|6|" like this:
+
For text that includes a vertical bar |, escape the bar(s) with <code><nowiki>&amp;#124;</nowiki></code> or <code><nowiki>{{!}}</nowiki></code>. For instance, put two bars like this:
:<code><nowiki>{{nowrap|</nowiki>&amp;#124;6&amp;#124; < 7}}</code> &nbsp;or&nbsp; <code><nowiki>{{nowrap|{{pipe}}6{{pipe}} < 7}}</nowiki></code> &nbsp;or&nbsp; <code><nowiki>{{nowrap|{{abs|6}} < 7}}</nowiki></code>
 
  
Which renders this:  
+
{|class=wikitable style="width:100%;"
:{{nowrap|&#124;6&#124; < 7}}
+
! style="width:50%;" | Markup
 +
! Renders as
 +
|-
 +
| <code><nowiki>{{nowrap|</nowiki>&amp;#124;6&amp;#124; < 7}}</code>
 +
| {{nowrap|&#124;6&#124; < 7}}
 +
|-
 +
| <code><nowiki>{{nowrap|{{!}}6{{!}} < 7}}</nowiki></code>
 +
| {{nowrap|&#124;6&#124; < 7}}
 +
|}
  
 
== Technical details ==
 
== Technical details ==
Line 59: Line 63:
  
 
: {{code|lang=html|1=<span class="nowrap">This text will not wrap</span>}}
 
: {{code|lang=html|1=<span class="nowrap">This text will not wrap</span>}}
The class <code>nowrap</code> receives the CSS property {{code|lang=css|white-space: nowrap;}} in [[MediaWiki:Common.css]].
+
The class <code>nowrap</code> receives the CSS property {{code|lang=css|white-space:nowrap;}} in [[MediaWiki:Common.css]].
  
[[Category:Documentation subpages]]
+
[[Category:Templates]]
 +
[[Category:Templates documentation]]

Latest revision as of 16:46, 21 July 2020

{{nowrap}} stops wrapping of specific text. Use this template sparingly. It prevents word wraps (line breaks) within text or inside a link which contains spaces, hyphens, or, in some browsers, parentheses. The size of the nowrapped text becomes the minimum width of that paragraph and that can negatively influence the ability of the page to adapt to smaller screens or alternate representations of the content.

Usage

{{nowrap|these words stay together}}
{{nowrap|a, b, c, or d.}}
{{nowrap|merry-go-round}}
{{nowrap|CSS}}
{{nowrap|Examples section}}

Examples

They held {{nowrap|10 kg (22 lb)}} in total.
  • May render like this:
They held 10 kg (22 lb)
in total.
  • Or like this:
They held
10 kg (22 lb) in total.
  • But not like this:
They held 10 kg (22
lb) in total.
He encountered {{nowrap|a tiger}} in the woods.
  • May render like this:
He encountered a tiger
in the woods.
  • Or like this:
He encountered
a tiger in the woods.
  • But not like this:
He encountered a
tiger in the woods.

Handling equals sign or bar

Templates have problems with parameter data that contains equals signs “=” or vertical bar (pipe) “|” characters. Note that this does not apply if the equals sign or vertical bar is inside a wikilink or another template. However, there are workarounds:

For text that includes an equal‐sign “=”, precede the text with |1=, use the template {{=}}.

Markup Renders as
{{nowrap|1=2 + 2 = 4}} 2 + 2 = 4
{{nowrap|2 + 2 {{=}} 4}} 2 + 2 = 4

For text that includes a vertical bar “|”, escape the bar(s) with &#124; or {{!}}. For instance, put two bars like this:

Markup Renders as
{{nowrap|&#124;6&#124; < 7}} |6| < 7
{{nowrap|{{!}}6{{!}} < 7}} |6| < 7

Technical details

The actual code that does the job is this HTML tag that applies a class to the text inside the template:

<span class="nowrap">This text will not wrap</span>

The class nowrap receives the CSS property white-space:nowrap; in MediaWiki:Common.css.