Editing Template:Nowraplinks/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
__NOTOC__
This is the {{tl|nowraplinks}} template.

This template prevents word wraps (line breaks) inside links (links with spaces in) and only allows word wraps between the links and in normal text. This is useful for instance for long link lists. It works similarly to {{tl|nowrap}} and {{tl|nowrap begin}}.

This template takes no parameters by default, instead it works in pair with {{tl|nowraplinks end}}. It can also optionally be used with a parameter.

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

==== Usage ====

<pre><nowiki>
{{nowraplinks}}

[[This link will not wrap]] - [[This link also won't wrap]] -
[[And so on]] - But this sentence might word wrap.

{{nowraplinks end}}
</nowiki></pre>

<pre><nowiki>
{{nowraplinks | [[This link will not wrap]] - [[This link also won't wrap]] -
[[And so on]] - But this sentence might word wrap. }}
</nowiki></pre>

Both examples will render something like this:

:[[Template:Nowraplinks end|This link will not wrap]] - <br>
:[[Template:Nowraplinks end|This link also won't wrap]] - <br>
:[[Template:Nowraplinks end|And so on]] - But this sentence <br>
:might word wrap.

But they will ''not'' render like this:

:[[Template:Nowraplinks end|This link will not wrap]] - [[Template:Nowraplinks end|This link]]<br>
:[[Template:Nowraplinks end|shouldn't have wrapped]] - [[Template:Nowraplinks end|And so on]] -<br>
:But this sentence might word wrap.

=== Advanced usage ===

Most of the functionality in this template is implemented as a CSS class in [[MediaWiki:Common.css|common.css]]. That class can be used together with pretty much any HTML tag or any box to prevent links to word wrap. For instance like this:
:<code><nowiki><div class="nowraplinks"> Lots of text and links </div></nowiki></code>
Or like this:
:<code><nowiki><span class="nowraplinks"> Lots of text and links </span></nowiki></code>

If the nowraplinks class is applied in the header of a table it will prevent line wrapping of links in ''all'' cells in the table. Note that in a table header there usually is a need to apply several classes. Then the class names should be separated by spaces in the class tag, not by commas or semicolons. Like this:

<pre><nowiki>
{| class="wikitable nowraplinks"
|
[[This link will not wrap]]{{·}} 
[[This link also won't wrap]]{{·}} 
[[And so on]]{{·}} 
But this sentence might word wrap.
|
[[This link will not wrap]]{{·}} 
[[This link also won't wrap]]{{·}} 
[[And so on]]{{·}} 
But this sentence might word wrap.
|}
</nowiki></pre>

It will render this:

{| class="wikitable nowraplinks"
|-
|
[[Template:Nowraplinks end|This link will not wrap]]{{·}} 
[[Template:Nowraplinks end|This link also won't wrap]]{{·}} 
[[Template:Nowraplinks end|And so on]]{{·}} 
But this sentence might word wrap.
|
[[Template:Nowraplinks end|This link will not wrap]]{{·}} 
[[Template:Nowraplinks end|This link also won't wrap]]{{·}} 
[[Template:Nowraplinks end|And so on]]{{·}} 
But this sentence might word wrap.
|}

To really see the nowrap effect on the links above you can drag the width of your web browser window so it becomes smaller and smaller.

=== Technical details ===

The actual code that does the job is this CSS code in [[MediaWiki:Common.css|Common.css]]. 

<source lang="css">
.nowraplinks a,
.nowraplinks .selflink { 
  white-space: nowrap;
}
</source>

It simply means that any white-space inside links (HTML A tags) and bold "links" to the page itself are not allowed to wrap.

It is then invoked like this:
:<code><nowiki><span class="nowraplinks"> Lots of text and links </span></nowiki></code>

That span code is what the {{tl|nowraplinks}} and {{tl|nowraplinks end}} tags are packaging in an easy to use way.

The [[Template:Navbox|standard navboxes]] use the .nowraplinks class, thus automatically handling most wrapping problems in those navboxes.

In some cases link lists that use nowraplinks can behave weird in Firefox and Internet Explorer. Then use {{tl|nowrap begin}} and its helper templates instead.

=== See also ===

* {{tl|nowraplinks end}} – The other end of this template.
* {{tl|nowrap}} – A template with similar purpose.
* {{tl|nowrap begin}} – Prevents wraps in both text and links. For the really tricky wrapping cases when you need full control, for instance in very complex link lists.
* {{tn|·}} and {{tn|•}} – If you need dots/bullets for your link lists.
* [[Wikipedia:Line-break handling]] – The how-to guide detailing how to handle word wraps (line breaks) on Wikipedia. 

<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Wikipedia formatting and function templates|{{PAGENAME}}]]

<!-- ADD INTERWIKIS BELOW THIS LINE -->
[[et:Mall:Nowraplinks]]
[[ja:Template:Nowraplinks]]
</includeonly>