Template:RunningHeader/doc

2022-12-11T11:55:21Z

88.97.96.89:

{{Documentation subpage}}{{template shortcut|rh|RunningFooter|rf}}
{{high-use|900000}}
{{uses TemplateStyles|Template:RunningHeader/styles.css}}
{{div-based-template|class=.wst-running-header}}

==Usage==

Intended to simplify the display of [[w:Page header|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:

{{block center|
<pre>{{RunningHeader|left|center|right}}</pre>

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

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

{{block center|
<pre>{{RunningHeader|left=LEFT|center=CENTRE|right=RIGHT}}</pre>

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

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.

{{block center|
<pre><nowiki>
{{RunningHeader|left|left-centre|right-centre|right}}
</nowiki></pre>

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

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

{{block center|
<pre><nowiki>
{{RunningHeader|left|left-centre|right-centre|}}
</nowiki></pre>

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

=== Page styles ===

This template adds the class <code>wst-running-header</code> ({{search/css|.wst-running-header}}) to the outer container.

You can target the "cells" of the header with [[H:Page styles|CSS]] like <syntaxhighlight lang=css inline=yes>.wst-running-header-cell:nth-child(n)</syntaxhighlight>, 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 <nowiki>
<div></nowiki> element in the '''3-part headers''' case or table row in the '''4-part headers''' case.

{{block center|
<pre><nowiki>
{{RunningHeader|style=font-size:110%; font-style:italic|left|left-centre|right-centre|right}}
</nowiki></pre>

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

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

==Redirects==

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

==Templatedata==
<templatedata>
{
"params": {
"4": {
"label": "Right (if 4 params used)",
"description": "If four parameters are given, they will be arranged in four equal widths across the width of the page.",
"type": "string"
},
"left": {
"aliases": [
"1"
],
"label": "Left",
"description": "Left-side text.",
"type": "string",
"suggested": true
},
"right": {
"aliases": [
"3"
],
"label": "Right (or right-center)",
"description": "The right-side text.",
"type": "string",
"suggested": true
},
"center": {
"aliases": [
"centre",
"2"
],
"label": "Center (or center-left)",
"description": "The center text.",
"type": "string",
"suggested": true
},
"style": {
"label": "style",
"description": "The style of the text; this parameter takes the same style attributes that can be set for any <div> element",
"type": "string"
},
"class": {
"label": "class",
"description": "Additional CSS classes to apply to running header."
}
},
"description": "Simplify the display of running headers (and footers) when transcribing scanned text pages.",
"paramOrder": [
"left",
"center",
"right",
"4",
"style",
"class"
],
"format": "inline"
}
</templatedata>

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


<includeonly>{{sandbox other||
[[Category:Page numbering templates|RunningHeader]]
[[Category:Templates applying classes for page styles|RunningHeader]]
}}</includeonly>

Ekatra Foundation - User contributions [en]

Template:RunningHeader/doc