Template:RunningHeader/sandbox/doc
This is a documentation subpage for Template:RunningHeader/sandbox. It contains usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 1,580,000 pages, or roughly 35% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
This template uses Lua: |
This template uses TemplateStyles: |
This template uses block elements, e.g. This template applies the class(es) See H:DIVSPAN for details. |
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.
Example
{{rh|left|right}}
Example
{{rh|left|center|right}}
Example
{{rh|left|left-center|right-center|right}}
Example
{{rh|left|mid-left|center|mid-right|right}}
Example
{{rh|一|二|三|四|[page]|五|六|七|八|九}}
Parameters can be blank:
Example
{{rh|left|{{lorem ipsum}}|}}
Page styles
[edit]This template adds the class wst-rh
(search for .wst-rh in CSS files) to the outer container.
You can target the cells of the header with CSS like .wst-rh > :nth-child(n)
, where n is the cell number.
Redirects
[edit]{{Running header}}, {{runningheader}}, {{rh}}, {{RunningFooter}} and {{rf}} redirect here. Use these forms of the template if you prefer.
Tracking categories
[edit]- Category:Running headers using explicit parameter names (not necessarily problematic)
- Category:Running headers with undefined entries (not necessarily problematic)
- Category:Empty running headers (not necessarily problematic, but pointless)
- Category:Running headers applying manual styles (empty before migration part 1, then delete category and remove link)
- Category:Running headers with one entry (empty before migration part 2, then delete category and remove link)
- Category:Running headers with two entries (empty before migration part 2, then delete category and remove link)
- Category:Running headers with more than four entries (empty before migration part 2, then delete category and remove link)
TemplateData
[edit]RunningHeader/sandbox
Simplify the display of running headers (and footers) when transcribing scanned text pages.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Numbered parameters | 1, …, n | Numbered parameters will be arranged in equal widths across the width of the page. | String | suggested |
class | class | Additional CSS classes to apply to running header. | Unknown | optional |
See also
[edit]- {{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
- {{recto-verso header4}}—for left/right aligned page number headers
- {{recto-verso}}—for other headers that vary by page number
- {{left}} for left text-alignment
- {{center}} for center text-alignment
- {{right}} for right text-alignment
- {{issue banner}} for headers in periodicals