Jump to content

Template:RunningHeader/doc

From Wikisource

This template is intended to simplify the reproduction of running headers (or footers) when transcribing scanned text pages. Many texts include running headers (chapter names, etc.) centered at the top of a page, accompanied by page numbers on the left or right side (depending on whether the page number is odd or even). Some works, especially dictionaries and directories, have two headings in the center of the page, one to the left and one to the right.

Usage

[edit]

You can provide any number of parameters to the template. By default, all heading "cells" are center-aligned, except for the first cell, which is left-aligned, and the last cell, which is right-aligned. Note that a usage with only one or two cells is really a three-cell header with the second and/or third cell blank.

Example

{{RunningHeader|left|center}}
left
center

Example

{{RunningHeader||center|right}}
center
right

Example

{{RunningHeader|left|center|right}}
left
center
right

Example

{{RunningHeader|left|left-center|right-center|right}}
left
left-center
right-center
right

Example

{{RunningHeader|left|mid-left|center|mid-right|right}}
left
mid-left
center
mid-right
right

Example

{{RunningHeader|一|二|三|四|[page]|五|六|七|八}}
一
二
三
四
[page]
五
六
七
八

Parameters can also be left blank:

Example

{{RunningHeader|left||TOP SECRET}}
left
TOP SECRET

Page styles

[edit]

This template adds the class wst-rh (search for .wst-rh in CSS pages) to the outer container.

You can target specific cells of the header with CSS like .wst-rh > div:nth-child(n), where n is the cell number, or target all cells with .wst-rh > div.

TemplateData

[edit]
This is the TemplateData documentation for this template used by VisualEditor and other tools.

RunningHeader

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

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Left-aligned text1 left

The text to display aligned with the page's left margin

Linesuggested
Centered text2 center centre

Text to display centered between the page margins, or if more than three parameters are defined, equidistantly between the first and third parameter values

Linesuggested
Right-aligned text3 right

Text to display aligned with the page's right margin, or if more than three parameters are defined, equidistantly between the second and fourth parameter values

Linesuggested
Fourth parameter4

Text to display aligned with the page's right margin, or if more than four parameter values are defined, equidistantly between the third and fifth

Lineoptional
Fifth parameter5

Text to display aligned with the page's right margin, or if more than five parameter values are defined, equidistantly between the fourth and sixth

Lineoptional
Sixth parameter6

Text to display aligned with the page's right margin, or if more than six parameter values are defined, equidistantly between the fifth and seventh

Lineoptional
Seventh parameter7

Text to display aligned with the page's right margin, or if more than seven parameter values are defined, equidistantly between the sixth and eighth

Lineoptional
Eighth parameter8

Text to display aligned with the page's right margin, or if more than eight parameter values are defined, equidistantly between the seventh and ninth

Lineoptional
Ninth parameter9

Text to display aligned with the page's right margin, or if more than nine parameter values are defined, equidistantly between the eighth and tenth

Lineoptional
Tenth parameter10

Text to display aligned with the page's right margin

Lineoptional
Additional CSS classesclass

CSS class names to apply to the HTML block container element

Lineoptional

Tracking categories

[edit]

See also

[edit]
  • {{Left}} – for left-aligned text
  • {{Center}} – for center-aligned text
  • {{Right}} – for right-aligned text
  • {{Issue banner}} – for headers in periodicals