Template:Nowrap/doc

From Sapphire Wiki
Revision as of 22:34, 3 September 2013 by Bryan (talk | contribs) (1 revision)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


{{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]] }}
{{nowrap| [[Cascading Style Sheets|CSS]] }}
{{nowrap| [[#Examples|Examples section]] }}

The template names {{j}} (join) or {{nobr}} or {{nobreak}} may be used instead of "nowrap", as they are 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.

Handling equal-sign or bar

Templates have problems with parameter data that contains equal-signs "=" or vertical bars "|" (pipes). Note that this does not apply if the equal-sign "=" or vertical bar "|" is inside a wikilink or another template. In the case that there is a bare equal-sign "=" or vertical bar "|", consider using {{nowrap begin}} + {{nowrap end}} instead. However, there are also other workarounds:

For text that includes an equal-sign "=", precede the text with 1=, use a triple-brace unnamed parameter {{{|=}}}, or the {{=}} template. For example:

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

which all render as this:

2 + 2 = 4.

For text that includes a vertical bar "|", escape the bar(s) with "|" or "{{pipe}}" or "{{abs}}". For instance, put two bars "|6|" like this:

{{nowrap|&#124;6&#124; < 7}}  or  {{nowrap|{{pipe}}6{{pipe}} < 7}}  or  {{nowrap|{{abs|6}} < 7}}

Which renders this:

|6| < 7

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.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Nowrap

<templatedata>{

 "description": "Prevents word wraps (line breaks) within text or inside a link which contains spaces or hyphens (-).",
 "params": {
   "1": {
     "label": "Text",
     "description": "Text or link to be protected.",
     "type": "string",
     "required": true
   }
 }

}</templatedata>

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.