Difference between revisions of "Template:Outdent/doc"
Dinoguy1000 (talk | contribs) |
Dinoguy1000 (talk | contribs) (update documentation to reflect changes made to our copy) |
||
Line 7: | Line 7: | ||
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 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}} | ::{{od}} | ||
− | |||
− | |||
− | |||
==Usage== | ==Usage== | ||
Line 23: | Line 20: | ||
The default number of colons is 10. | The default number of colons is 10. | ||
− | |||
− | |||
===Examples=== | ===Examples=== | ||
Line 58: | Line 53: | ||
::::::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> | </div> | ||
Line 101: | Line 84: | ||
<div style="border:thin blue solid; padding:8px; margin:4px"> | <div style="border:thin blue solid; padding:8px; margin:4px"> | ||
:::<nowiki>{{od|6|xxx}}xxx </nowiki>{{od|6|xxx}}xxx | :::<nowiki>{{od|6|xxx}}xxx </nowiki>{{od|6|xxx}}xxx | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</div> | </div> | ||
Line 150: | Line 99: | ||
<div style="border:thin blue solid; padding:8px; margin:4px"> | <div style="border:thin blue solid; padding:8px; margin:4px"> | ||
::<nowiki>{{od|99}}xxx </nowiki>{{od|99}}xxx | ::<nowiki>{{od|99}}xxx </nowiki>{{od|99}}xxx | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</div> | </div> | ||
Revision as of 12:13, 25 June 2016
This is a documentation subpage for Template:Outdent. It contains usage information, categories and other content that is not part of the original template page. |
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. "::{{od}}" produces:
- Script error: No such module "outdent".
Contents
Usage
{{ Outdent / outdent / od | optional param1 | optional param2 }}
- 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 (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.
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.
::::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
- {{od|1|anything}}xxxScript error: No such module "outdent".xxx
- {{od|6|xxx}}xxx Script error: No such module "outdent".xxx
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):
span.outdent-template { display: none; }
Errors and unexpected behaviours
- param1 = 0 gives a long bar:
{{od|0}}xxx Script error: No such module "outdent".xxx
- param1 > 40 places the bar over several lines:
- {{od|99}}xxx Script error: No such module "outdent".xxx
Other formats
"::{{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:
- {{Undent}} — Rather than a bar on the previous line and "outdent", produces (undent). "::{{undent}}xxx" produces:
See also