Template:Spaced en dash/doc

From Second Life Wiki
< Template:Spaced en dash
Revision as of 17:10, 22 September 2022 by Gwyneth Llewelyn (talk | contribs) (Shamelessly copied from wikipedia.org and adapted for SL Wiki)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This is the spaced en dash template; it renders like this (without the quote marks): " – " It works similarly to the HTML markup sequence &nbsp;&ndash;  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:
SaltPepper
A line break will come after one of the dashes, not before, when the spacing is used as suggested, like this:
SaltPepper
CurrySaffron

{{snd}} is a handy synonym.

Here's an example of use for lists
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

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

It works like the HTML markup sequence: [&nbsp;&bull; ], that is, a "Wikipedia logo"non-breaking space, a "Wikipedia logo"bullet and a normal "Wikipedia logo"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 {{Hlist}} instead; see "Wikipedia logo"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 Template loop detected: Template:Bull,  · ,  · , 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.

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

[[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

TemplateData

This is the "Wikipedia logo"TemplateData for this template used by TemplateWizard, "Wikipedia logo"VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Spaced en dash

{
        "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": {
         }
}

Technical details

The space before the bullet is a "Wikipedia logo"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 logo"Wikipedia:Line-break handling, explains when that happens and how to fix it.

  • The bullet used is Expression error: Unrecognized punctuation character "["..
  • Not to be confused with Expression error: Unrecognized punctuation character "["., used in {{·}}.

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}} – "Wikipedia logo"en dash or "–", a short "Wikipedia logo"dash
  • {{\}} – for the occasional slash or "/" in lists (note that the template is a backslash because template names may not contain a slash)
  • {{Colorbull}} – a colored bullet, with an optional "Wikipedia logo"wikilink
  • {{Asterisk}} – to display an asterisk character (*) at the start of a line of text

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

,  · ,  · , 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 – Item18

The space on the end makes sure the dash doesn't touch the edge of the box, either

Dot sizes

Template:Dot size

See also

, which produces a spaced bold interpunct ("middot"): " · "

, which produces a spaced bullet-point: "

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

It works like the HTML markup sequence: [&nbsp;&bull; ], that is, a "Wikipedia logo"non-breaking space, a "Wikipedia logo"bullet and a normal "Wikipedia logo"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 {{Hlist}} instead; see "Wikipedia logo"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 Template loop detected: Template:Bull,  · ,  · , 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.

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

[[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

TemplateData

This is the "Wikipedia logo"TemplateData for this template used by TemplateWizard, "Wikipedia logo"VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Spaced en dash

{
        "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": {
         }
}

Technical details

The space before the bullet is a "Wikipedia logo"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 logo"Wikipedia:Line-break handling, explains when that happens and how to fix it.

  • The bullet used is Expression error: Unrecognized punctuation character "["..
  • Not to be confused with Expression error: Unrecognized punctuation character "["., used in {{·}}.

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}} – "Wikipedia logo"en dash or "–", a short "Wikipedia logo"dash
  • {{\}} – for the occasional slash or "/" in lists (note that the template is a backslash because template names may not contain a slash)
  • {{Colorbull}} – a colored bullet, with an optional "Wikipedia logo"wikilink
  • {{Asterisk}} – to display an asterisk character (*) at the start of a line of text

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

"

, which produces a spaced (forward-)slash: " / "


TemplateData

This is the "Wikipedia logo"TemplateData for this template used by TemplateWizard, "Wikipedia logo"VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Spaced en dash

{
	"params": {},
	"description": "Inserts a spaced en dash; it renders like this (without the quote marks): \" &ndash; \"."
}