Template:Ns/doc

This is a documentation subpage for Template:Ns.
It may contain usage information, categories and other content that is not part of the original template page.

Template:ns is designed to insert between 0 and 83 non-breaking spaces (non-linewrapping blank characters), rapidly, according to the number assigned as its first (unnamed) parameter. If this parameter is omitted or its value is not numeric, it inserts only three (3) non-breaking spaces.

Usage and examples

The following show several examples on each line:

Using text: Three{{ns}}spaces{{ns}}between{{ns}}each{{ns}}word

produces: Three spaces between each word

Using text: Ten{{ns|10}}eight{{ns|8}}six{{ns|6}}four{{ns|4}}!

produces: Ten eight six four !

The effect of the count, such as in "{{ns|30}}" is identical to putting 30 copies of " " into the text.

In translation of text to uppercase letters, the spacing is retained. Compare:

{{uc: Begin{{ns|4}}end }} → BEGIN END
{{uc: Begin{{spaces|4}}end }} → BEGIN&NBSP;&NBSP;&NBSP;&NBSP;END

For gaps wider than 83 spaces, then multiple instances can be used, such as "{{ns|80}}{{ns|10}}" to insert 90 non-breaking spaces.

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 text formatting. It uses the parser function "padleft:" to repeat " " several, or dozens, of times. Also, the parser-expansion depth has been kept limited, as only 5 levels deep, to allow use anywhere, to generate spaces in any complex templates or wikitables.

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

For text gaps wider than 83 spaces, then multiple instances of {ns} can be used, such as "{{ns|80}}{{ns|10}}" to insert 90 non-breaking spaces.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Ns in articles based on its TemplateData.

TemplateData for Ns

Inserts a given number of non breaking spaces.

Template parameters
Parameter		Description	Type	Status
Number	`1`	The number of spaces to insert. Must be less than 83. The default is three spaces.	String	optional