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

From Timelines
Jump to: navigation, search
(per move)
(added an necessary space in the normal usage example, minor source cleanup)
Line 10: Line 10:
 
This template is used when you want something stronger than a [[Template:·|bold middot]] "'''·'''" or a [[Template:•|bullet]] "•", but shorter than an [[Template:Mdash|mdash]] "—". (An en dash is half the width of an [[Dash#Em dash|em dash]].)
 
This template is used when you want something stronger than a [[Template:·|bold middot]] "'''·'''" or a [[Template:•|bullet]] "•", but shorter than an [[Template:Mdash|mdash]] "—". (An en dash is half the width of an [[Dash#Em dash|em dash]].)
  
For horizontal lists use {{tl|Flatlist}} or <code>class="hlist"</code> instead (see [[WP:HLIST]]).
+
For horizontal lists use {{tl|Flatlist}} or <code>class="hlist"</code> instead (see [[WP:HLIST]]).
  
== Normal usage ==
+
==Normal usage==
 
+
The recommended usage is to use ''no'' space before the template and one space after the template, like this:
The recommended usage is to use ''no'' space before the template
+
  <nowiki>[[Salt]]{{spaced ndash}} [[Pepper]]</nowiki>
and one space after the template, like this:
 
  <nowiki>[[Salt]]{{spaced ndash}}[[Pepper]]</nowiki>
 
  
 
It will render one space on each side of the dash, like this:
 
It will render one space on each side of the dash, like this:
 
:[[Salt]] &ndash; [[Black pepper|Pepper]]
 
:[[Salt]] &ndash; [[Black pepper|Pepper]]
  
If it line breaks then the line break will come ''after'' the dash, not before, like this:
+
A line break will come ''after'' one of the dashes, not before, when the spacing is used as suggested, like this:
:[[Salt]] &ndash;
 
:[[Black pepper|Pepper]]
 
 
 
If it line breaks then the line break will come ''after'' one of the dashes, not before, like this:
 
 
:[[Salt]] &ndash; [[Black pepper|Pepper]] &ndash;  
 
:[[Salt]] &ndash; [[Black pepper|Pepper]] &ndash;  
 
:[[Curry]] &ndash; [[Saffron]]
 
:[[Curry]] &ndash; [[Saffron]]
 +
 
{| class="wikitable" style="border: none; background: none;"
 
{| class="wikitable" style="border: none; background: none;"
|Colspan=2 |<center>Here's an example of how it's used</center>
+
|Colspan=2 |<center>Here's an example of how it is used</center>
 
|-
 
|-
|| Template Spaced ndash is not really intended to be used in article text; it's intended for use in other templates, tables, lists and other equivalent things, in order to include a separator between items such as in infoboxes. It's also to be consistent so that the article editor can use their choice of '''<nowiki>{{</nowiki>bull}}''', '''<nowiki>{{</nowiki>dot}}''', '''<nowiki>{{</nowiki>mdash}}''', '''<nowiki>{{</nowiki>middot}}''', or  '''<nowiki>{{</nowiki>spaced ndash}}''' and not have to insert the {{bull}}, {{dot}}, {{mdash}}, {{middot}}, or {{ndash}} symbol, they can use any of these as a simple macro. The idea being that if you have a table with a list of items, you can insert a spaced short dash (or the other symbols) between items that will appear correct, in that the items always have just one separator between them, and when a list crawls to the next line, the dash hangs onto the prior item instead of rolling over to the next line. Notice on the end of this box, the symbol hangs on the end of the last item that will fit on the line indicating that additional items follow on the next line as part of this list, but the item only stays on the line if the item and the dash will fit.  See the column on the right.  In code it's ''' Item1<nowiki>{{</nowiki>spaced ndash}} Item2<nowiki>{{</nowiki>spaced ndash}} Item3<nowiki>{{</nowiki>spaced ndash}} Item4<nowiki>{{</nowiki>spaced ndash}} Item5<nowiki>{{</nowiki>spaced ndash}}''' etc. (with some smaller items squeezed in to show that the list doesn't have to be the same number of items per line) but in the box they all fold perfectly once it runs out of space on the line to fit the next item and the dash following.
+
|| Template "Spaced ndash" is not really intended to be used in article text but for use in other templates, tables, lists, and other equivalent things in order to include a separator between items such as in infoboxes. It is also to be consistent so that the article editor can use their choice of '''<nowiki>{{</nowiki>bull}}''', '''<nowiki>{{</nowiki>dot}}''', '''<nowiki>{{</nowiki>mdash}}''', '''<nowiki>{{</nowiki>middot}}''', or  '''<nowiki>{{</nowiki>spaced ndash}}''' and not have to insert the {{bull}}, {{dot}}, {{mdash}}, {{middot}}, or {{ndash}} symbol, they can use any of these as a simple macro. The idea being that if you have a table with a list of items, you can insert a spaced short dash (or the other symbols) between items that will appear correct, in that the items always have just one separator between them, and when a list crawls to the next line, the dash hangs onto the prior item instead of rolling over to the next line. Notice on the end of this box, the symbol hangs on the end of the last item that will fit on the line indicating that additional items follow on the next line as part of this list, but the item only stays on the line if the item and the dash will fit.  See the column on the right.  In code it is ''' Item1<nowiki>{{</nowiki>spaced ndash}} Item2<nowiki>{{</nowiki>spaced ndash}} Item3<nowiki>{{</nowiki>spaced ndash}} Item4<nowiki>{{</nowiki>spaced ndash}} Item5<nowiki>{{</nowiki>spaced ndash}}''' etc. (with some smaller items squeezed in to show that the list does not have to be the same number of items per line) but in the box they all fold perfectly once it runs out of space on the line to fit the next item and the dash following.
 
| <p>Normally, in a real box these items would be links, but this is an example.</p> Item1{{spaced ndash}} A{{spaced ndash}} B{{spaced ndash}} Item2{{spaced ndash}} Item3{{spaced ndash}} Item4{{spaced ndash}} Item5{{spaced ndash}} extra item{{spaced ndash}} E{{spaced ndash}} 1{{spaced ndash}} 2{{spaced ndash}} 3{{spaced ndash}} 4{{spaced ndash}} 5{{spaced ndash}} 6{{spaced ndash}} 7{{spaced ndash}} {{nobr|item that won't attach to prior line unless it fits in the remaining space{{spaced ndash}}}} Q{{spaced ndash}} A slightly longer item{{spaced ndash}} KK{{spaced ndash}} An obviously really even longer item that the dash will hang at its end{{spaced ndash}} Item6{{spaced ndash}} C{{spaced ndash}} Item7{{spaced ndash}} Item8{{spaced ndash}} Item9{{spaced ndash}} Item10{{spaced ndash}} Item11{{spaced ndash}} Item12{{spaced ndash}} D{{spaced ndash}} Item13{{spaced ndash}} Item14{{spaced ndash}} Item15{{spaced ndash}} Item16{{spaced ndash}} Item17{{spaced ndash}} Item18 <p>The space on the end makes sure the dash doesn't touch the edge of the box, either</p>
 
| <p>Normally, in a real box these items would be links, but this is an example.</p> Item1{{spaced ndash}} A{{spaced ndash}} B{{spaced ndash}} Item2{{spaced ndash}} Item3{{spaced ndash}} Item4{{spaced ndash}} Item5{{spaced ndash}} extra item{{spaced ndash}} E{{spaced ndash}} 1{{spaced ndash}} 2{{spaced ndash}} 3{{spaced ndash}} 4{{spaced ndash}} 5{{spaced ndash}} 6{{spaced ndash}} 7{{spaced ndash}} {{nobr|item that won't attach to prior line unless it fits in the remaining space{{spaced ndash}}}} Q{{spaced ndash}} A slightly longer item{{spaced ndash}} KK{{spaced ndash}} An obviously really even longer item that the dash will hang at its end{{spaced ndash}} Item6{{spaced ndash}} C{{spaced ndash}} Item7{{spaced ndash}} Item8{{spaced ndash}} Item9{{spaced ndash}} Item10{{spaced ndash}} Item11{{spaced ndash}} Item12{{spaced ndash}} D{{spaced ndash}} Item13{{spaced ndash}} Item14{{spaced ndash}} Item15{{spaced ndash}} Item16{{spaced ndash}} Item17{{spaced ndash}} Item18 <p>The space on the end makes sure the dash doesn't touch the edge of the box, either</p>
 
|}
 
|}
  
== Incorrect usage ==
+
==Incorrect usage==
 
 
 
If the template is used slightly wrong it will in some cases still behave well. For instance if there are no or several spaces after the template. Like these examples:
 
If the template is used slightly wrong it will in some cases still behave well. For instance if there are no or several spaces after the template. Like these examples:
  
Line 45: Line 39:
 
:[[Salt]] &ndash; [[Black pepper|Pepper]]
 
:[[Salt]] &ndash; [[Black pepper|Pepper]]
  
And it will still only line break ''after'' the dash, like this:
+
And it will still only line break ''after'' a dash, like this:
 
:[[Salt]] &ndash;  
 
:[[Salt]] &ndash;  
 
:[[Black pepper|Pepper]]
 
:[[Black pepper|Pepper]]
  
But putting one or more spaces before the template will cause problems, like these examples:
+
But putting one or more spaces ''before'' the template will cause problems, like these examples:
 
  <nowiki>[[Salt]] {{spaced ndash}}[[Pepper]]</nowiki>
 
  <nowiki>[[Salt]] {{spaced ndash}}[[Pepper]]</nowiki>
 
  <nowiki>[[Salt]]  {{spaced ndash}}[[Pepper]]</nowiki>
 
  <nowiki>[[Salt]]  {{spaced ndash}}[[Pepper]]</nowiki>
Line 66: Line 60:
 
Because Wikipedia suppresses the contents of templates in tool tip preview when the user hovers the pointer over a Wikilink, one should avoid using the Ndash template in an article's lead section. Using the template will cause a confusing blank space to appear in the tool tip preview instead of the expected en dash character.  Instead, use <code><nowiki>&amp;nbsp;&amp;ndash; </nowiki></code> or <code><nowiki>&amp;nbsp;– </nowiki></code>, and be sure to add the trailing space.
 
Because Wikipedia suppresses the contents of templates in tool tip preview when the user hovers the pointer over a Wikilink, one should avoid using the Ndash template in an article's lead section. Using the template will cause a confusing blank space to appear in the tool tip preview instead of the expected en dash character.  Instead, use <code><nowiki>&amp;nbsp;&amp;ndash; </nowiki></code> or <code><nowiki>&amp;nbsp;– </nowiki></code>, and be sure to add the trailing space.
  
== Technical details ==
+
==Technical details==
 
 
 
The space before the dash is a [[non-breaking space]]. That means it will not line break and will not collapse together with normal spaces that come before the template.
 
The space before the dash is a [[non-breaking space]]. That means it will not line break and will not collapse together with normal spaces that come before the template.
  
 
The space after the dash is a normal space. That means it wraps (allows line breaks) and it will collapse together with normal spaces that come after the template to form one single space.
 
The space after the dash is a normal space. That means it wraps (allows line breaks) and it will collapse together with normal spaces that come after the template to form one single space.
  
== Dot sizes ==
+
==Dot sizes==
 
{{Dot size}}
 
{{Dot size}}
  
== See also ==
+
==See also==
 
 
 
There are several other templates with similar functionality:
 
There are several other templates with similar functionality:
  
Line 85: Line 77:
  
 
<includeonly>
 
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
 
[[Category:Wikipedia formatting and function templates|{{PAGENAME}}]]
 
[[Category:Wikipedia formatting and function templates|{{PAGENAME}}]]
  
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
 
[[as:Template:Ndash]]
 
[[as:Template:Ndash]]
 
[[et:Mall:Ndash]]
 
[[et:Mall:Ndash]]
Line 95: Line 85:
 
[[sl:Predloga:Ndash]]
 
[[sl:Predloga:Ndash]]
 
[[tr:Şablon:&ndash;]]
 
[[tr:Şablon:&ndash;]]
 
 
</includeonly>
 
</includeonly>

Revision as of 06:21, 6 April 2012

This is the spaced ndash template, it looks like this " – ".

It works similarly to the HTML markup sequence "&nbsp;&ndash; ". That is, a non-breaking space, a short dash (known as an en dash) and a normal space.

{{–}} and {{endash}} redirect here and can be used as alternative names for this template.

This template is used when you want something stronger than a bold middot "·" or a bullet "•", but shorter than an mdash "—". (An en dash is half the width of an em dash.)

For horizontal lists use {{Flatlist}} or class="hlist" instead (see WP:HLIST).

Normal usage

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

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

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

SaltPepper

A line break will come after one of the dashes, not before, when the spacing is used as suggested, like this:

SaltPepper
CurrySaffron
Here's an example of how it is used
Template "Spaced ndash" is not really intended to be used in article text but for use in other templates, tables, lists, and other equivalent things in order to include a separator between items such as in infoboxes. It is also to be consistent so that the article editor can use their choice of {{bull}}, {{dot}}, {{mdash}}, {{middot}}, or {{spaced ndash}} and not have to insert the  • ,  · , Template:Mdash,  · , or Template:Ndash symbol, they can use any of these as a simple macro. The idea being that if you have a table with a list of items, you can insert a spaced short dash (or the other symbols) between items that will appear correct, in that the items always have just one separator between them, and when a list crawls to the next line, the dash hangs onto the prior item instead of rolling over to the next line. Notice on the end of this box, the symbol hangs on the end of the last item that will fit on the line indicating that additional items follow on the next line as part of this list, but the item only stays on the line if the item and the dash will fit. See the column on the right. In code it is Item1{{spaced ndash}} Item2{{spaced ndash}} Item3{{spaced ndash}} Item4{{spaced ndash}} Item5{{spaced ndash}} etc. (with some smaller items squeezed in to show that the list does not have to be the same number of items per line) but in the box they all fold perfectly once it runs out of space on the line to fit the next item and the dash following.

Normally, in a real box these items would be links, but this is an example.

Item1Template:Spaced ndash ATemplate:Spaced ndash BTemplate:Spaced ndash Item2Template:Spaced ndash Item3Template:Spaced ndash Item4Template:Spaced ndash Item5Template:Spaced ndash extra itemTemplate:Spaced ndash ETemplate:Spaced ndash 1Template:Spaced ndash 2Template:Spaced ndash 3Template:Spaced ndash 4Template:Spaced ndash 5Template:Spaced ndash 6Template:Spaced ndash 7Template:Spaced ndash Template:Nobr QTemplate:Spaced ndash A slightly longer itemTemplate:Spaced ndash KKTemplate:Spaced ndash An obviously really even longer item that the dash will hang at its endTemplate:Spaced ndash Item6Template:Spaced ndash CTemplate:Spaced ndash Item7Template:Spaced ndash Item8Template:Spaced ndash Item9Template:Spaced ndash Item10Template:Spaced ndash Item11Template:Spaced ndash Item12Template:Spaced ndash DTemplate:Spaced ndash Item13Template:Spaced ndash Item14Template:Spaced ndash Item15Template:Spaced ndash Item16Template:Spaced ndash Item17Template:Spaced ndash Item18

The space on the end makes sure the dash doesn't touch the edge of the box, either

Incorrect usage

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

[[Salt]]{{spaced ndash}}[[Pepper]]
[[Salt]]{{spaced 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 a dash, like this:

Salt
Pepper

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

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

Then it will render with two spaces before the dash, and one after, like this:

Salt  – Pepper

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

Salt
 – Pepper

Also, this template should not routinely be used in regular article text and certainly not where an em dash would be more appropriate. As a rule, this template should not be used between clauses of a sentence.

Because Wikipedia suppresses the contents of templates in tool tip preview when the user hovers the pointer over a Wikilink, one should avoid using the Ndash template in an article's lead section. Using the template will cause a confusing blank space to appear in the tool tip preview instead of the expected en dash character. Instead, use &nbsp;&ndash; or &nbsp;– , and be sure to add the trailing space.

Technical details

The space before the dash is a non-breaking space. That means it will not line break and will not collapse together with normal spaces that come before the template.

The space after the dash is a normal space. That means it wraps (allows line breaks) and it will collapse together with normal spaces that come after the template to form one single space.

Dot sizes

· middot
· bold {{middot}}
small bullet
{{bullet}}
bold bullet
{{en dash}}
{{em dash}}

See also

There are several other templates with similar functionality:

  • {{·}} – Bold middot "·"
  • {{•}} – Bullet "•"
  • &minus; – Minus "−" is a mathematical symbol
  • {{mdash}} – Mdash "—" is an em dash, a longer dash