Meghdhanu: 1 revision imported

2023-08-09T01:30:42Z

1 revision imported

← Older revision		Revision as of 01:30, 9 August 2023
(No difference)

enws>ShakespeareFan00 at 10:08, 3 August 2023

2023-08-03T10:08:11Z

New page

{{documentation subpage}}
{{high-use|259000}}
{{templatestyles|Template:Rule/styles.css}}

==Usage==

This template inserts a black horizontal rule. It should be used in transcriptions in preference to wiki syntax "----", which inserts a rule but in a lighter colour. Furthermore there can be no certainty that the rendering of "----" will not change in the future. [http://www.w3schools.com/tags/tag_hr.asp Please check] for any [X]HTML 5 issues as well.

For example
<nowiki>{{rule}}</nowiki>
produces
{{rule}}

The common case of a double-rule can be achieved by
<nowiki>{{rule}}{{rule}}</nowiki>
which produces
{{rule}}{{rule}}

[[Template:Double rule]] may be used as shorthand for this.

===Width===
A width may optionally be provided, in ''em'' or ''by %'' in which case a black horizontal rule of that width is centered on the line.

For example
<nowiki>{{rule|width=12em}}</nowiki>
and
<nowiki>{{rule|12em}}</nowiki>
both produce

{{rule|12em}}

===Height ===
Height is provided by the named {{parameter|height}} parameter:

<nowiki>{{rule|height=3px}}</nowiki>

{{rule|height=3px}}

===Alignment===
In rare cases where the left or right alignment is required, the {{parameter|align}} parameter may be used.

{{doc example|content=
<pre>
{{rule|6em|align=left}}</pre>
produces

{{rule|6em|align=left}}
}}

=== Top/bottom margins ===

If the rule has wider padding around it, this can be set with {{parameter|margin_tb}}:

{{doc example|content=
<pre>
{{center|
Foo
{{rule|margin_tb=2em}}
Bar
}}
</pre>
produces
{{center|
Foo
{{rule|margin_tb=2em}}
Bar
}}
}}

===Class===

{{class notice|class=.wst-rule}}

===Style===
Finally, any desired special HTML styling may be applied through the ''style'' parameter.

For example
<nowiki>{{rule|width=12em|height=1em|style=background-color:orange;border:1px solid black}}</nowiki>

produces

{{rule|width=12em|height=1em|style=background-color:orange;border:1px solid black}}

==Redirects==
*{{tl|Hline}}

==See also==

* {{tl|section end rule}} for a semantic rule at the end of a section
* {{tl|separator}} for a row of dots
* {{tl|custom rule}} for a customized decorative rule
* {{tl|longdash}} for an inline long dash
* {{tl|bar}} for an inline, user specified length of the dash

<includeonly>
[[Category:Formatting templates|{{PAGENAME}}]]
</includeonly>
<templatedata>
{
"params": {
"1": {
"aliases": [
"width"
],
"label": "width",
"description": "width of rule. (CSS 'units specifcations should be used)",
"suggested": true,
"type": "string"
},
"class": {
"label": "class",
"description": "CSS classes to apply to the created HR element.",
"type": "string"
},
"color": {
"label": "color",
"description": "color that should be applied to the rule , CSS style color specifcations should be used.",
"type": "string"
},
"align": {
"label": "align",
"description": "(Option) Aligns the rule with the left or right of the containing content.",
"suggestedvalues": [
"left",
"right"
],
"type": "string"
},
"margin_tb": {
"label": "margin_tb",
"description": "Vary the vertical spacing around the rule. (uses CSS unit specifcations.)",
"type": "string"
},
"height": {
"label": "height",
"description": "Varies the vertical height of the rule (Uses CSS units)",
"type": "string",
"aliases": [
"2"
]
},
"style": {
"label": "style",
"description": "Additional CSS styles to be applied to the 'rule' ",
"type": "string"
}
},
"description": "Adds a horizontal rule to content.",
"format": "inline"
}
</templatedata>

Template:Rule/doc - Revision history

Meghdhanu: 1 revision imported

enws>ShakespeareFan00 at 10:08, 3 August 2023