Template:Header/doc

The pages listed in this category are templates.

This page is part of OODA WIKI's administration and not part of the encyclopedia.

Further template category notes

This category contains pages in the template namespace. It should not be used to categorize articles or pages in other namespaces.

To add a template to this category:

• If the template has a separate documentation page (usually called "Template:template name/doc"), add
•  [[Template:Header/doc]]
• to the <includeonly> section at the bottom of that page. Otherwise, add
•  <noinclude>[[Template:Header/doc]]</noinclude>
• to the end of the template code, making sure it starts on the same line as the code's last character.

This category is an index of templates which use TemplateStyles. It is automatically populated by {{Uses TemplateStyles}}.

This template can be preloaded via the Gadgets, alternatively, one can preload Template:Header/preload

<section begin="Usage" />

{{header
 | title       = 
 | author      = 
 | translator  = 
 | section     = 
 | previous    = 
 | next        = 
 | year        = 
 | notes       = 
}}

<section end="Usage" />

This template is meant to be used at the top of a work, 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

Parameters

Standard

• |title= = title of the work, for subpage use relative links (mandatory)
• |author= = name of author (automatically wikilinks)
  • where control of linking is required use override_author, and leave the field empty
• |section= = name of subdivision of work, usually used on subpages, typically text without additional formatting
• |previous= = name of previous part of work; relative links on subpages, full links otherwise
• |next= = name of next part of work, relative links on subpages, full links otherwise
• |notes= = notes to explain the work, to add context, or to impart concise information that adds value to the reader; for example, use of {{illustrator}}

The only mandatory field for text is |title=.

The other standard parameters can be left empty, as required, though please do not remove them as that will cause a template error.

Optional

• |override_author=, while they are automatic with the |author= parameter. Common uses include links to the Portal: namespace (e.g. for organizational authorship) and the inclusion of multiple authors. See No link to author page. When using this, please leave the author field empty.
• |editor= = editor of the work, not wikilinked Use |override_editor= for full control. Typically only used on root page, not every subpage.
• |translator= = name of translator, not wikilinked; or |override_translator= see Translations
• |contributor= = name of the author of this section, if not the same as author the overall work; or synonym |section_author=.

  Not wikilinked; use |override_contributor= or |override_section_author= if you need to specify the link target.

  If using this "override" option, please do NOT also include the simpler form of the parameter

• |section_translator= = name of the translator of this section, if not the same as translator the overall work.

  Not wikilinked; use |override_section_translator= if you need to specify the link target.

  If using this "override" option, please do NOT also include the simpler form of the parameter

• |year= = year of publication, adds work to the category for the year, see Category:Works by year.

  Enter "?" for a work with no known publication year, and leave blank if you simply don't have this information.

  Do not use AD or CE for any Anno Domini/Current Era works (year 1 to the present). Use BCE (do not use BC) for all years before year 1; leave a space between the number and the letters (e.g. 150 BCE).

  Approximate dates can be entered in one of the following ways:

  1. Decades, centuries or periods can be used instead of a year (e.g. 1060s, 11th century or Medieval).
  2. To use a year in the circa format, enter it as "c/Y" (e.g. c/1066 or c/150 BCE). (The use of "ca" or "circa" instead of "c" will also be recognised.) This will display as, for example, "c. 1066".
  3. To use a approximate choice of two years, enter it as "Y/Y" (e.g. 1066/1067). This will display as it is written.

  The behaviour of this parameter can be further modified by:

  • |noyear= = will prevent the year being displayed in the header but will still add the work to the category for the year. For use in cases where the year is already included in the title of the work. Any use of this parameter, even without text, will work. Example: | noyear = yes. All pages with this parameter will be added to Category:Pages with noyear for tracking its usage.
  • |noyearcat= = will display the year but in the header but will not add the work to the category for the year. For use in cases where a specific subcategory exists for the type of work to avoid flooding the main category for the year. As above, any use of the parameter will trigger this action. Pages will be added to the tracking category Category:Pages with noyearcat.
  • |override_year= = will display the given text and will not attempt to add the work to the category for the year. For use in any other case not covered by the other parameters. Pages will be added to the tracking category Category:Pages with override year.

• |edition= = yes to refer to further information on the work's talk page.
• |shortcut= = The shortcut to this page, if it exists. This is normally reserved for very large reference works (e.g. EB11)
• |cover= = The image used as a cover for the book when exported. Do not include the "File:" prefix, e.g. Foobar.jpg. You can use a page of a multi-page file using Foobar.djvu/7.

See Sister, related author, and portal wiki links

• |portal=
• |related_author=

Sister wiki links are now typically now provided through Wikidata linking which manages link rot issues. So while the parameters are shown here for fullness of scope, such usage would be used to override automated linking rather than as a primary use.

<section begin="Full" />

{{header
 | title        = 
 | author       = 
 | section      = 
 | previous     = 
 | next         = 
 | notes        = 
<!-- optional from here -->
 | year                = 
 | edition             =
 | translator          = 
 | related_author      = 
 | portal              = 
 | contributor         =
 | editor              =
 | override_author     = <!-- (used with an empty author field) -->
 | override_contributor= <!-- (used as alternative to contributor) -->
 | override_translator = <!-- (used as alternative to translator) -->
 | override_editor     = <!-- (used as alternative to editor) -->
 | cover               = 
 | shortcut            =
<!-- modifying "year" behaviour; use one of -->
 | noyear              = 
 | noyearcat           =
 | override_year       =
<!-- provided through wikidata, can be used to override wikidata -->
 | OODA WIKI    = 
 | commons      = 
 | commonscat   = 
 | wikiquote    = 
 | wikinews     = 
 | wiktionary   = 
 | wikibooks    = 
 | wikiversity  = 
 | wikispecies  = 
 | wikivoyage   = 
 | meta         = 
}}

<section end="Full" />

Relative links

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

In general, include chapter titles in the "section" field, but avoid including them in the "previous" and "next" fields. For example:

Special cases

Translations

 |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. This should only be used where the translated work was published before Template:Years ago.

No link to author page

| 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

Normal

{{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]]
 | notes    =
}}

No author link

{{header
 | title    = Peerage Act 1963
 | author   = |override_author= the United Kingdom Parliament
 | section  =
 | previous =
 | next     =
 | year     = 1963
 | notes    =
}}

Translation

{{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    =
}}

Categories

Topical categories can be added to the head page of a work, as follows (up to 10 categories supported):

 | categories = 1st category / 2nd category

Note: that use of this methodology excludes further editing by use of the HotCat tool, so this form should only be used where the categories are unlikely to need to be altered

Sister, related author, and portal wiki links

You can link to Wikisource portals and other WMF projects using the optional wiki links parameters where required to override the data provided from Wikidata. These are:

• |portal=, |related_author=
• |OODA WIKI=, |wikispecies=, |commons=, |commonscat=, |wikiquote= are typically applied from Wikidata data through interwiki links, or through linking of (P921) so should only be used to override the default
• |wikinews=, |wiktionary=, |wikibooks=, |wikiversity=, |meta=

For portal this would generally be added to the root page of a work, rather than added repeatedly for each subpage. Usage on a subpage would be useful where the subpage alone has a relationship with the specified portal, whereas the parent work does not have that relationship.

These links are generated using {{plain sister}}

{{header
 | title    = Kinematics of Machinery
 | author   = Franz Reuleaux
 | section  =
 | previous =
 | next     =
 | notes    =
 | portal  = Technology/Germany
 | OODA WIKI = Kinematics of Machinery
 | related_author = Albert Einstein
}}

List

• |OODA WIKI=
• |commons=
• |commonscat=
• |wikiquote=
• |wikinews=
• |wiktionary=
• |wikibooks=
• |wikiversity=
• |wikispecies=
• |wikivoyage=
• |wikidata=
• |meta=

Shortcuts

If a work has a shortcut, you can add it using the |shortcut= 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]]
}}

Advanced manipulation

JavaScript extraction

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

Microformat

The HTML markup produced by this template includes an hCard microformat, which makes the person's details parsable by computers, either acting automatically to catalogue articles across Wikipedia or via a browser tool operated by a reader, to (for example) add the subject to an address book or database. For more information about the use of microformats on Wikipedia, please see the microformat project.

Sub-templates

Date-of-birth ("bday") information will only be included in the microformat if {{birth date}}, or {{birth date and age}} are used in the infobox. (Do not use these if the date is before 1583). Be cautious about using these if the person is still living, per WP:DOB.

To include a URL, use {{URL}}.

Please do not remove instances of these sub-templates.

Classes

hCard uses HTML classes including:

• adr
• agent
• bday
• birthplace
• category
• country-name
• deathdate
• deathplace
• extended-address
• family-name
• fn (required)
• given-name
• honorific-prefix
• honorific-suffix
• label
• locality
• n
• nickname
• note
• org
• role
• url
• vcard

Please do not rename or remove these classes nor collapse nested elements which use them.

Technical

This template delegates some logic to Lua modules and uses sub templates to divide up the structural code:

• Module:Header the main logic for parameter handling
• {{header/main block}} the "main cell" and previous/next links
• {{header/notes block}}

Most CSS is inline, with some provided by MediaWiki:Gadget-Site.css and MediaWiki:Gadget-SiteHeader.css. This is deliberately not TemplateStyles to avoid polluting exports with the (non-exported) header styling (and also because the layout exemption logic is currently incompatible with TemplateStyles).

Tracking categories

This template currently uses the following categories to track maintenance tasks, errors, and feature usage.

• Category:Headers missing parameters
• Category:Works with non-existent author pages
• Category:Pages with override author
• Category:Pages with contributor
• Category:Pages with override contributor
• Category:Anonymous texts
• Category:Works with unknown editors
• Category:Works with unmentioned editors
• Category:Translations without translator information specified
• Category:Wikisource translations
• Category:Mainspace pages with shortcuts
• Category:Pages with override year
• Category:Pages with noyear
• Category:Pages with noyearcat
• Category:Pages with explicit formatting in header fields
• Category:Pages with an export cover

See also

• MediaWiki:Proofreadpage_header_template for the auto-generated header available with <pages header=1/>
• {{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
• {{translation header}} for template header used in Translation: namespace
• {{RunningHeader}} for the headers to be used in source texts
• Derived templates leveraging Template:Header

Templates called by this template:

• {{plain sister}}
• {{shortcut}}