Template:Nowrap begin/doc

Ini ing documentation subpage para king Template:Nowrap begin (see that page for the template itself).
Atin yang kabaluan (impormasyun), deng kategorya ampo reng aliwang laman tungkul king pamaggamit a yali parti ning original template page.

This is the {{nowrap begin}} template.

This template prevents word wraps (line breaks) in text and links with spaces in. It is designed to handle the really tricky wrapping cases where you need full control. For instance in very complex long link lists. It works similarly to {{nowrap}} and {{nowraplinks}}.

This template takes no parameters, instead it works in pair with {{nowrap end}}.

Helper templates

This template has a number of helper templates which allows you to tell the web browser exactly where line breaks may occur:

Note! These helper templates may only be used in sections surrounded by {{nowrap begin}} and {{nowrap end}} or they may cause weird behaviour of your page.

• {{wrap}} - Marks where a wrap may occur.
• {{·wrap}} or {{·w}} - Looks like this: " · ". For dotted lists. Renders a bold middot surrounded by spaces and then marks that a wrap may occur after the midddot.
• {{•wrap}} or {{•w}} - Looks like this: " • ". For dotted lists that use small font and thus need a bigger dot. Renders a bullet surrounded by spaces and then marks that a wrap may occur after the bullet.
• {{–wrap}} or {{–w}} - Looks like this: " – ". For dashed lists. Renders a ndash surrounded by spaces and then marks that a wrap may occur after the ndash.
• {{!wrap}} or {{!w}} - Looks like this: " | ". For pipe separated lists. Renders a pipe surrounded by spaces and then marks that a wrap may occur after the pipe. The pipe used is not a real pipe but the code | so should work within wiki tables etc.
• {{\wrap}} or {{\w}} - Looks like this: " / ". For slash separated lists. Renders a slash surrounded by spaces and then marks that a wrap may occur after the slash. The "\" in the name leans the other way than the rendered slash "/" for wiki-technical reasons.

Usage

{{nowrap begin}}

[[Salt]] and{{wrap}} [[Pepper]] and{{wrap}} [[Curry]] 
and{{wrap}} [[Saffron]].{{wrap}} 
[[Salt]] and{{wrap}} [[Pepper]] and{{wrap}} [[Curry]] 
and{{wrap}} [[Saffron]]. 

{{nowrap end}}

It will render something like this:

Salt and Pepper and Curry and

Saffron. Salt and Pepper and

Curry and Saffron.

But it will not render like this:

Salt and Pepper and Curry

and Saffron. Salt and Pepper

and Curry and Saffron.

To make your code readable and easy to edit, you can put each wrappable "line" on its own line. And let's use some dots too. Like this:

{{nowrap begin}}

[[Salt]] and [[Pepper]]{{·wrap}} 
[[Pepper]] and [[Curry]]{{·wrap}} 
[[Curry]] and [[Saffron]]{{·wrap}} 
[[Saffron]] and [[Salt]]

{{nowrap end}}

It will render something like this:

Salt and Pepper · Pepper and Curry ·

Curry and Saffron · Saffron and Salt

But it will not render like this:

Salt and Pepper · Pepper

and Curry · Curry and Saffron

· Saffron and Salt

Examples

Here are the above examples in actual running code in a table. Try dragging the width of your web browser window so it becomes smaller and smaller and watch how the line wrapping behaves:

Salt and Pepper and Curry and Saffron. Salt and Pepper and Curry and Saffron.

Salt and Pepper Pepper and Curry Curry and Saffron Saffron and Salt

An example demonstrating all the helper templates:

Technical details

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

<span style="white-space:nowrap;"> Text and links </span> <span style="white-space:nowrap;"> More text and links </span>

It means that wraps may only happen in the unprotected space between the </span> and the <span ...>. That's what {{nowrap begin}} and its helper templates are packaging in an easy to use way.

{{·wrap}} and the other helper templates should not have any spaces or newlines before them or they will render two spaces before the dot. They tolerate anything from no to several spaces and even a newline after them and they will still only render one space after the dot. If a wrap occurs then the wrap will come after the dot, even if there are spaces before the helper template.

The {{·wrap}} causes problems if inside sections of bolded and/or italicised text. Do end the bold text before the {{·wrap}} and continue the bold text after it to avoid the problems. {{•wrap}} and the other helper templates only have this problem if the section is bolded and italicised at the same time.

See also

• {{nowrap end}} - The other end of this template.
• {{nowrap}} - A template with similar purpose.
• {{nowraplinks}} - Prevents wraps inside links and only allows wraps between the links and in normal text. Very useful for link lists and usually easier to use than this template.
• {{·}} and {{•}} - If you need dots/bullets when not using {{nowrap begin}}+{{nowrap end}}.
• Wikipedia:Line break handling - The how-to guide detailing how to handle word wraps (line breaks) on Wikipedia.