Admin Bastian: 1 revision imported

2017-12-15T10:32:15Z

1 revision imported

← Older revision	Revision as of 10:32, 15 December 2017
(No difference)

Numero6: Add Category

2017-03-26T21:01:13Z

Add Category

New page

{{Documentation subpage}}
{{nosubst}}
{{Template shortcut|od}}


For outdenting a reply on a talk page when indention gets too deep.

Indenting on talk pages is done using a colon character (:) to produce "tabs"; this template produces a connector bar and (optionally) initial text to indicate an outdent, with the length of the bar specified by the number of colons used in the template. The left margin is sent to the position of the template. "<nowiki>::{{od}}</nowiki>" produces:
::{{od}}

The template also has a named parameter to reverse the direction of the bar to indicate deeper indentation- see [[#Indent]] below. "<nowiki>::{{od|reverse=x}}</nowiki>" produces:
::{{od|reverse=x}}

== Usage ==
'''<nowiki>{{ Outdent / outdent / od | optional param1 | optional param2 }} </nowiki>'''
:param1:
:*If the first parameter is not used, the left margin is reset to the position of the template, and the default value of 10 is used for the length of the bar.
:*If used, its value specifies the length of the connector bar to be used. The value may be specified as a string of tab characters, or as an integer.
:*A value of null causes an error. A value of zero produces a very long bar.
:param2:
:*If used, specifies that the string ([[WP:Indentation#Outdenting|outdent]]) is to be placed at the start of the new line's text. (Note: When param2 is used, param1 may not be null.)

The template supports up to 20 colons as a parameter, but supports any given integer. Values above 40 may result in the bar appearing over more than one line.

The default number of colons is 10.

The template also recognizes the named parameter "reverse" - see [[#Indent]] below.

===Examples===
To outdent posts, insert the number of colons that were used for indenting in the previous post, or use an integer value for that number.

<div style="border:thin blue solid; padding:8px; margin:4px">
<pre>::::This is the previous post, indented 4 levels
{{Outdent|::::}} Start of a new post</pre>

displays as

::::This is the previous post, indented 4 levels
{{Outdent|::::}} Start of a new post
</div>

<div style="border:thin blue solid; padding:8px; margin:4px">
<pre>::::::This is the previous post, indented 6 levels
{{Outdent|6}} Start of a new post</pre>

displays as

::::::This is the previous post, indented 6 levels
{{Outdent|6}} Start of a new post
</div>

<div style="border:thin blue solid; padding:8px; margin:4px">
<pre>Alternatively:
::::::This is the previous post, indented 6 levels
{{Outdent}} Start of a new post. ''(Note that the bar is longer - it is using the default value of 10.)''</pre>

displays as

::::::This is the previous post, indented 6 levels
{{Outdent}} Start of a new post. ''(Note that the bar is longer - it is using the default value of 10.)''
</div>

You can also have the template automatically add a linked tag, by adding any second parameter (its specific value is discarded):

<div style="border:thin blue solid; padding:8px; margin:4px">
<pre>::::::This is the previous post, indented 6 levels
{{Outdent|6|link}} Start of a new post</pre>

displays as

::::::This is the previous post, indented 6 levels
{{Outdent|6|link}} Start of a new post
</div>

To not outdent all the way to the left margin, the outdent template itself can be indented using one or more colons:
<div style="border:thin blue solid; padding:8px; margin:4px">
<pre>::::::This is the previous post, indented 6 levels
::{{Outdent|4}} Start of a new post</pre>

displays as

::::::This is the previous post, indented 6 levels
::{{Outdent|4}} Start of a new post
</div>

;More examples
<div style="border:thin blue solid; padding:8px; margin:4px">
<nowiki>{{Outdent}}xxx </nowiki>{{Outdent}}xxx<br>
</div>
<div style="border:thin blue solid; padding:8px; margin:4px">
<nowiki>{{outdent|1}}xxx </nowiki>{{outdent|1}}xxx<br>
</div>
<div style="border:thin blue solid; padding:8px; margin:4px">
<nowiki>{{od|2}}xxx </nowiki>{{od|2}}xxx
</div>
<div style="border:thin blue solid; padding:8px; margin:4px">
<nowiki>{{od|6}}xxx </nowiki>{{od|6}}xxx
</div>
<div style="border:thin blue solid; padding:8px; margin:4px">
:::<nowiki>{{od|1|anything}}xxx</nowiki>{{od|1|anything}}xxx
</div>
<div style="border:thin blue solid; padding:8px; margin:4px">
:::<nowiki>{{od|6|xxx}}xxx </nowiki>{{od|6|xxx}}xxx
</div>

===Indent===
The named parameter "reverse" can be set so: <nowiki>{{</nowiki>Outdent|reverse=''string''}} where string can be any character or string of characters. It will also work with the optional unnamed parameters described previously. Its purpose is to allow for indention. For example:

<div style="border:thin blue solid; padding:8px; margin:4px">
<pre>::::::This is the previous post, indented 6 levels
::{{Outdent|4}} Start of a new post indented 2 levels using a bar of length 6-2=4.
::{{Outdent|5|reverse=yes}}
:::::::Indent 7 levels using a revered bar of length 7-2=5.</pre>

displays as

::::::This is the previous post, indented 6 levels
::{{Outdent|4}} Start of a new post indented 2 levels using a bar of length 6-2=4.
::{{Outdent|5|reverse=yes}}
:::::::Indent 7 levels using a reversed bar of length 7-2=5.
</div>

<div style="border:thin blue solid; padding:8px; margin:4px">
<pre>
::::::Original conversation.
::::::{{od|3|reverse=x}}
:::::::::Afterthought.
:::::::{{od|2}}
:::::::Continuation of original conversation.</pre>

displays as

::::::Original conversation.
::::::{{od|3|reverse=x}}
:::::::::Afterthought.
:::::::{{od|2}}
:::::::Continuation of original conversation.</pre>
</div>

===CSS and hide===
This template is contained in the CSS class "outdent-template". Users who would prefer not to see the template can add the following line to their custom CSS ([[Special:MyPage/common.css]]):

:<code>span.outdent-template { display: none; }</code>

==Errors and unexpected behaviours==
* param1 = 0 gives a long bar:
<div style="border:thin blue solid; padding:8px; margin:4px">
<nowiki>{{od|0}}xxx </nowiki>{{od|0}}xxx
</div>
* param1 > 40 places the bar over several lines:
<div style="border:thin blue solid; padding:8px; margin:4px">
::<nowiki>{{od|99}}xxx </nowiki>{{od|99}}xxx
</div>
* param1 may not be null:
<div style="border:thin blue solid; padding:8px; margin:4px">
<nowiki>{{od|}}xxx </nowiki>{{od|}}xxx
</div>
<div style="border:thin blue solid; padding:8px; margin:4px">
<nowiki>{{od||label}}xxx</nowiki>{{od||label}}xxx
</div>

==Other formats==
"<nowiki>::{{od}}xxx</nowiki>" produces:
::{{od}}xxx
"<nowiki>::{{od|10|xxx}}xxx</nowiki>" produces:
::{{od|10|xxx}}xxx
----
* {{tl|Outdent2}} and {{tl|od2}} - Rather than a bar on the previous line, produces a bracketed arrow on the same line. "<nowiki>::{{od2}}xxx</nowiki>" produces:
::{{od2}}xxx
* {{tl|Undent}} - Rather than a bar on the previous line and "outdent", produces ([[Wikipedia:Indentation|undent]]). "<nowiki>::{{undent}}xxx</nowiki>" produces:
::{{undent}}xxx

== See also ==
* [[WP:INDENT]]

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

[[Category:Talk namespace templates]]
}}</includeonly>

<noinclude> [[Category:Template]] </noinclude>

Template:Outdent/doc - Revision history

Admin Bastian: 1 revision imported

Numero6: Add Category