View source for Template:Ns/doc

{{Hatnote |This template inserts [[Non-breaking space|non-breaking (non-linewrapping) space]]s. For the flag template "NS", see {{tl|NS}}. For the [[Help:Magic words|magic word]] "<nowiki>{{ns:}}</nowiki>", see [[mw:Help:Magic words#Namespaces_2]].}}
{{documentation subpage}}
{{High-use}}
[[Template:ns]] is designed to insert between 0 and 83 [[Non-breaking space|non-breaking (non-linewrapping) space]]s rapidly according to the number assigned as its first (unnamed) parameter. If this parameter is not supplied or its value is not numeric, it inserts a default three non-breaking spaces.

'''Do not insert huge numbers of non-breaking spaces to achieve a particular article layout. The width of non-breaking spaces varies between platforms and fonts, and on mobile devices (over half of readers) they are likely to make content overflow the available width.''' Differences between fonts make them unsuitable for precisely matching the width of any other text; consider {{tn|0}} to match the width of specific text.

===Usage and examples===
{{Aligned table |cols=3 |style=line-height:1.35em;
 |col1style=font-family:monospace;padding-left:1.4em; |col2style=font-size:90%;padding:0 2.0em;vertical-align:bottom;font-style:italic;
 | <nowiki> Three{{ns}}spaces{{ns}}between{{ns}}each{{ns}}word </nowiki> | produces: | Three{{ns}}spaces{{ns}}between{{ns}}each{{ns}}word
 | <nowiki> Ten{{ns|10}}eight{{ns|8}}six{{ns|6}}four{{ns|4}}!  </nowiki> | produces: | Ten{{ns|10}}eight{{ns|8}}six{{ns|6}}four{{ns|4}}!
}}

The effect of the count, such as in "{&#123;ns|30}}" is identical to putting 30 copies of "&amp;#160;" into the text.

In translation of text to uppercase letters, the spacing is retained. Compare:
::* <nowiki>{{uc: Begin{{ns|4}}end }}</nowiki> &rarr; {{uc: Begin{{ns|4}}end }}
::* <nowiki>{{uc: Begin{{spaces|4}}end }}</nowiki> &rarr; {{uc: Begin{{spaces|4}}end }}

===Performance considerations===
[[Template:ns]] has been designed to rapidly insert a few, or numerous, non-breaking spaces where wrapping is not wanted, such as to pad table headings or align some entries in columns. It has been clocked to run faster than 1,530x times per second (in December 2012). The number of spaces, from 0 to 83, does not affect the speed of formatting. It invokes the [[Help:Magic words#Parser functions|parser function]] "padleft:" to repeat "&amp;#160;" several, or dozens, of times. Also, the expansion depth has been kept limited, as only 5 levels deep, to allow use anywhere, to generate spaces in any complex templates or tables.

Beyond the maximum count of 83 spaces, the template truncates at 500-characters long (limited by padleft), with "&amp;#" at the end. The default count, as 3 spaces, was chosen because a 1-or-2-space gap is often coded as simply "&nbsp;&amp;nbsp;" and hence, 3 spaces is the first gap needing longer markup. The short template name, "ns" avoids transposing letters as "nsbp" for [[dyslexic]] users.

===TemplateData===
{{TemplateDataHeader}}

<templatedata>{
  "description": "Inserts a given number of non breaking spaces.",
  "params": {
    "1": {
      "label": "Number",
      "description": "The number of spaces to insert. Must be less than 83. The default is three spaces.",
      "type": "string",
      "required": false
    }
  }
}</templatedata>

===See also===
* [[Template:nowrap]], to join text or wikilinks as non-wrapped.
{{Inline spacing templates}}

<includeonly>{{Sandbox other||
[[Category:Inline spacing templates]]
}}</includeonly>