ਫਰਮਾ:Header/doc ਲਈ ਸਰੋਤ ਵੇਖੋ

{{Documentation subpage}}
{{high-use|541000}}
{{lua|Module:Header|Module:Edition|Module:String}}
<!--{{uses TemplateStyles|Template:Header/styles.css}} turned off for now -->
<!-- PLEASE ADD TEMPLATE CATEGORIES AT THE BOTTOM OF THIS PAGE AND INTERWIKIS IN WIKIDATA -->{{TOCright}}
This template can be preloaded via the [[Special:Preferences|Gadgets]], alternatively, one can preload [[Template:Header/preload]]

<section begin="Usage" />
<syntaxhighlight lang="html5" >
{{header
 | title       = 
 | author      = 
 | translator  = 
 | section     = 
 | previous    = 
 | next        = 
 | year        = 
 | notes       = 
}}
</syntaxhighlight>
<section end="Usage" />

This template is meant to be used at the top of a work,<ref group=notes>Certain projects have customised versions of {{tl|header}} that are used to present these works, eg. {{tl|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 {{tl|header}} should be discussed on the talk page, and consequentially listed on each project's pages.</ref> 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 ''[[Help:Header preloading script gadget|header preloading script gadget]]'' in your preferences.

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

The only mandatory field for text is {{parameter|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====
* {{anchor|override_author}}{{parameter|override_author}}, while they are automatic with the {{parameter|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|No link to author page]]. When using this, please leave the author field empty.
* {{parameter|editor}} = editor of the work, not wikilinked Use {{parameter|override_editor}} for full control. Typically only used on root page, not every subpage.
* {{parameter|translator}} = name of translator, not wikilinked; or {{parameter|override_translator}} see [[#Translations|Translations]]
* {{parameter|contributor}} = name of the author of this section, if not the same as author the overall work; or synonym {{parameter|section_author}}.
*: Not wikilinked; use {{Parameter|override_contributor}} or {{Parameter|override_section_author}} if you need to specify the link target.
*: If using this "override" option, please do {{sc|not}} also include the simpler form of the parameter
* {{parameter|section_translator}} = name of the translator of this section, if not the same as translator the overall work.
*: Not wikilinked; use {{Parameter|override_section_translator}} if you need to specify the link target.
*: If using this "override" option, please do {{sc|not}} also include the simpler form of the parameter
* {{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.'' <code>150 BCE</code>).
*:Approximate dates can be entered in one of the following ways:
*:#Decades, centuries or periods can be used instead of a year (''e.g.'' <code>1060s</code>, <code>11th century</code> or <code>Medieval</code>).
*:#To use a year in the circa format, enter it as "c/Y" (''e.g.'' <code>c/1066</code> or <code>c/150 BCE</code>). (The use of "ca" or "circa" instead of "c" will also be recognised.)  This will display as, for example, "c. 1066".
*:#To use a approximate choice of two years, enter it as "Y/Y" (''e.g.'' <code>1066/1067</code>).  This will display as it is written.
*: The behaviour of this parameter can be further modified by:
*:* {{parameter|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: <code>| noyear = yes</code>.  All pages with this parameter will be added to [[:Category:Pages with noyear]] for tracking its usage.
*:* {{parameter|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]].
*:* {{parameter|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]].
* {{parameter|edition}} <code>= yes</code> to refer to further information on the work's talk page.
<!-- * {{parameter|categories}} = Forward-slash-separated list of categories; deprecated -->
* {{parameter|shortcut}} = The shortcut to this page, if it exists. This is normally reserved for very large reference works (''e.g.'' [[EB11]])
* {{parameter|cover}} = The image used as a cover for the book when exported. Do not include the "File:" prefix, e.g. <code>Foobar.jpg</code>. You can use a page of a multi-page file using <code>Foobar.djvu/7</code>.

;See [[#Sister, related author, and portal wiki links|Sister, related author, and portal wiki links]]
* {{parameter|portal}}
* {{parameter|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" /><syntaxhighlight lang="html" highlight=8,22,26 >
{{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 -->
 | wikipedia    = 
 | commons      = 
 | commonscat   = 
 | wikiquote    = 
 | wikinews     = 
 | wiktionary   = 
 | wikibooks    = 
 | wikiversity  = 
 | wikispecies  = 
 | wikivoyage   = 
 | meta         = 
}}
</syntaxhighlight><section end="Full" />

===Relative links===
With lengthy, multi-page works, using [[m:Help:Link#Subpage_feature|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 <nowiki>[[/subpage]]</nowiki> (subpage), <nowiki>[[../]]</nowiki> (parent), and <nowiki>[[../sibling]]</nowiki> (sibling)<ref>The specific form <nowiki>[[../sibling/]]</nowiki> can be used on a sibling to provide both a relative link, and the link label to a sibling page.</ref>; see the example usage below. Note that <nowiki>[[../]]</nowiki> 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 [[WS:STYLE|Style guide]], with works in the form <nowiki>[[Work title]]</nowiki> and <nowiki>[[Work title/Subpage]]</nowiki>.

{{smallrefs}}

===Chapter titles===
In general, include chapter titles in the "section" field, but avoid including them in the "previous" and "next" fields. For example:
{{ {{BASEPAGENAME}}
 | title    = [[How the Other Half Lives]]
 | author   = Jacob Riis
 | section  = Chapter XI: The Sweaters of Jewtown
 | previous = [[How the Other Half Lives/Chapter X|Chapter X]]
 | next     = [[How the Other Half Lives/Chapter XII|Chapter XII]]
 | year     = 
 | notes    =
}}

===Special cases===
====Translations====
<pre> |translator=Joe</pre>
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 {{tl|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 {{years ago|95}}.

====No link to author page====
<pre>| author= |override_author=Joe</pre>
Displays the author's name without a link to an author page (for works that don't have traditional authors).

==Usage examples==
===Normal===
<syntaxhighlight lang="html5" >
{{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    =
}}</syntaxhighlight>

{{ {{BASEPAGENAME}}
 | title    = [[Alice's Adventures in Wonderland (1866)|Alice's Adventures in Wonderland]]
 | author   = Lewis Carroll
 | section  = Chapter 3: A Caucus-Race and a Long Tale
 | previous = [[Alice's Adventures in Wonderland (1866)/Chapter 2|Chapter 2]]
 | next     = [[Alice's Adventures in Wonderland (1866)/Chapter 4|Chapter 4]]
 | notes    =
}}

===No author link===
<pre>
{{header
 | title    = Peerage Act 1963
 | author   = |override_author= the United Kingdom Parliament
 | section  =
 | previous =
 | next     =
 | year     = 1963
 | notes    =
}}
</pre>
{{ {{BASEPAGENAME}}
 | title    = Peerage Act 1963
 | author   = |override_author= by the United Kingdom Parliament
 | section  =
 | previous =
 | next     = 
 | year     = 
 | notes    =
}}

===Translation===
<pre>
{{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    =
}}
</pre>
{{ {{BASEPAGENAME}}
 | title    = Fables
 | author   = Jean de La Fontaine
 | translator= Elizur Wright
 | section  =
 | previous =
 | next     =
 | notes    =
}}
{{ {{BASEPAGENAME}}
 | title    = Pantagruel
 | author   = François Rabelais
 | override_translator= [[Author:Thomas Urquhart|Thomas Urquhart]] and [[Author:Peter Antony Motteux|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):

<pre>
 | categories = 1st category / 2nd category
</pre>

'''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:

*{{parameter|portal}}, {{parameter|related_author}}
* {{parameter|wikipedia}}, {{parameter|wikispecies}}, {{parameter|commons}}, {{parameter|commonscat}}, {{parameter|wikiquote}} are typically applied from Wikidata data through interwiki links, or through linking of {{property|P921}} so should only be used to override the default
* {{parameter|wikinews}}, {{parameter|wiktionary}}, {{parameter|wikibooks}}, {{parameter|wikiversity}}, {{parameter|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.

{{smaller|These links are generated using {{tl|plain sister}}}}

<pre>
{{header
 | title    = Kinematics of Machinery
 | author   = Franz Reuleaux
 | section  =
 | previous =
 | next     =
 | notes    =
 | portal  = Technology/Germany
 | wikipedia = Kinematics of Machinery
 | related_author = Albert Einstein
}}
</pre>
{{ {{BASEPAGENAME}}
 | 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
}}

;List 
* {{parameter|wikipedia}}
* {{parameter|commons}}
* {{parameter|commonscat}}
* {{parameter|wikiquote}}
* {{parameter|wikinews}}
* {{parameter|wiktionary}}
* {{parameter|wikibooks}}
* {{parameter|wikiversity}}
* {{parameter|wikispecies}}
* {{parameter|wikivoyage}}
* {{parameter|wikidata}}
* {{parameter|meta}}

==Shortcuts==

If a work has a shortcut, you can add it using the {{parameter|shortcut}} field. This should be in accordance with the [[WS:SHORT|shortcut guidelines]], and shortcuts should ''not'' be used for every work.

<pre>
{{header
 | title    = 1911 Encyclopædia Britannica
 | author   = 
 | section  =
 | previous =
 | next     =
 | notes    =
 | shortcut = [[EB1911]]
}}
</pre>
{{ {{BASEPAGENAME}}
 | title    = 1911 Encyclopædia Britannica
 | author   = 
 | section  =
 | previous =
 | next     =
 | notes    =
 | shortcut = [[EB1911]]
}}


==Advanced manipulation==

===Alternative headers===

<references group=notes />

===JavaScript extraction===
The header values can be extracted using [[w:JavaScript|JavaScript]] by accessing the text values of their span wrappers:
{| class="prettytable"
! value
! wrapper id
|-
| title
| header_title_text
|-
| author
| header_author_text
|-
| translator
| header_translator_text
|-
| previous
| headerprevious
|-
| next
| headernext
|-
| notes
| ''none''
|}

== Microformat ==
{{UF-hcard-person}}

== 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
* {{tl|header/main block}} the "main cell" and previous/next links
* {{tl|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 <code><nowiki><pages header=1/></nowiki></code>
* {{tl|textinfo}} for recording information on work's talk page
* {{tl|author}} for template header used in Author: namespace
* {{tl|process header}} for template header used in Wikisource: namespace
* {{tl|portal header}} for template header used in Portal: namespace
* {{tl|translation header}} for template header used in Translation: namespace
* {{tl|RunningHeader}} for the headers to be used in source texts
* <span class="plainlinks">[{{fullurl:Special:WhatLinksHere|target=Template:Header&namespace=10}} Derived templates leveraging Template:Header]</span>

Templates called by this template:
* {{tl|plain sister}}
* {{tl|shortcut}}

<!-- categories links -->
<includeonly>
[[Category:Header templates|{{PAGENAME}}]]
[[Category:Templates emitting hCard microformats|{{PAGENAME}}]]
</includeonly>