Difference between revisions of "Template:Nowrap/doc"

← Older edit

Template:Nowrap/doc (view source)

Revision as of 15:12, 3 February 2009

2,237 bytes added , 15:12, 3 February 2009

m

1 revision

Budlight

Bots, Bureaucrats, Administrators

529

edits

@@ Line 1: / Line 1: @@
-{{Documentation subpage}}
+{{documentation subpage}}
-<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+__NOTOC__
+This is the {{tl|nowrap}} template.
-This is the {{tl|ombox/core}} helper meta-template.
+This template prevents word wraps (line breaks) in text and links that contain spaces.
-Do not use this template directly, use {{tl|ombox}} instead.
+Before you use this template you might want to read up on [[Wikipedia:Line break handling]].
-This template is called from {{tl|ombox}}. It holds most of the code for {{tlf|ombox}}, while {{tlf|ombox}} does parameter preprocessing. Thus simplifying the code in {{tlf|ombox/core}}.
+=== Usage ===
-For more documentation see {{tl|ombox}}.
+<pre>
+Lots of text {{nowrap|10 kg (22 lb)}} more text.
+</pre>
+It may render like this:
+:Lots of text 10 kg (22 lb)
+:more text.
+Or like this:
+:Lots of text
+:10 kg (22 lb) more text.
+But it will ''not'' render like this:
+:Lots of text 10 kg (22
+:lb) more text.
+=== Handling interpreted characters ===
+[[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:
+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>
+Which renders this:
+:{{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:
+:<code><nowiki>{{nowrap|</nowiki>&amp;#124;2&amp;#124; < 3}}</code>
+Or like this:
+:<code><nowiki>{{nowrap|{{!}}2{{!}} < 3}}</nowiki></code>
+Which renders this:
+:{{nowrap|&#124;2&#124; < 3}}
+=== Technical details ===
+The actual code that does the job is this HTML+CSS 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.
+{{tl|nobr}} and {{tl|nobreak}} redirect here.
+=== See also ===
+* {{tl|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.
+* {{tl|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.
 <includeonly>
-<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+{{pp-template|small=yes}}
-[[Category:Wikipedia metatemplates|{{PAGENAME}}]]
+<!-- ADD CATEGORIES BELOW THIS LINE -->
+[[Category:Wikipedia formatting and function templates|{{PAGENAME}}]]
+<!-- ADD INTERWIKIS BELOW THIS LINE -->
+[[ar:قالب:لا لف]]
+[[da:Skabelon:Nowrap]]
+[[de:Vorlage:Zeile]]
+[[es:Plantilla:Nowrap]]
+[[fr:Modèle:Nobr]]
+[[he:תבנית:ללא גלישה]]
+[[hr:Predložak:Nowrap]]
+[[hsb:Předłoha:Nowrap]]
+[[it:Template:Tutto attaccato]]
+[[ja:Template:Nowrap]]
+[[no:mal:Nowrap]]
+[[pl:Szablon:Nowrap]]
+[[ro:Format:Nowrap]]
+[[ru:Шаблон:Nobr/Документация]]
+[[sv:Mall:Nowrap]]
 </includeonly>