Difference between revisions of "Template:\/doc"
MyraMidnight (talk | contribs) m (→Usage) |
MyraMidnight (talk | contribs) m |
||
(One intermediate revision by the same user not shown) | |||
Line 3: | Line 3: | ||
This is the "slash" template, which produces "<code> /</code>", i.e. a [[:wikipedia:non-breaking space|non-breaking space]] followed by a [[:wikipedia:Slash (punctuation)|(forward-)slash character]]. It is most often used to indicate alternatives within a (horizontal) list of items, such as: | This is the "slash" template, which produces "<code> /</code>", i.e. a [[:wikipedia:non-breaking space|non-breaking space]] followed by a [[:wikipedia:Slash (punctuation)|(forward-)slash character]]. It is most often used to indicate alternatives within a (horizontal) list of items, such as: | ||
: ''{{hlist|class=nowrap |item 1 |item 2 |item 3a{{\}}3b{{\}}3c |item 4 |item 5 |(etc)}}'' | : ''{{hlist|class=nowrap |item 1 |item 2 |item 3a{{\}}3b{{\}}3c |item 4 |item 5 |(etc)}}'' | ||
− | The template is named using the [[backslash]] character (" \ ") as [[Wikipedia:Page name#Technical restrictions and limitations<!--or [[Filename#Reserved characters and words-->|slashes cannot be used]] in page names. | + | The template is named using the [[:wikipedia:backslash|backslash]] character (" \ ") as [[Wikipedia:Page name#Technical restrictions and limitations<!--or [[Filename#Reserved characters and words-->|slashes cannot be used]] in page names. |
== Usage == | == Usage == | ||
Line 57: | Line 57: | ||
== Technical details == | == Technical details == | ||
− | The space before the slash 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 before the slash is a [[:wikipedia:non-breaking space|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 slash 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. | The space after the slash 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. |
Latest revision as of 03:10, 4 May 2017
This is the "slash" template, which produces " /
", i.e. a non-breaking space followed by a (forward-)slash character. It is most often used to indicate alternatives within a (horizontal) list of items, such as:
- item 1
- item 2
- item 3a / 3b / 3c
- item 4
- item 5
- (etc)
The template is named using the backslash character (" \ ") as slashes cannot be used in page names.
Usage[edit]
To maintain good linewrapping, there should be no space between the template and whatever precedes it. There's also no need to include a space after the template, although doing so should not affect its function.
If linewrapping (i.e. a line-break) is required, the template ensures it occurs after the slash, not before:
For long slashed lists, each list item can be put on its own line with no spaces between each item and the template, like this:
[[Salt]]{{\}} [[Black pepper|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 slashes, like this:
Also, if it line breaks, then the line break will come after one of the slashes, not before, like this:
Incorrect usage[edit]
If the template is used slightly wrong, it will, in some cases, still behave well. For instance, if there are zero or several spaces after the template, like these examples:
[[Salt]]{{\}}[[Black pepper|Pepper]] [[Salt]]{{\}} [[Black pepper|Pepper]]
Both of them will render exactly as before, with just one space on each side of the slash, like this:
And it will still only line break after the slash, like this:
However, putting one or more spaces before the template will cause problems, like these examples:
[[Salt]] {{\}}[[Black pepper|Pepper]] [[Salt]] {{\}}[[Black pepper|Pepper]] [[Salt]] {{\}} [[Black pepper|Pepper]] [[Salt]] {{\}} [[Black pepper|Pepper]]
Then, it will render with two spaces before the slash and one after, like this:
Also, if it line breaks, it might break before the slash, like this:
Technical details[edit]
The space before the slash 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 slash 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, slashed 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.