Template:·/doc: Difference between revisions
From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
Content deleted Content added
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. |
m Text replacement - "\[\[Category:([^|]+)\|{{PAGENAME}}\]\]" to "Category:$1" |
||
(101 intermediate revisions by 65 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
|||
<includeonly>{{template doc page transcluded}}</includeonly> |
|||
{{high-use|90,000+}} |
|||
<noinclude>{{template doc page viewed directly}}</noinclude> |
|||
{{tsh|dot|middot|,}} |
|||
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> |
|||
__NOTOC__ |
__NOTOC__ |
||
This is the ''bold middot'' template, it looks like this " '''·''' ". |
This is the '''bold middot''' template, it looks like this: " '''·''' ". It works similarly to the html+wiki markup sequence [<code>'''&nbsp;<nowiki><b>&middot;</b></nowiki>''' </code>]. That is, a [[non-breaking space]], a bolded middot and a normal space. |
||
This template is used when you want something smaller than a [[Template:•|bullet]] "•", or [[Template:spaced ndash|ndash]] "–". |
|||
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's use for dotted lists is now '''deprecated'''. Use {{Tl|Flatlist}} or <code>class="hlist"</code> instead; see [[w:WP:HLIST|WP:HLIST]]. |
|||
<code>{{tl|middot}}</code> 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 has a font-size 80% or less of normal font-size, the bold middot "'''·'''" becomes too small. Then use the [[Template:•|bullet]] "•" instead.) |
|||
{| class="wikitable" style="border: none; background: none;" |
|||
This template is used when you want something smaller than a [[Template:•|bullet]] "•", [[Template:Ndash|ndash]] "–" or [[Template:Mdash|mdash]] "—". |
|||
|<center>Here's an example of how it's used</center> |
|||
|- |
|||
| <p>Normally, in a real box these items would be links, but this is an example.</p> Item1{{dot}} A{{dot}} B{{dot}} Item2{{dot}} Item3{{dot}} Item4{{dot}} Item5{{dot}} extra item{{dot}} E{{dot}} 1{{dot}} 2{{dot}} 3{{dot}} 4{{dot}} 5{{dot}} 6{{dot}} 7{{dot}} {{nowrap|item that won't attach to prior line unless it fits in the remaining space{{dot}}}} Q{{dot}} A slightly longer item{{dot}} KK{{dot}} An obviously really even longer item that the dash will hang at its end{{dot}} Item6{{dot}} C{{dot}} Item7{{dot}} Item8{{dot}} Item9{{dot}} Item10{{dot}} Item11{{dot}} Item12{{dot}} D{{dot}} Item13{{dot}} Item14{{dot}} Item15{{dot}} Item16{{dot}} Item17{{dot}} Item18 <p>The space on the end makes sure the dot doesn't touch the edge of the box, either</p> |
|||
|} |
|||
Template Dot 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>middot}}''', or '''<nowiki>{{</nowiki>spaced ndash}}''' and not have to insert the {{bull}}, {{dot}}, {{middot}}, or {{spaced 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 bolded middot (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 dot 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 dot will fit. See the column on the right. In code it's ''' Item1<nowiki>{{</nowiki>dot}} Item2<nowiki>{{</nowiki>dot}} Item3<nowiki>{{</nowiki>dot}} Item4<nowiki>{{</nowiki>dot}} Item5<nowiki>{{</nowiki>dot}}''' 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 symbol following. |
|||
=== Normal usage === |
|||
== Technical details == |
|||
The recommended usage is to use ''no'' space before the template and one space after the template, like this: |
|||
The space before the dot 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. |
|||
<nowiki>[[Salt]]{{·}} [[Pepper]]</nowiki> |
|||
The space after the dot 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. |
|||
It will render one space on each side of the dot, like this: |
|||
:[[Salt]] '''·''' [[Pepper]] |
|||
Under some circumstances dotted link lists misbehave. They might get unexpected line wraps or they might expand outside the box they are enclosed in. The how-to guide [[Wikipedia:Line-break handling]] explains when that happens and how to fix it. |
|||
If it line breaks then the line break will come ''after'' the dot, not before, like this: |
|||
:[[Salt]] '''·''' |
|||
:[[Pepper]] |
|||
== Parameters == |
|||
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: |
|||
<TemplateData>{ |
|||
<pre><nowiki> |
|||
"description": "Display a bold spaced middle dot (smaller than bullet)", |
|||
[[Salt]]{{·}} |
|||
"params": {} |
|||
[[Pepper]]{{·}} |
|||
}</TemplateData> |
|||
[[Curry]]{{·}} |
|||
[[Saffron]]</nowiki></pre> |
|||
== Redirects == |
|||
(It doesn't matter if there are no or some spaces at the end of the lines, after the templates.) |
|||
* {{tl2|,}} |
|||
* {{tl2|dot}} |
|||
* {{tl2|middot}} |
|||
== Dot sizes == |
|||
As before it will render one space on each side of the dots, like this: |
|||
{{Dot size}} |
|||
:[[Salt]] '''·''' [[Pepper]] '''·''' [[Curry]] '''·''' [[Saffron]] |
|||
== See also == |
|||
And if it line breaks then the line break will come ''after'' one of the dots, not before, like this: |
|||
There are several similar templates: |
|||
:[[Salt]] '''·''' [[Pepper]] '''·''' |
|||
:[[Curry]] '''·''' [[Saffron]] |
|||
=== 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: |
|||
<nowiki>[[Salt]]{{·}}[[Pepper]]</nowiki> |
|||
<nowiki>[[Salt]]{{·}} [[Pepper]]</nowiki> |
|||
Both of them will render exactly as before, with just one space on each side of the dot, like this: |
|||
:[[Salt]] '''·''' [[Pepper]] |
|||
And it will still only line break ''after'' the dot, like this: |
|||
:[[Salt]] '''·''' |
|||
:[[Pepper]] |
|||
But putting one or more spaces before the template can cause problems, like these examples: |
|||
<nowiki>[[Salt]] {{·}}[[Pepper]]</nowiki> |
|||
<nowiki>[[Salt]] {{·}}[[Pepper]]</nowiki> |
|||
<nowiki>[[Salt]] {{·}} [[Pepper]]</nowiki> |
|||
<nowiki>[[Salt]] {{·}} [[Pepper]]</nowiki> |
|||
Then it will still only render just one space on each side of the dot, like this: |
|||
:[[Salt]] '''·''' [[Pepper]] |
|||
But if it line breaks it might break ''before'' the dot, like this: |
|||
:[[Salt]] |
|||
:'''·''' [[Pepper]] |
|||
=== 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 <code>&nbsp;</code> 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 === |
|||
{| style="text-align:center; background:transparent;" |
|||
| style="width:1.7em;" | <small>·</small> |
|||
| align="left" | <small> middot |
|||
|- |
|||
| · |
|||
| align="left" | middot |
|||
|- |
|||
| <small>'''·'''</small> |
|||
| align="left" | <small> bold middot |
|||
|- |
|||
| '''·''' |
|||
| align="left" | bold middot |
|||
|- |
|||
| <small>•</small> |
|||
| align="left" | <small> bullet |
|||
|- |
|||
| • |
|||
| align="left" | bullet |
|||
|- |
|||
| '''•''' |
|||
| align="left" | bold bullet |
|||
|- |
|||
| – |
|||
| align="left" | ndash |
|||
|- |
|||
| — |
|||
| align="left" | mdash |
|||
|} |
|||
=== See also === |
|||
There are several other templates with similar functionality: |
|||
* [[Template:•|<nowiki>{{•}}</nowiki>]] - Bullet "•" is mostly used for dotted lists that use small font sizes. |
|||
* [[Template:Ndash|<nowiki>{{ndash}}</nowiki>]] - Ndash "–" is a short dash. |
|||
* [[Template:Mdash|<nowiki>{{mdash}}</nowiki>]] - Mdash "—" is a long dash. |
|||
* {{tn|•}} – Bullet "•" is mostly used for dotted lists that use small font sizes. |
|||
* {{tl|spaced ndash}} – Ndash "–" is a short dash. |
|||
* {{tn|\}} – For the occasional slash "/" in lists. |
|||
* {{tl2|-!}} – Spaced pipe "|" |
|||
<includeonly> |
<includeonly> |
||
[[Category:Wikipedia formatting and function templates]] |
|||
<!-- ADD CATEGORIES BELOW THIS LINE --> |
|||
<!--The blank-space indexing is used otherwise the middot symbol would appear by itself at the end of the list, instead of, say, as a symbol--> |
|||
{{DEFAULTSORT: }} |
|||
[[Category:Formatting templates]] |
|||
<!-- ADD INTERWIKIS BELOW THIS LINE --> |
|||
[[ca:Plantilla:·]] |
|||
[[cy:Nodyn:·]] |
|||
[[da:Skabelon:·]] |
|||
[[es:Plantilla:·]] |
|||
[[fr:Modèle:·]] |
|||
[[hi:साँचा:·]] |
|||
[[hu:Sablon:·]] |
|||
[[id:Templat:·]] |
|||
[[ku:Şablon:·]] |
|||
<!-- [[lt:Šablonas:·]] doesn't include the --> |
|||
[[lv:Veidne:·]] |
|||
[[ms:Templat:·]] |
|||
[[nl:Sjabloon:·]] |
|||
[[nn:Mal:·]] |
|||
<!-- [[no:Mal:·]] doesn't include the --> |
|||
[[pt:Predefinição:·]] |
|||
[[ro:Format:·]] |
|||
[[simple:Template:·]] |
|||
[[sl:Predloga:·]] |
|||
[[sq:Stampa:·]] |
|||
[[su:Citakan:·]] |
|||
<!-- [[tr:Şablon:·]] doesn't include the --> |
|||
[[uk:Шаблон:·]] |
|||
</includeonly> |
</includeonly> |