Template:Rule/doc

From Wikisource
Jump to navigation Jump to search

Usage[edit]

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




Width[edit]

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[edit]

Height is provided by the named height parameter:

{{rule|height=3px}}

Alignment[edit]

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[edit]

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[edit]

This template applies the class(es)
.wst-rule
that can be targeted with a work's index styles.css using page styles

Style[edit]

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[edit]

See also[edit]

  • {{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.

ParameterDescriptionTypeStatus
width1 width

width of rule. (CSS 'units specifcations should be used)

Stringsuggested
classclass

CSS classes to apply to the created HR element.

Stringoptional
colorcolor

color that should be applied to the rule , CSS style color specifcations should be used.

Stringoptional
alignalign

(Option) Aligns the rule with the left or right of the containing content.

Suggested values
left right
Stringoptional
margin_tbmargin_tb

Vary the vertical spacing around the rule. (uses CSS unit specifcations.)

Stringoptional
heightheight

Varies the vertical height of the rule (Uses CSS units)

Stringoptional
stylestyle

Additional CSS styles to be applied to the 'rule'

Stringoptional