Template:Rule/doc

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. Please check for any [X]HTML 5 issues as well.

For example

{{rule}}

produces

---

The common case of a double-rule can be achieved by

{{rule}}{{rule}}

which produces

---

---

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

{{rule|width=12em}}

and

{{rule|12em}}

both produce

---

Height

Height is provided by the named height parameter:

{{rule|height=3px}}

---

Alignment

In rare cases where the left or right alignment is required, the align parameter may be used.

Example

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

produces

---

Top/bottom margins

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

Example

{{center|
Foo
{{rule|margin_tb=2em}}
Bar
}}

produces

Foo

---

Bar

Class

This template applies the class(es)

that can be targeted with a work's index styles.css using page styles

Style

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

For example

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

produces

---

Redirects

• {{Hline}}

See also

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

Adds a horizontal rule to content.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
width	1 width	width of rule. (CSS 'units specifcations should be used)	String	suggested
class	class	CSS classes to apply to the created HR element.	String	optional
color	color	color that should be applied to the rule , CSS style color specifcations should be used.	String	optional
align	align	(Option) Aligns the rule with the left or right of the containing content. Suggested values left right	String	optional
margin_tb	margin_tb	Vary the vertical spacing around the rule. (uses CSS unit specifcations.)	String	optional
height	height 2	Varies the vertical height of the rule (Uses CSS units)	String	optional
style	style	Additional CSS styles to be applied to the 'rule'	String	optional