Template:\/doc: Difference between revisions
m (1 revision imported) |
No edit summary |
||
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> /</code>{{thinsp}}", i.e. a | This is the "slash" template, which produces "{{thinsp}}<code> /</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: | ||
: ''{{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 | 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>[[ | : <code><nowiki>[[Atrus]]{{\}}[[Catherine]]</nowiki></code> ...produces... [[Atrus]]{{\}}[[Catherine]] | ||
If linewrapping (i.e. a | If linewrapping (i.e. a line-break) is required, the template ensures it occurs ''after'' the slash, not before: | ||
:[[ | :[[Atrus]] / | ||
:[[ | :[[Catherine]] | ||
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]]{{\}} | ||
[[ | [[Catherine]]{{\}} | ||
[[ | [[Sirrus]]{{\}} | ||
[[ | [[Achenar]]</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]] | ||
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]] / | ||
:[[ | :[[Sirrus]] / [[Achenar]] | ||
===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>[[ | <nowiki>[[Atrus]]{{\}}[[Catherine]]</nowiki> | ||
<nowiki>[[ | <nowiki>[[Atrus]]{{\}} [[Catherine]]</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]] | ||
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]] / | ||
:[[ | :[[Catherine]] | ||
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>[[ | <nowiki>[[Atrus]] {{\}}[[Catherine]]</nowiki> | ||
<nowiki>[[ | <nowiki>[[Atrus]] {{\}}[[Catherine]]</nowiki> | ||
<nowiki>[[ | <nowiki>[[Atrus]] {{\}} [[Catherine]]</nowiki> | ||
<nowiki>[[ | <nowiki>[[Atrus]] {{\}} [[Catherine]]</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]] / [[Catherine]] | ||
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]] | ||
: / [[ | : / [[Catherine]] | ||
== Technical details == | == Technical details == | ||
The space before the slash is a | 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 | *: {{tl2|·}} or {{tl2|dot}}, the "bold middot" template (producing " '''·'''") 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. | ||
* {{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 82: | Line 81: | ||
|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 | |col2style=width:10.0em;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 131: | Line 130: | ||
<includeonly> | <includeonly> | ||
<!----CATEGORIES BELOW THIS LINE, PLEASE:----> | <!----CATEGORIES BELOW THIS LINE, PLEASE:----> | ||
[[Category: | [[Category:GoArch character-substitution templates]] | ||
[[Category:Typing-aid templates]] | [[Category:Typing-aid templates]] | ||
[[Category:Inline spacing templates]] | [[Category:Inline spacing templates]] | ||
</includeonly> | </includeonly> |
Latest revision as of 06:33, 11 July 2016
This is a documentation subpage for Template:\. It contains usage information, categories and other content that is not part of the original template page. |
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:
[[Atrus]]{{\}} [[Catherine]]{{\}} [[Sirrus]]{{\}} [[Achenar]]
(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:
[[Atrus]]{{\}}[[Catherine]] [[Atrus]]{{\}} [[Catherine]]
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:
[[Atrus]] {{\}}[[Catherine]] [[Atrus]] {{\}}[[Catherine]] [[Atrus]] {{\}} [[Catherine]] [[Atrus]] {{\}} [[Catherine]]
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.
See also[edit]
- Other templates using non-breaking spaces to format inline presentation:
{{·}}
or{{dot}}
, the "bold middot" template (producing " ·") formerly used to create horizontal lists.{{•}}
or{{bullet}}
, used to produce the Unicode-style bullet character.{{spaced ndash}}
, primarily used in the same way as this "slash" template to produce linewrap-friendly textual asides and/or emphasized phrases.
- {{flatlist}}, a template that can be used to create horizontal ("flat") lists.
Wrap control templates[edit]
- When making dotted lists, you might need to handle proper word wrapping (line breaking):
- {{nowraplinks}} to prevent 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}}...{{nowrap end}} to prevent 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 at Wikipedia.
Dot and dash size reference list[edit]
Output | HTML effect name | Code to use |
· | small middot | {{small|·}}
|
· | middot | '''·'''
|
· | small bold middot | {{small|'''·'''}}
|
· | bold middot | '''·''' or <b>·</b>
|
• | small bullet | {{small|•}} or {{small|{{bull}}}}
|
• | bullet | • or {{bull}}
|
• | bold bullet | '''•''' or '''{{bull}}''' or <b>{{bull}}</b>
|
– | ndash | –
|
— | mdash | —
|