Difference between revisions of "Template:Spaced en dash/doc"
(`also ridiculous -- fix the tooltip machinery -- no one's seriously suggesting there should be no templates used in leads) |
(+) |
||
(16 intermediate revisions by 10 users not shown) | |||
Line 2: | Line 2: | ||
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> | <!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> | ||
{{COinS safe|n}} | {{COinS safe|n}} | ||
+ | {{High-use|27,000+}} | ||
{{Template shortcuts |snd|spnd|sndash|spndash}} | {{Template shortcuts |snd|spnd|sndash|spndash}} | ||
− | + | This is the '''spaced en dash''' template; it renders like this (without the quote marks): " – " | |
− | This is the '''spaced | + | It works similarly to the HTML markup sequence <code>'''&nbsp;&ndash;''' </code> i.e. a [[non-breaking space]] (which will not line-break and will not collapse together with normal spaces that come before the template), a short dash (known as an [[Dash#En dash|en dash]]), and a normal space (which ''will'' line-break and ''will'' collapse together with normal spaces that come after the template). |
− | + | Among other uses, this template may be used in lists to provide something stronger than a [[Template:·|bold middot]] "'''·'''" or a [[Template:•|bullet]] "•", but shorter than an [[Dash#Em dash|em dash]] "—". For horizontal lists, use {{tl|flatlist}} or <code>class="hlist"</code> instead (see [[WP:HLIST]]) Here, the recommended usage is to use ''no'' space before the template and one space after the template, like this: | |
− | It works similarly to the HTML markup sequence | + | ::<nowiki>[[Salt]]{{spaced en dash}} [[Pepper]]</nowiki> |
− | |||
− | |||
− | |||
− | |||
− | |||
− | ::<nowiki>[[Salt]]{{spaced | ||
:This will render one space on each side of the dash, like this: | :This will render one space on each side of the dash, like this: | ||
::[[Salt]] – [[Black pepper|Pepper]] | ::[[Salt]] – [[Black pepper|Pepper]] | ||
Line 19: | Line 14: | ||
::[[Curry]] – [[Saffron]] | ::[[Curry]] – [[Saffron]] | ||
+ | {{t|snd}}} is a handy synonym. | ||
{| class="wikitable" style="border: none; background: none;" | {| class="wikitable" style="border: none; background: none;" | ||
|Colspan=2 |<center>Here's an example of use for lists</center> | |Colspan=2 |<center>Here's an example of use for lists</center> | ||
|- | |- | ||
− | || One use of template " | + | || One use of template "spaced en dash" is within other templates, tables, lists, and similar things to provide a separator between items. It is also to be consistent so that the article editor can use their choice of '''<nowiki>{{</nowiki>bull}}''', '''<nowiki>{{</nowiki>dot}}''', '''<nowiki>{{</nowiki>middot}}''', or '''<nowiki>{{</nowiki>spaced en dash}}''' and not have to insert the {{bull}}, {{dot}}, {{middot}}, or {{spaced en dash}} 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 en dash}} Item2<nowiki>{{</nowiki>spaced en dash}} Item3<nowiki>{{</nowiki>spaced en dash}} Item4<nowiki>{{</nowiki>spaced en dash}} Item5<nowiki>{{</nowiki>spaced en dash}}''' 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 | + | | <p>Normally, in a real box these items would be links, but this is an example.</p> Item1{{spaced en dash}} A{{spaced en dash}} B{{spaced en dash}} Item2{{spaced en dash}} Item3{{spaced en dash}} Item4{{spaced en dash}} Item5{{spaced en dash}} extra item{{spaced en dash}} E{{spaced en dash}} 1{{spaced en dash}} 2{{spaced en dash}} 3{{spaced en dash}} 4{{spaced en dash}} 5{{spaced en dash}} 6{{spaced en dash}} 7{{spaced en dash}} {{nowrap|item that won't attach to prior line unless it fits in the remaining space{{spaced en dash}}}} Q{{spaced en dash}} A slightly longer item{{spaced en dash}} KK{{spaced en dash}} An obviously really even longer item that the dash will hang at its end{{spaced en dash}} Item6{{spaced en dash}} C{{spaced en dash}} Item7{{spaced en dash}} Item8{{spaced en dash}} Item9{{spaced en dash}} Item10{{spaced en dash}} Item11{{spaced en dash}} Item12{{spaced en dash}} D{{spaced en dash}} Item13{{spaced en dash}} Item14{{spaced en dash}} Item15{{spaced en dash}} Item16{{spaced en dash}} Item17{{spaced en dash}} Item18 <p>The space on the end makes sure the dash doesn't touch the edge of the box, either</p> |
|} | |} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Dot sizes == | == Dot sizes == | ||
{{Dot size}} | {{Dot size}} | ||
− | |||
== See also == | == See also == | ||
* {{tn|·}}, which produces a spaced bold [[interpunct]] ("middot"): "{{·}}" | * {{tn|·}}, which produces a spaced bold [[interpunct]] ("middot"): "{{·}}" | ||
* {{tn|•}}, which produces a spaced bullet-point: "{{•}}" | * {{tn|•}}, which produces a spaced bullet-point: "{{•}}" | ||
* {{tn|\}}, which produces a spaced (forward-)slash: "{{\}}" | * {{tn|\}}, which produces a spaced (forward-)slash: "{{\}}" | ||
− | * {{tl| | + | * {{tl|en dash}}, which produces an (unspaced) [[en dash]]. |
− | * {{tl| | + | * {{tl|em dash}}, which produces an (unspaced) [[em dash]]. |
− | |||
<includeonly> | <includeonly> | ||
+ | [[Category:Inline spacing templates]] | ||
+ | [[Category:Typing-aid templates|En dash, spaced]] | ||
[[Category:Wikipedia character-substitution templates]] | [[Category:Wikipedia character-substitution templates]] | ||
− | |||
</includeonly> | </includeonly> |
Latest revision as of 20:46, 21 January 2017
This is a documentation subpage for Template:Spaced en dash. It contains usage information, categories and other content that is not part of the original template page. |
This template should not be used in citation templates such as Citation Style 1 and Citation Style 2, because it includes markup that will pollute the COinS metadata they produce; see COinS in Wikipedia. |
This template is used on approximately 27,000 pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
This is the spaced en dash template; it renders like this (without the quote marks): " – "
It works similarly to the HTML markup sequence –
i.e. a non-breaking space (which will not line-break and will not collapse together with normal spaces that come before the template), a short dash (known as an en dash), and a normal space (which will line-break and will collapse together with normal spaces that come after the template).
Among other uses, this template may be used in lists to provide something stronger than a bold middot "·" or a bullet "•", but shorter than an em dash "—". For horizontal lists, use {{flatlist}} or class="hlist"
instead (see WP:HLIST) Here, the recommended usage is to use no space before the template and one space after the template, like this:
- [[Salt]]{{spaced en dash}} [[Pepper]]
- This will render one space on each side of the dash, like this:
- A line break will come after one of the dashes, not before, when the spacing is used as suggested, like this:
{{snd}}} is a handy synonym.
One use of template "spaced en dash" is within other templates, tables, lists, and similar things to provide a separator between items. It is also to be consistent so that the article editor can use their choice of {{bull}}, {{dot}}, {{middot}}, or {{spaced en dash}} and not have to insert the • , · , · , or – 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 en dash}} Item2{{spaced en dash}} Item3{{spaced en dash}} Item4{{spaced en dash}} Item5{{spaced en dash}} 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. Item1 – A – B – Item2 – Item3 – Item4 – Item5 – extra item – E – 1 – 2 – 3 – 4 – 5 – 6 – 7 – item that won't attach to prior line unless it fits in the remaining space – Q – A slightly longer item – KK – An obviously really even longer item that the dash will hang at its end – Item6 – C – Item7 – Item8 – Item9 – Item10 – Item11 – Item12 – D – Item13 – Item14 – Item15 – Item16 – Item17 – Item18The space on the end makes sure the dash doesn't touch the edge of the box, either |
Dot sizes
· | middot |
· | bold {{middot}} |
• | small bullet |
• | {{bullet}} |
• | bold bullet |
– | {{en dash}} |
— | {{em dash}} |