Template:Nowrap/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
mNo edit summary
(clarified, noting hyphens, plus "inside a link" to avoid confusion with verb "links"; noted redirects named "j" (join) & "nobr" & "nobreak"; new section "Examples" showing 3 cases in a table, etc.)
Line 1: Line 1:
{{documentation subpage}}
{{documentation subpage}}
__NOTOC__
__NOTOC__
This is the {{tl|nowrap}} template.
The '''[[Template:nowrap]]''' stops wrapping of specific text. It prevents word wraps (line breaks) within text or inside a link which contains spaces or hyphens ("-"). The size of the nowrapped text becomes the minimum width of that paragraph.
 
This template prevents word wraps (line breaks) in text and links that contain spaces.  


Before you use this template you might want to read up on [[Wikipedia:Line break handling]].
Before you use this template you might want to read up on [[Wikipedia:Line break handling]].


=== Usage ===
:: '''Usage''':  {{nowrap|these words stay together}}
 
:::: {{nowrap|a, b, c, or d.}}
<pre>
:::: {&#123;nowrap| merry-go-round }}
Lots of text {{nowrap|10 kg (22 lb)}} more text.
:::: <nowiki>{{nowrap| [[4-part harmony]]}}</nowiki>
</pre>
 
It may render like this:


:Lots of text 10 kg (22 lb)
For simplicity, the template names {&#123;[[Template:j|'''j''']]}} (join) or {&#123;[[Template:nobr|nobr]]}} or {&#123;[[Template:Nobreak|nobreak]]}} can be used, instead of "nowrap", as quick redirects to {&#123;nowrap}}.
:more text.


Or like this:
=== Examples ===
:Lots of text
{| class=wikitable
:10 kg (22 lb) more text.
|"They held <nowiki>{{nowrap|10 kg (22 lb)}}</nowiki> in total."
<br>May render like this:
:They held {{nowrap|10 kg (22 lb)}}<br>in total.
<br>Or like this:
:They held<br>10 kg (22 lb) in total.
<br>But ''not'' render like this:
:They held 10 kg (22 <br>lb) in total.


But it will ''not'' render like this:
| "He encountered <nowiki>{{nowrap|a tiger}}</nowiki> in the woods."
:Lots of text 10 kg (22
<br>May render like this:
:lb) more text.  
:He encountered a tiger<br>in the woods.
<br>Or like this:
:He encountered<br>a tiger in the woods.
<br>But ''not'' like this:
:He encountered a<br>tiger in the woods.


=== Handling interpreted characters ===
| We saw <nowiki>{{j |1 [[black rhino]]}} but {{j|800 [[zebra]]s}}.</nowiki>
<br>May render like this:
:We saw {{j |1 [[black rhino]]}} but<br>800 [[zebra]]s.
<br>Or like this:
:We saw {{j |1 [[black rhino]]}}<br>but 800 [[zebra]]s.
<br>But ''not'' render like this:
:We saw 1 [[black rhino|black<br>rhino]] but 800 [[zebra]]s.
|}
=== Handling equal-sign or bar ===


[[Help:Template|Templates]] have problems to handle parameter data that contains equal signs "<code>=</code>" or vertical bars "<code>|</code>". In such cases consider using {{tl|nowrap begin}} + {{tl|nowrap end}} instead. But there are also workarounds:
[[Help:Template|Templates]] have problems to handle parameter data that contains [[equal-sign]]s "<code>=</code>" or vertical bars "<code>|</code>" (pipes). In such cases, consider using {{tl|nowrap begin}} + {{tl|nowrap end}} instead. But there are also workarounds:


For text that includes an equal sign "=", precede the text with <code>1=</code>. For example:
For text that includes an equal-sign "=", precede the text with <code>1=</code>. For example:
:<code><nowiki>{{nowrap|</nowiki>1=2 + 2 = 4}}</code>
:<code><nowiki>{{nowrap|</nowiki>1=2 + 2 = 4}}</code>


Line 36: Line 48:
:{{nowrap|1=2 + 2 = 4}}
:{{nowrap|1=2 + 2 = 4}}


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 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 "|2|" like this:
:<code><nowiki>{{nowrap|</nowiki>&amp;#124;2&amp;#124; < 3}}</code>
:<code><nowiki>{{nowrap|</nowiki>&amp;#124;2&amp;#124; < 3}}</code> &nbsp;or&nbsp; <code><nowiki>{{nowrap|{{!}}2{{!}} < 3}}</nowiki></code>
 
Or like this:
:<code><nowiki>{{nowrap|{{!}}2{{!}} < 3}}</nowiki></code>


Which renders this:  
Which renders this:  
Line 51: Line 60:
:<code><nowiki><span style="white-space:nowrap">This text will not wrap</span></nowiki></code>
:<code><nowiki><span style="white-space:nowrap">This text will not wrap</span></nowiki></code>


Spaces at the beginning or end of your text will fall outside the no-wrap tag in the rendered text due to Wikimedia rendering mechanisms.
Spaces at the beginning or end of the text will fall outside the no-wrap tag in the rendered text due to Wikimedia rendering mechanisms.


{{tl|nobr}} and {{tl|nobreak}} redirect here.
The templates {{[[Template:j|j]]}}, {{[[Template:nobr|nobr]]}} and {{[[Template:Nobreak|nobreak]]}} redirect here.


=== See also ===
=== See also ===

Revision as of 14:20, 7 January 2011


The Template:nowrap stops wrapping of specific text. It prevents word wraps (line breaks) within text or inside a link which contains spaces or hyphens ("-"). The size of the nowrapped text becomes the minimum width of that paragraph.

Before you use this template you might want to read up on Wikipedia:Line break handling.

Usage:  {{nowrap|these words stay together}}
{{nowrap|a, b, c, or d.}}
{{nowrap| merry-go-round }}
{{nowrap| [[4-part harmony]]}}

For simplicity, the template names {{j}} (join) or {{nobr}} or {{nobreak}} can be used, instead of "nowrap", as quick redirects to {{nowrap}}.

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 render 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.
We saw {{j |1 [[black rhino]]}} but {{j|800 [[zebra]]s}}.


May render like this:

We saw Template:J but
800 zebras.


Or like this:

We saw Template:J
but 800 zebras.


But not render like this:

We saw 1 black
rhino
but 800 zebras.

Handling equal-sign or bar

Templates have problems to handle parameter data that contains equal-signs "=" or vertical bars "|" (pipes). In such cases, consider using {{nowrap begin}} + {{nowrap end}} instead. But there are also workarounds:

For text that includes an equal-sign "=", precede the text with 1=. For example:

{{nowrap|1=2 + 2 = 4}}

Which renders this:

2 + 2 = 4

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

{{nowrap|&#124;2&#124; < 3}}  or  {{nowrap|{{!}}2{{!}} < 3}}

Which renders this:

|2| < 3

Technical details

The actual code that does the job is this HTML+CSS code:

<span style="white-space:nowrap">This text will not wrap</span>

Spaces at the beginning or end of the text will fall outside the no-wrap tag in the rendered text due to Wikimedia rendering mechanisms.

The templates {{j}}, {{nobr}} and {{nobreak}} redirect here.

See also

  • {{nowraplinks}} – Prevents wraps inside links and only allows wraps between the links and in normal text. Very useful for link lists and easy to use.
  • {{nowrap begin}} – Prevents wraps in both text and links. For the trickier wrapping cases when you need full control, for instance in very complex link lists.
  • Wikipedia:Line break handling – The how-to guide detailing how to handle word wraps (line breaks) on Wikipedia.