Difference between revisions of "Template:Spaced en dash/doc"
(expanded) |
(Reworked the documentation.) |
||
| Line 2: | Line 2: | ||
<noinclude>{{template doc page viewed directly}}</noinclude> | <noinclude>{{template doc page viewed directly}}</noinclude> | ||
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | ||
| − | This template | + | __NOTOC__ |
| + | 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 [[Template:·|middot]] "·", but shorter than a [[Template:Mdash|mdash]] "—". |
| − | + | ||
| − | < | + | === Normal usage === |
| − | + | ||
| − | + | The recommended usage is to use no space before the template | |
| − | < | + | and one space after the template, like this: |
| − | – | + | <nowiki>[[Salt]]{{ndash}} [[Pepper]]</nowiki> |
| − | .. | + | |
| + | It will render one space on each side of the dash, like this: | ||
| + | :[[Salt]] – [[Pepper]] | ||
| + | |||
| + | If it line breaks then the line break will come after the dash, not before, like this: | ||
| + | :[[Salt]] – | ||
| + | :[[Pepper]] | ||
| + | |||
| + | === Incorrect usage === | ||
| + | |||
| + | If the template is used slightly wrong it will in most cases still behave well. Like these examples: | ||
| + | |||
| + | <nowiki>[[Salt]]{{ndash}}[[Pepper]]</nowiki> | ||
| + | <nowiki>[[Salt]]{{ndash}} [[Pepper]]</nowiki> | ||
| + | |||
| + | Both of them will render exactly as before, with just one space on each side of the dash, like this: | ||
| + | :[[Salt]] – [[Pepper]] | ||
| + | |||
| + | And it will still only line break after the dash, like this: | ||
| + | :[[Salt]] – | ||
| + | :[[Pepper]] | ||
| + | |||
| + | But if the template is used very wrong, like these examples: | ||
| + | <nowiki>[[Salt]] {{ndash}}[[Pepper]]</nowiki> | ||
| + | <nowiki>[[Salt]] {{ndash}}[[Pepper]]</nowiki> | ||
| + | <nowiki>[[Salt]] {{ndash}} [[Pepper]]</nowiki> | ||
| + | <nowiki>[[Salt]] {{ndash}} [[Pepper]]</nowiki> | ||
| + | |||
| + | Then it will still only render just one space on each side of the dash, like this: | ||
| + | :[[Salt]] – [[Pepper]] | ||
| + | |||
| + | 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 <code>&nbsp;</code> since that one will not collapse. | ||
| + | |||
| + | The space after the dash is a normal space. That is it wraps and it collapses. | ||
| + | |||
| + | === See also === | ||
| + | |||
| + | * [[Template:·|<nowiki>{{·}}</nowiki>]] - The similar middot template. Mostly used for dotted lists. | ||
| + | * [[Template:Mdash|<nowiki>{{mdash}}</nowiki>]] - The similar mdash template. Mdash "—" is a longer dash than the ndash "–". | ||
<includeonly> | <includeonly> | ||
| − | <!-- | + | <!-- ADD CATEGORIES BELOW THIS LINE --> |
| − | [[Category:Formatting templates| | + | [[Category:Formatting templates| ]] |
| + | |||
| + | <!-- ADD INTERWIKIS BELOW THIS LINE --> | ||
| − | |||
</includeonly> | </includeonly> | ||
Revision as of 08:16, 11 August 2007
Template:Template doc page viewed directly
This template looks like this " – ".
It works similarly to the html markup sequence " – ". 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 middot "·", 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:
If it line breaks then the line break will come after the dash, not before, like this:
Incorrect usage
If the template is used slightly wrong it will in most cases still behave well. 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:
And it will still only line break after the dash, like this:
But if the template is used very wrong, 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:
But if it line breaks it might break before the dash, like this:
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 since that one will not collapse.
The space after the dash is a normal space. That is it wraps and it collapses.
See also
- {{·}} - The similar middot template. Mostly used for dotted lists.
- {{mdash}} - The similar mdash template. Mdash "—" is a longer dash than the ndash "–".
