Template:RunningHeader/doc

Usage

Intended to simplify the display of running headers (can also be used for footers) when transcribing scanned text pages. Many texts include running headers (chapter names, etc.) centered at the top of a page, with accompanying page numbers on the left or right side (depending on whether the page number is even or odd).

3-part headers (left, centre, right)

Most running headers have three parts, one on the left, one on the right and one in the centre. If the template is given 3 arguments or fewer, they correspond to the left, center, and right sides of the running header.

The template may be called using implicit parameters, in which case the order is left, center, right. For example:

{{RunningHeader|left|center|right}}

left

center

right

Alternatively, it may be called with explicit parameter names. For example:

{{RunningHeader|left=LEFT|center=CENTRE|right=RIGHT}}

LEFT

CENTRE

RIGHT

The use of explicit parameter names is especially useful in cases where one or more parameters are to be omitted.

4-part headers (left, left-centre, right-centre, right)

Some works, especially dictionaries and directories, have two headings in the centre of the page, one to the left and one to the right. In this case, you can provide 4 parameters, corresponding in turn to the left, left-centre, right-centre and right parts of the header.

{{RunningHeader|left|left-centre|right-centre|right}}

left

left-centre

right-centre

right

If a fourth parameter is present but blank, it will still trigger a 4-part header:

{{RunningHeader|left|left-centre|right-centre|}}

left

left-centre

right-centre

Page styles

This template adds the class wst-running-header (search for .wst-running-header in CSS files) to the outer container.

You can target the "cells" of the header with CSS like .wst-running-header-cell:nth-child(n), where n is 1, 2 or 3 (or 4, for a 4-cell header).

Additional parameter: style

Where there is a need to specify the style of the text, an optional "style" parameter can be used. This parameter takes the same style attributes that can be set for any <div> element in the 3-part headers case or table row in the 4-part headers case.

{{RunningHeader|style=font-size:110%; font-style:italic|left|left-centre|right-centre|right}}

left

left-centre

right-centre

right

If a style is repeated for all headers in a book, prefer the CSS method.

Redirects

{{Running header}} and {{rh}} redirect here. Use these forms of the template if you prefer.

Templatedata

Simplify the display of running headers (and footers) when transcribing scanned text pages.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Left	left 1	Left-side text.	String	suggested
Center (or center-left)	center centre 2	The center text.	String	suggested
Right (or right-center)	right 3	The right-side text.	String	suggested
Right (if 4 params used)	4	If four parameters are given, they will be arranged in four equal widths across the width of the page.	String	optional
style	style	The style of the text; this parameter takes the same style attributes that can be set for any <div> element	String	optional
class	class	Additional CSS classes to apply to running header.	Unknown	optional

See also

• {{recto-verso header}} -- for simple headers that vary by page number
• {{recto-verso header2}} -- for more complicated headers that vary by page number
• {{recto-verso header3}} -- for left/right aligned non-page number headers
• {{rh/2}}
• {{rh/3}}
• {{rh/5}}
• {{rh/lr}}
• {{right}} for right text-alignment
• {{left}} for left text-alignment