Difference between revisions of "Template:Spaced en dash/doc"

From Timelines
Jump to: navigation, search
(Added the "dot size reference list" and some other fixes.)
(More documentation. Long dashed lists etc.)
Line 10: Line 10:
 
=== Normal usage ===
 
=== Normal usage ===
  
The recommended usage is to use no space before the template
+
The recommended usage is to use ''no'' space before the template
 
and one space after the template, like this:
 
and one space after the template, like this:
 
  <nowiki>[[Salt]]{{ndash}} [[Pepper]]</nowiki>
 
  <nowiki>[[Salt]]{{ndash}} [[Pepper]]</nowiki>
Line 17: Line 17:
 
:[[Salt]] &ndash; [[Pepper]]
 
:[[Salt]] &ndash; [[Pepper]]
  
If it line breaks then the line break will come after the dash, not before, like this:
+
If it line breaks then the line break will come ''after'' the dash, not before, like this:
 
:[[Salt]] &ndash;  
 
:[[Salt]] &ndash;  
 
:[[Pepper]]
 
:[[Pepper]]
 +
 +
For long dashed lists each list item can be put on its own line, with no spaces between each item and the template. Like this:
 +
<pre><nowiki>
 +
[[Salt]]{{ndash}}
 +
[[Pepper]]{{ndash}}
 +
[[Curry]]{{ndash}}
 +
[[Saffron]]</nowiki></pre>
 +
 +
(It doesn't matter if there are no or some spaces at the end of the lines, after the templates.)
 +
 +
As before it will render one space on each side of the dashes, like this:
 +
:[[Salt]] &ndash; [[Pepper]] &ndash; [[Curry]] &ndash; [[Saffron]]
 +
 +
And if it line breaks then the line break will come ''after'' one of the dashes, not before, like this:
 +
:[[Salt]] &ndash; [[Pepper]] &ndash;
 +
:[[Curry]] &ndash; [[Saffron]]
  
 
=== Incorrect usage ===
 
=== Incorrect usage ===
  
If the template is used slightly wrong it will in most cases still behave well. Like these examples:
+
If the template is used slightly wrong it will in most cases still behave well. For instance if there are no or several spaces after the template. Like these examples:
  
 
  <nowiki>[[Salt]]{{ndash}}[[Pepper]]</nowiki>
 
  <nowiki>[[Salt]]{{ndash}}[[Pepper]]</nowiki>
Line 31: Line 47:
 
:[[Salt]] &ndash; [[Pepper]]
 
:[[Salt]] &ndash; [[Pepper]]
  
And it will still only line break after the dash, like this:
+
And it will still only line break ''after'' the dash, like this:
 
:[[Salt]] &ndash;  
 
:[[Salt]] &ndash;  
 
:[[Pepper]]
 
:[[Pepper]]
  
But if the template is used very wrong, like these examples:
+
But putting one or more spaces before the template can cause problems, like these examples:
 
  <nowiki>[[Salt]] {{ndash}}[[Pepper]]</nowiki>
 
  <nowiki>[[Salt]] {{ndash}}[[Pepper]]</nowiki>
 
  <nowiki>[[Salt]]  {{ndash}}[[Pepper]]</nowiki>
 
  <nowiki>[[Salt]]  {{ndash}}[[Pepper]]</nowiki>
Line 44: Line 60:
 
:[[Salt]] &ndash; [[Pepper]]
 
:[[Salt]] &ndash; [[Pepper]]
  
But if it line breaks it might break before the dash, like this:
+
But if it line breaks it might break ''before'' the dash, like this:
 
:[[Salt]]  
 
:[[Salt]]  
 
:&ndash; [[Pepper]]
 
:&ndash; [[Pepper]]

Revision as of 04:11, 12 August 2007

Template:Template doc page viewed directly

This template looks like this " – ".

It works similarly to the html markup sequence "&nbsp;&ndash; ". That is, a non-breaking space, a short dash and a normal space. However this template includes some extra code that makes it behave slightly better than the html markup sequence.

This template is used when you want something stronger than a bold middot "·" or a bullet "•", but shorter than a mdash "—".

Normal usage

The recommended usage is to use no space before the template and one space after the template, like this:

[[Salt]]{{ndash}} [[Pepper]]

It will render one space on each side of the dash, like this:

SaltPepper

If it line breaks then the line break will come after the dash, not before, like this:

Salt
Pepper

For long dashed lists each list item can be put on its own line, with no spaces between each item and the template. Like this:

 [[Salt]]{{ndash}}
 [[Pepper]]{{ndash}}
 [[Curry]]{{ndash}}
 [[Saffron]]

(It doesn't matter if there are no or some spaces at the end of the lines, after the templates.)

As before it will render one space on each side of the dashes, like this:

SaltPepperCurrySaffron

And if it line breaks then the line break will come after one of the dashes, not before, like this:

SaltPepper
CurrySaffron

Incorrect usage

If the template is used slightly wrong it will in most cases still behave well. For instance if there are no or several spaces after the template. Like these examples:

[[Salt]]{{ndash}}[[Pepper]]
[[Salt]]{{ndash}}   [[Pepper]]

Both of them will render exactly as before, with just one space on each side of the dash, like this:

SaltPepper

And it will still only line break after the dash, like this:

Salt
Pepper

But putting one or more spaces before the template can cause problems, like these examples:

[[Salt]] {{ndash}}[[Pepper]]
[[Salt]]   {{ndash}}[[Pepper]]
[[Salt]] {{ndash}} [[Pepper]]
[[Salt]]   {{ndash}}   [[Pepper]]

Then it will still only render just one space on each side of the dash, like this:

SaltPepper

But if it line breaks it might break before the dash, like this:

Salt
Pepper

Technical details

The space before the dash is a "non-wrapping" but "collapsing" space. That means it will not line break, but it will collapse together with normal spaces that come before the template to form one single space. It is not simply a &nbsp; since that one will not collapse.

The space after the dash is a normal space. That is it wraps and it collapses.

Dot size reference list

· <small> middot
· middot
· <small> bold middot
· bold middot
<small> bullet
bullet
bold bullet
ndash
mdash

See also

There are several other templates with similar functionality:

  • {{·}} - Bold middot "·" is mostly used for dotted lists.
  • {{•}} - Bullet "•" is mostly used for dotted lists that use small font sizes.
  • {{mdash}} - Mdash "—" is a long dash.