Template:Avoid wrap/doc

{{Avoid wrap}}, {{avoidwrap}} or {{awrap}} avoids wrapping of specific text.

To achieve the opposite effect of {{Avoid wrap}}, you can use {{wbr}}. For more information about wrapping and breaking sentences, see Wikipedia:Line-break handling.

Usage

{{Avoid wrap|these words stay together}}

{{Avoid wrap|a, b, c, or d.}}

{{Avoid wrap| merry-go-round }}

{{Avoid wrap| [[4-part harmony]] }}

{{Avoid wrap| [[Cascading Style Sheets|CSS]] }}

{{Avoid wrap| [[#Examples|Examples section]] }}

The template names {{Nobr}} and {{Nobreak}} are redirects that may be used instead of "{{Avoid wrap|…}}".

Examples

"They held {{Avoid wrap|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 {{Avoid wrap|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.

Controlling line-breaking in infoboxes

This template may be used with {{Wbr}} and {{Spaces}} to control line-breaking in bulletless lists in infoboxes, to prevent wrapped long entries from being confused with multiple entries. See Template:Wbr/doc#Controlling line-breaking in infoboxes for details.

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 {{Avoid wrap begin}} + {{Avoid wrap 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:

{{Avoid wrap|1=2 + 2 = 4}},
{{Avoid wrap|2 + 2 {{{|=}}} 4}}, or
{{Avoid wrap|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:

{{Avoid wrap|&#124;6&#124; < 7}}  or  {{Avoid wrap|{{pipe}}6{{pipe}} < 7}}  or  {{avoid wrap|{{abs|6}} < 7}}

Which renders this:

|6| < 7

Technical details

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

<syntaxhighlight lang="html" enclose="none">This text will not wrap</syntaxhighlight>

When there is not enough remaining space on a line to fit the contents of such as block, it will be pushed to the next line in its entirety. However when the block in itself doesn't fit on a single line, line breaking still applies to the 'internal' text block. This is especially advantageous for mobile rendering where the available line width might be much smaller than on desktops and might require line breaks to make longer words or sections fit.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Avoid wrap

<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>