Editing Template:\/doc

From Guild of Archivists
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
{{Documentation subpage}} __NOTOC__
{{Documentation subpage}} __NOTOC__
<!----PLEASE CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE---->
<!----PLEASE CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE---->
This is the "slash" template, which produces "{{thinsp}}<code>&nbsp;/</code>{{thinsp}}", 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:
This is the "slash" template, which produces "{{thinsp}}<code>&nbsp;/</code>{{thinsp}}", 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)}}''
: ''{{hlist|class=nowrap |item 1 |item 2 |item 3a{{\}}3b{{\}}3c |item 4 |item 5 |(etc)}}''
The template is named using the backslash character ("{{thinsp}}\{{thinsp}}") 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 [[backslash]] character ("{{thinsp}}\{{thinsp}}") as [[Wikipedia:Page name#Technical restrictions and limitations<!--or [[Filename#Reserved characters and words-->|slashes cannot be used]] in page names.


== Usage ==
== 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.
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>[[Atrus]]{{\}}[[Catherine]]</nowiki></code> &nbsp;...produces...&nbsp; [[Atrus]]{{\}}[[Catherine]]
: <code><nowiki>[[Salt]]{{\}}[[Black pepper|Pepper]]</nowiki></code> &nbsp;...produces...&nbsp; [[Salt]]{{\}}[[Black pepper|Pepper]]


If linewrapping (i.e. a line-break) is required, the template ensures it occurs ''after'' the slash, not before:
If linewrapping (i.e. a [[Word wrap|line-break]]) is required, the template ensures it occurs ''after'' the slash, not before:
:[[Atrus]] /  
:[[Salt]] /  
:[[Catherine]]
:[[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:
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><nowiki>
  [[Atrus]]{{\}}
  [[Salt]]{{\}}
  [[Catherine]]{{\}}
  [[Black pepper|Pepper]]{{\}}
  [[Sirrus]]{{\}}
  [[Curry]]{{\}}
  [[Achenar]]</nowiki></pre>
  [[Saffron]]</nowiki></pre>


(It doesn't matter if there are no or some spaces at the end of the lines, after the templates.)
(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:
As before, it will render one space on each side of the slashes, like this:
:[[Atrus]] / [[Catherine]] / [[Sirrus]] / [[Achenar]]
:[[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:
Also, if it line breaks, then the line break will come ''after'' one of the slashes, not before, like this:
:[[Atrus]] / [[Catherine]] /  
:[[Salt]] / [[Black pepper|Pepper]] /  
:[[Sirrus]] / [[Achenar]]
:[[Curry]] / [[Saffron]]


===Incorrect usage===
===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:
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>[[Atrus]]{{\}}[[Catherine]]</nowiki>
  <nowiki>[[Salt]]{{\}}[[Black pepper|Pepper]]</nowiki>
  <nowiki>[[Atrus]]{{\}}  [[Catherine]]</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:
Both of them will render exactly as before, with just one space on each side of the slash, like this:
:[[Atrus]] / [[Catherine]]
:[[Salt]] / [[Black pepper|Pepper]]


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


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


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


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


== 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 [[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.
Line 66: Line 66:
== See also ==
== See also ==
* Other templates using non-breaking spaces to format inline presentation:
* Other templates using non-breaking spaces to format inline presentation:
*: {{tl2|·}} or {{tl2|dot}}, the "bold middot" template (producing "&nbsp;'''&middot;'''") formerly used to create horizontal lists.
*: {{tl2|·}} or {{tl2|dot}}, the "bold [[Interpunct|middot]]" template (producing "&nbsp;'''&middot;'''") formerly used to create horizontal lists.
*: {{tl2|•}} or {{tl2|bullet}}, used to produce the Unicode-style bullet character.
*: {{tl2|•}} or {{tl2|bullet}}, used to produce the Unicode-style bullet character.
*: {{tl2|spaced ndash}}, primarily used in the same way as this "slash" template to produce linewrap-friendly textual asides and/or emphasized phrases.
*: {{tl2|spaced ndash}}, primarily used in the same way as this "slash" template to produce linewrap-friendly textual asides and/or emphasized phrases.
* [[WP:HLIST]], which addresses h(orizontal) lists and the "hlist" [[HTML attribute|class]] in Wikipedia.
* {{tl|flatlist}}, a template that can be used to create horizontal ("flat") lists.
* {{tl|flatlist}}, a template that can be used to create horizontal ("flat") lists.


Line 81: Line 82:
  |cols=3 |class=wikitable
  |cols=3 |class=wikitable
  |col1style=width:4.0em;vertical-align:middle;text-align:center;
  |col1style=width:4.0em;vertical-align:middle;text-align:center;
  |col2style=width:10.0em;vertical-align:middle;text-align:center;
  |col2style=width:10.0em;background:white;vertical-align:middle;text-align:center;
  |col3style=width:16.0em;vertical-align:middle;padding-left:1.0em;
  |col3style=width:16.0em;vertical-align:middle;padding-left:1.0em;
  |row1style=background:whitesmoke;text-align:center;font-weight:bold;white-space:nowrap;
  |row1style=background:whitesmoke;text-align:center;font-weight:bold;white-space:nowrap;
Line 130: Line 131:
<includeonly>
<includeonly>
<!----CATEGORIES BELOW THIS LINE, PLEASE:---->
<!----CATEGORIES BELOW THIS LINE, PLEASE:---->
[[Category:GoArch character-substitution templates]]
[[Category:Wikipedia character-substitution templates]]
[[Category:Typing-aid templates]]
[[Category:Typing-aid templates]]
[[Category:Inline spacing templates]]
[[Category:Inline spacing templates]]


</includeonly>
</includeonly>
Please note that all contributions to Guild of Archivists may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see GoArch:Copyrights for details). Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)