Difference between revisions of "Template:Outdent/doc"

From Yugipedia
Jump to: navigation, search
 
(these are fixed now)
 
(2 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
For outdenting a reply on a talk page when indention gets too deep.
 
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:
+
Indenting on talk pages is done using a colon character (:) to produce "tabs"; this template produces a connector bar, 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}}
 
::{{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==
 
==Usage==
−
'''<nowiki>{{ Outdent / outdent / od | optional param1 | optional param2 }} </nowiki>'''
+
'''<nowiki>{{ Outdent / outdent / od | optional param }} </nowiki>'''
−
:param1:
+
:*If the 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 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.
 
:*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.
+
:*A value of zero causes the template to use the default value of 10.
−
: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 template supports any number of colons or any integer as a parameter. Values above 40 result in the template using the default value of 10.
  
 
The default number of colons is 10.
 
The default number of colons is 10.
−
 
−
The template also recognizes the named parameter "reverse" — see [[#Indent]] below.
 
  
 
===Examples===
 
===Examples===
Line 58: Line 50:
 
::::::This is the previous post, indented 6 levels
 
::::::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.)''
 
{{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>
 
</div>
  
Line 95: Line 75:
 
<div style="border:thin blue solid; padding:8px; margin:4px">
 
<div style="border:thin blue solid; padding:8px; margin:4px">
 
<nowiki>{{od|6}}xxx      </nowiki>{{od|6}}xxx
 
<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 reversed 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>
 
</div>
  
Line 141: Line 81:
  
 
:<code>span.outdent-template { display: none; }</code>
 
:<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==
 
==Other formats==
Line 171: Line 94:
  
 
==See also==
 
==See also==
−
* [[WP:INDENT]]
+
* [[wikipedia:WP:INDENT]]
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

Latest revision as of 13:06, 25 June 2016

Shortcut

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, 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. "::{{od}}" produces:

Script error: No such module "outdent".

Usage[edit]

{{ Outdent / outdent / od | optional param }}

  • If the 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 zero causes the template to use the default value of 10.

The template supports any number of colons or any integer as a parameter. Values above 40 result in the template using the default value of 10.

The default number of colons is 10.

Examples[edit]

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. 

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

displays as

This is the previous post, indented 4 levels

Script error: No such module "outdent". Start of a new post 

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

displays as

This is the previous post, indented 6 levels

Script error: No such module "outdent". Start of a new post 

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.)''

displays as

This is the previous post, indented 6 levels

Script error: No such module "outdent". Start of a new post. (Note that the bar is longer — it is using the default value of 10.)

To not outdent all the way to the left margin, the outdent template itself can be indented using one or more colons: 

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

displays as

This is the previous post, indented 6 levels
Script error: No such module "outdent". Start of a new post
More examples

{{Outdent}}xxx Script error: No such module "outdent".xxx

{{outdent|1}}xxx Script error: No such module "outdent".xxx

{{od|2}}xxx Script error: No such module "outdent".xxx

{{od|6}}xxx Script error: No such module "outdent".xxx

CSS and hide[edit]

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):

span.outdent-template { display: none; }

Other formats[edit]

"::{{od}}xxx" produces:

Script error: No such module "outdent".xxx

"::{{od|10|xxx}}xxx" produces:

Script error: No such module "outdent".xxx
  • {{Outdent2}} and {{od2}} — Rather than a bar on the previous line, produces a bracketed arrow on the same line. "::{{od2}}xxx" produces:
Template:Od2xxx
  • {{Undent}} — Rather than a bar on the previous line and "outdent", produces (undent). "::{{undent}}xxx" produces:
Template:Undentxxx

See also[edit]


Retrieved from "https://yugipedia.com/index.php?title=Template:Outdent/doc&oldid=3110409"