Template:•/doc

From Wikibok
Revision as of 08:51, 2 November 2012 by Yffo (talk | contribs) (1 revision)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Template loop detected: Template:Mbox

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

It works similarly to the HTML markup sequence: [ • ], 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:

[[Salt]]{{•}} [[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:

SaltPepper

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

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  • ,  · ,  · , 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 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.

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 bullet will hang at its end • Item6 • C • Item7 • Item8 • Item9 • Item10 • Item11 • Item12 • D • Item13 • Item14 • Item15 • Item16 • Item17 • 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:

[[Salt]]{{•}}[[Pepper]]
[[Salt]]{{•}}   [[Pepper]]

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

SaltPepper

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

Salt
Pepper

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

[[Salt]] {{•}}[[Pepper]]
[[Salt]]   {{•}}[[Pepper]]
[[Salt]] {{•}} [[Pepper]]
[[Salt]]   {{•}}   [[Pepper]]

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

Salt  • Pepper

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

Salt
 • Pepper

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

  • The bullet used is Error using {{unichar}}: Input "2022" is not a hexadecimal value (expected: like "09AF") .
  • Not to be confused with Error using {{unichar}}: Input "00B7" is not a hexadecimal value (expected: like "09AF") , used in {{·}}.

Redirects

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 dash
  • {{\}} – for the occasional slash or "/" in lists (note that the template is a backslash because template names may not contain a slash)
  • {{-!}} – Spaced pipe "|"

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: Wikipedia:Line break handling – The how-to guide detailing how to handle line wrapping on Wikipedia.

Dot size reference list

· small middot
· middot
· small bold middot
· bold middot
small bullet
bullet
bold bullet
en dash
em dash