Template:\/doc - Revision history

MyraMidnight at 09:10, 4 May 2017

2017-05-04T09:10:06Z

MyraMidnight: /* Technical details */

2017-05-04T08:55:00Z

Technical details

MyraMidnight: /* Usage */

2017-05-04T08:54:42Z

Usage

MyraMidnight at 08:50, 4 May 2017

2017-05-04T08:50:54Z

MyraMidnight: Created page with "{{Documentation subpage}} NOTOC This is the "slash" template, which produces " `/`"..."

2017-05-04T08:49:06Z

Created page with "{{Documentation subpage}} __NOTOC__  This is the "slash" template, which produces "<code> /</code>"..."

New page

{{Documentation subpage}} __NOTOC__

This is the "slash" template, which produces "<code> /</code>", i.e. a [[non-breaking space]] followed by a [[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)}}''
The template is named using the [[backslash]] character (" \ ") as [[Wikipedia:Page name#Technical restrictions and limitations|slashes cannot be used]] in page names.

== Usage ==

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.
: <code><nowiki>[[Salt]]{{\}}[[Black pepper|Pepper]]</nowiki></code>  ...produces...  [[Salt]]{{\}}[[Black pepper|Pepper]]

If linewrapping (i.e. a [[Word wrap|line-break]]) is required, the template ensures it occurs ''after'' the slash, not before:
:[[Salt]] /
:[[Black pepper|Pepper]]

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:
<pre><nowiki>
[[Salt]]{{\}}
[[Black pepper|Pepper]]{{\}}
[[Curry]]{{\}}
[[Saffron]]</nowiki></pre>

(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:
:[[Salt]] / [[Black pepper|Pepper]] / [[Curry]] / [[Saffron]]

Also, if it line breaks, then the line break will come ''after'' one of the slashes, not before, like this:
:[[Salt]] / [[Black pepper|Pepper]] /
:[[Curry]] / [[Saffron]]

===Incorrect usage===
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:

<nowiki>[[Salt]]{{\}}[[Black pepper|Pepper]]</nowiki>
<nowiki>[[Salt]]{{\}} [[Black pepper|Pepper]]</nowiki>

Both of them will render exactly as before, with just one space on each side of the slash, like this:
:[[Salt]] / [[Black pepper|Pepper]]

And it will still only line break ''after'' the slash, like this:
:[[Salt]] /
:[[Black pepper|Pepper]]

However, putting one or more spaces before the template will cause problems, like these examples:
<nowiki>[[Salt]] {{\}}[[Black pepper|Pepper]]</nowiki>
<nowiki>[[Salt]] {{\}}[[Black pepper|Pepper]]</nowiki>
<nowiki>[[Salt]] {{\}} [[Black pepper|Pepper]]</nowiki>
<nowiki>[[Salt]] {{\}} [[Black pepper|Pepper]]</nowiki>

Then, it will render with ''two'' spaces before the slash and one after, like this:
:[[Salt]]  / [[Black pepper|Pepper]]

Also, if it line breaks, it might break ''before'' the slash, like this:
:[[Salt]]
: / [[Black pepper|Pepper]]

== 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 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.

<includeonly>

[[Category:Typing-aid templates]]
</includeonly>

@@ Line 8: / Line 8: @@
 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.
-: <code><nowiki>[[Salt]]{{\}}[[Black pepper|Pepper]]</nowiki></code> &nbsp;...produces...&nbsp; [[Salt]]{{\}}[[Black pepper|Pepper]]
+: <code><nowiki>[[Salt]]{{\}}[[Black pepper|Pepper]]</nowiki></code> &nbsp;...produces...&nbsp; [[:wikipedia:Salt|Salt]]{{\}}[[:wikipedia:Black pepper|Pepper]]
-If linewrapping (i.e. a [[Word wrap|line-break]]) is required, the template ensures it occurs ''after'' the slash, not before:
+If linewrapping (i.e. a [[:wikipedia:Word wrap|line-break]]) is required, the template ensures it occurs ''after'' the slash, not before:
 :[[:wikipedia:Salt|Salt]] /
 :[[:wikipedia:Black pepper|Pepper]]
 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:
-  <pre><nowiki>
+  <pre> [[Salt]]{{\}}
- [[:wikipedia:Salt|]]{{\}}
+  [[Black pepper|Pepper]]{{\}}
-  [[:wikipedia:Black pepper|Pepper]]{{\}}
+  [[Curry]]{{\}}
-  [[:wikipedia:Curry|]]{{\}}
+  [[Saffron]]</pre>
 (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:
-:[[Salt]] / [[Black pepper|Pepper]] / [[Curry]] / [[Saffron]]
+:[[:wikipedia:Salt|Salt]] / [[:wikipedia:Black pepper|Pepper]] / [[:wikipedia:Curry|Curry]] / [[:wikipedia:Saffron|Saffron]]
 Also, if it line breaks, then the line break will come ''after'' one of the slashes, not before, like this:
@@ Line 37: / Line 36: @@
 Both of them will render exactly as before, with just one space on each side of the slash, like this:
-:[[Salt]] / [[Black pepper|Pepper]]
+:[[:wikipedia:Salt|Salt]] / [[:wikipedia:Black pepper|Pepper]]
 And it will still only line break ''after'' the slash, like this:
-:[[Salt]] /
+:[[:wikipedia:Salt|Salt]] /
-:[[Black pepper|Pepper]]
+:[[:wikipedia:Black pepper|Pepper]]
 However, putting one or more spaces before the template will cause problems, like these examples:
@@ Line 50: / Line 49: @@
 Then, it will render with ''two'' spaces before the slash and one after, like this:
-:[[Salt]] &nbsp;/ [[Black pepper|Pepper]]
+:[[:wikipedia:Salt|Salt]] &nbsp;/ [[:wikipedia:Black pepper|Pepper]]
 Also, if it line breaks, it might break ''before'' the slash, like this:
-:[[Salt]]
+:[[:wikipedia:Salt|Salt]]
-:&nbsp;/ [[Black pepper|Pepper]]
+:&nbsp;/ [[:wikipedia:Black pepper|Pepper]]
 == Technical details  ==

@@ Line 3: / Line 3: @@
 This is the "slash" template, which produces "<code>&nbsp;/</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)}}''
-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 ==