Template:·/doc: Difference between revisions
Reworked the documentation since the template now has new code and thus new behaviour. I am not satisfied with the first section, feels slightly messy. |
Some minor fixes of the new documentation. |
||
Line 1:
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
__NOTOC__
This is the '''bold middot''' template, it looks like this " '''·''' ".
It works similarly to the html+wiki markup sequence "<code>'''&nbsp;<nowiki>'''</nowiki>&middot;<nowiki>'''</nowiki>''' </code>". That is, a [[non-breaking space]], a bolded middot 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 usually used for dotted lists, such as for link lists in navigation boxes. (For lists that
This template is used when you want something smaller than a [[Template:•|bullet]] "•", [[Template:Ndash|ndash]] "–" or [[Template:Mdash|mdash]] "—".
|
Revision as of 02:37, August 13, 2007
Template:Template doc page viewed directly
This is the bold middot template, it looks like this " · ".
It works similarly to the html+wiki markup sequence " '''·'''
". That is, a non-breaking space, a bolded middot and a normal space. However this template includes some extra code that makes it behave slightly better than the html markup sequence.
{{middot}} redirects here and can be used as alternative name for this template.
This template is usually used for dotted lists, such as for link lists in navigation boxes. (For lists that have a font-size 80% or less of normal font-size, the bold middot "·" becomes too small. Then use the bullet "•" instead.)
This template is used when you want something smaller than a bullet "•", ndash "–" or mdash "—".
Normal usage
The recommended usage is to use no space before the template and one space after the template, like this:
[[Salt]]{{·}} [[Pepper]]
It will render one space on each side of the dot, like this:
If it line breaks then the line break will come after the dot, not before, like this:
For long dotted lists each list item can be put on its own line, with no spaces between each item and the template. Like this:
[[Salt]]{{·}} [[Pepper]]{{·}} [[Curry]]{{·}} [[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 dots, like this:
And if it line breaks then the line break will come after one of the dots, not before, like this:
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]]{{·}}[[Pepper]] [[Salt]]{{·}} [[Pepper]]
Both of them will render exactly as before, with just one space on each side of the dot, like this:
And it will still only line break after the dot, like this:
But putting one or more spaces before the template can cause problems, like these examples:
[[Salt]] {{·}}[[Pepper]] [[Salt]] {{·}}[[Pepper]] [[Salt]] {{·}} [[Pepper]] [[Salt]] {{·}} [[Pepper]]
Then it will still only render just one space on each side of the dot, like this:
But if it line breaks it might break before the dot, like this:
Technical details
The space before the dot 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 dot 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:
- {{•}} - Bullet "•" is mostly used for dotted lists that use small font sizes.
- {{ndash}} - Ndash "–" is a short dash.
- {{mdash}} - Mdash "—" is a long dash.