Template:Header/doc
This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original template page. |
This template can be preloaded via the Gadgets, alternatively, one can preload Template:Header/preload
{{header | title = | author = | translator = | section = | previous = | next = | year = | notes = }}
This template is meant to be used at the top of a work,[1] and its subsections. Fill in any relevant information, and leave unknown or inapplicable parameters empty. Don't remove unused parameters, as this will break the template and make bot maintenance difficult. For easy use, see also the header preloading script gadget in your preferences.
Documentation[edit]
Parameters[edit]
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}} = title of the work, for subpage use relative links
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}} = name of author, not wikilinked
- where control of linking is required add
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}}; see No link to author page
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}} = name of translator, not wikilinked; or
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}} see Translations
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}} = name of subdivision of work, usually used on subpages
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}} = name of previous part of work; relative links on subpages, full links otherwise
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}} = name of next part of work, relative links on subpages, full links otherwise
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}} = year of publication, adds work to the category for the year, see Category:Works by year
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}} = notes to explain the work, or use of {{edition}} to refer to further information on the work's talk page.
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}}
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}}
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}}
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}}
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}}
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}}
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}}
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}}
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}}
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}}
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}}
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}}
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}}
{{header | title = | author = | translator = | section = | previous = | next = | year = | portal = | wikipedia = | commons = | commonscat = | wikiquote = | wikinews = | wiktionary = | wikibooks = | wikiversity= | wikispecies= | meta = | notes = }}
Relative links[edit]
With lengthy, multi-page works, using relative links is highly recommended. This shortens the code and ensures that a work remains linked together even if it is moved or reorganised. The three formats are [[/subpage]] (subpage), [[../]] (parent), and [[../sibling]] (sibling); see the example usage below. Note that [[../]] will expand to the title of the parent page, which is ideal if the work is renamed at a later time.
This depends on a page conforming to the page title standards in the Style guide, with works in the form [[Work title]] and [[Work title/Subpage]].
Chapter titles[edit]
In general, include chapter titles in the "section" field, but avoid including them in the "previous" and "next" fields. For example:
Special cases[edit]
Translations[edit]
|translator=Joe
The name of the translator. This will automatically be linked to an author page unless it contains the "[" character.
(A value of "?" or "unknown" adds {{No translator info}} to the page.)
(A value of "not mentioned" adds translator not mentioned to the page.)
No link to author page[edit]
| author= |override_author=Joe
Displays the author's name without a link to an author page (for works that don't have traditional authors).
Usage examples[edit]
Normal[edit]
{{header | title = [[../]] | author = Lewis Carroll | section = Chapter 3: A Caucus-Race and a Long Tale | previous = [[../Chapter 2|Chapter 2]] | next = [[../Chapter 4|Chapter 4]] | year = 1865 | notes = }}
No author link[edit]
{{header | title = Peerage Act 1963 | author = |override_author= the United Kingdom Parliament | section = | previous = | next = | year = 1963 | notes = }}
Peerage Act 1963
Translation[edit]
{{header | title = Fables | author = Jean de La Fontaine | translator= Elizur Wright | section = | previous = | next = | notes = }} {{header | title = Pantagruel | author = François Rabelais | override_translator= [[Author:Thomas Urquhart|]] and [[Author:Peter Antony Motteux|]] | section = | previous = | next = | notes = }}
Fables
by Jean de La Fontaine
Pantagruel
by François Rabelais
[edit]
You can link to Wikisource portals and other WMF projects using the optional wiki links parameters. These are:
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}},
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}},
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}},
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}},
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}},
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}},
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}},
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}},
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}},
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}},
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}}
These links are generated using {{plain sister}}
{{header | title = Kinematics of Machinery | author = Franz Reuleaux | section = | previous = | next = | notes = | portal = Technology/Germany | wikipedia = Kinematics of Machinery | commonscat = Kinematics of Machinery | related_author = Albert Einstein }}
Kinematics of Machinery
by Franz Reuleaux
Shortcuts[edit]
If a work has a shortcut, you can add it using the
|-
|{{{p}}}
|{{{{{r}}}}}
|Template:Fb p color
|Template:Fb p color||Template:Fb p color
|align=left|{{{d}}}
|align=left|{{{v}}} field. This should be in accordance with the shortcut guidelines, and shortcuts should not be used for every work.
{{header | title = 1911 Encyclopædia Britannica | author = | section = | previous = | next = | notes = | shortcut = [[EB1911]] }}
1911 Encyclopædia Britannica
Advanced manipulation[edit]
Alternative headers[edit]
^ Certain projects have customised versions of {{header}} that are used to present these works, eg. {{DNB00}} is used for the project involved with Dictionary of National Biography. For these works it is permissible and recommended that these variations are used. New alternatives to {{header}} should be discussed on the talk page, and consequentially listed on each project's pages.
JavaScript extraction[edit]
The header values can be extracted using JavaScript by accessing the text values of their span wrappers:
value | wrapper id |
---|---|
title | header_title_text |
author | header_author_text |
translator | header_translator_text |
previous | headerprevious |
next | headernext |
notes | none |
See also[edit]
- {{textinfo}} for recording information on work's talk page
- {{author}} for template header used in Author: namespace
- {{process header}} for template header used in Wikisource: namespace
- {{portal header}} for template header used in Portal: namespace