Template:•/doc

From Kerbal Space Program Wiki
< Template:•
Revision as of 11:04, 7 March 2020 by ArnePeirs (talk | contribs) (links)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Template:Template shortcuts

This is the bullet template; it looks like this: [ • ]

It works similarly to the HTML markup sequence: [&nbsp;&bull; ], that is, a non-breaking space, a bullet and a normal space.

This template is used when you want a larger bullet than a bold middot [·], but something smaller than an en dash [–].

This template's use for dotted lists is now deprecated. 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:

[[w:Salt]]{{•}} [[w:Pepper]]

Because the template contains a non-breaking space on the left side, the text will render one space on each side of the bullet, like this:

w:SaltPepper

The purpose of this is to ensure that, if the line breaks, it will do so on the right side of the bullet.

w:Salt
Pepper
Here's an example of how it's used
Template Bull 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 {{bull}}, {{dot}}, {{middot}}, or {{ndash}} and not have to insert the Template:Bull,  · ,  · , 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 bullet (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 bullet hangs onto the prior item instead of rolling over to the next line. Notice on the end of this box, the bullet 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{{bull}} Item2{{bull}} Item3{{bull}} Item4{{bull}} Item5{{bull}} 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.

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

Item1Template:Bull ATemplate:Bull BTemplate:Bull Item2Template:Bull Item3Template:Bull Item4Template:Bull Item5Template:Bull extra itemTemplate:Bull ETemplate:Bull 1Template:Bull 2Template:Bull 3Template:Bull 4Template:Bull 5Template:Bull 6Template:Bull 7Template:Bull item that won't attach to prior line unless it fits in the remaining spaceTemplate:Bull QTemplate:Bull A slightly longer itemTemplate:Bull KKTemplate:Bull An obviously really even longer item that the bullet will hang at its endTemplate:Bull Item6Template:Bull CTemplate:Bull Item7Template:Bull Item8Template:Bull Item9Template:Bull Item10Template:Bull Item11Template:Bull Item12Template:Bull DTemplate:Bull Item13Template:Bull Item14Template:Bull Item15Template:Bull Item16Template:Bull Item17Template:Bull Item18

The space on the end makes sure the bullet 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:

[[w:Salt]]{{•}}[[w:Pepper]]
[[w:Salt]]{{•}}   [[w:Pepper]]

Both of them will render exactly as before, with just one space on each side of the bullet, like this:

w:SaltPepper

And it will still only line break after the bullet, like this:

w:Salt
Pepper

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

[[w:Salt]] {{•}}[[w:Pepper]]
[[w:Salt]]   {{•}}[[w:Pepper]]
[[w:Salt]] {{•}} [[w:Pepper]]
[[w:Salt]]   {{•}}   [[w:Pepper]]

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

w:Salt  • Pepper

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

w:Salt
 • Pepper

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for •

<templatedata> {

       "description": "The template makes a bullet. There are no optional or required parameters for this template. 'bull' or 'bullet' may be used as alternative template names.",
       "params": {
        }

} </templatedata>

Technical details

The space before the bullet 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 bullet 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.

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: w:Wikipedia:Line-break handling, explains when that happens and how to fix it.

Redirects

Dot sizes

Template:Dot size

See also

There are several other templates with similar stream formatting purposes and such (or related) functionality:

  • {{·}} – bold middot or (·)
  • {{spaced ndash}} – en dash or "–", a short w:dash
  • {{\}} – for the occasional slash or "/" in lists (note that the template is a backslash because template names may not contain a slash)

Wrap control templates

  • You might need to handle proper word wrapping (line breaking):
    • {{nowraplinks}} – Prevents wraps inside links and only allows wraps between the links and in normal text, very useful for link lists and easy to use.
    • {{nowrap begin}} – Prevents wraps in both text and links. For the really tricky wrapping cases when you need full control, for instance in very complex link lists.
  • For further information, see: w:Wikipedia:Line-break handling – The how-to guide detailing how to handle line wrapping on Wikipedia.