Template:RunningHeader/doc

From Wikisource
Jump to navigation Jump to search

Usage

[edit]

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). Some works, especially dictionaries and directories, have two headings in the center of the page, one to the left and one to the right.

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 third, or third, cell blank.

Example

{{rh|left|right}}
left
right

Example

{{rh|left|center|right}}
left
center
right

Example

{{rh|left|left-center|right-center|right}}
left
left-center
right-center
right

Example

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

Example

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

Parameters can be blank:

Example

{{rh|left|{{lorem ipsum}}|}}
left
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Page styles

[edit]

This template adds the class wst-rh (search for .wst-rh in CSS files) 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.

Redirects

[edit]

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

Tracking categories

[edit]

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
Numbered parameters1, …, n

Numbered parameters will be arranged in equal widths across the width of the page.

Stringsuggested
classclass

Additional CSS classes to apply to running header.

Unknownoptional
11

no description

Unknownoptional
22

no description

Unknownoptional
33

no description

Unknownoptional
44

no description

Unknownoptional
55

no description

Unknownoptional
66

no description

Unknownoptional
77

no description

Unknownoptional
88

no description

Unknownoptional
99

no description

Unknownoptional
centercenter centre

no description

Unknownoptional
leftleft

no description

Unknownoptional
rightright

no description

Unknownoptional

See also

[edit]