Template:Header/doc

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



This template is meant to be used at the top of a work in the namespace and its subsections. Fill in any relevant information, and leave unknown or inapplicable parameters empty. For easy use, see also the header preloading script gadget in your preferences.

Standard

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

Optional

 * Parameters modifying
 * , used to change how displays.
 * By default,  will produce the link Winston Leonard Spencer Churchill, and   will produce the link Winston Churchill, but   will produce the link Winston Churchill.
 * , which disables automatic linking of the author parameter if true.
 * will display the author as "the United States Congress".
 * = name of the author of this section, if not the same as author the overall work; or synonym.
 * ,, , , etc. for additional authors. For example,  will display as "Winston Churchill and Winston Churchill".
 * = legacy parameter for unusual cases. When using this, please leave the author field empty.
 * All attribution parameters have the same behavior as author w.r.t.,  ,   and additional values.


 * = 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. ).
 * Approximate dates can be entered in one of the following ways:
 * Decades, centuries or periods can be used instead of a year (e.g.,   or  ).
 * To use a year in the circa format, enter it as "c/Y" (e.g.  or  ). (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. ). This will display as it is written.
 * The behaviour of this parameter can be further modified by:
 * = 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: . All pages with this parameter will be added to Category:Pages with noyear for tracking its usage.
 * = 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.
 * to refer to further information on the work's talk page.


 * = The shortcut to this page, if it exists. This is normally reserved for very large reference works (e.g. EB11)
 * = The image used as a cover for the book when exported. Do not include the "File:" prefix, e.g. . You can use a page of a multi-page file using.
 * , : For sorting purposes the template will move the articles "a", "an" and "the" to the end of the title, on the root page and all its subpages; for example, The Times/1854/News/The Charge of the Light Brigade will be sorted as "Times, The/1854/News/Charge of the Light Brigade, The". To override this, set to the desired sort key, e.g..
 * See Sister, related author, and portal wiki links
 * 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.
 * 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.
 * 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.



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:

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


 * ,, , , are typically applied from Wikidata data through interwiki links, or through linking of  so should only be used to override the default
 * ,, , , are typically applied from Wikidata data through interwiki links, or through linking of  so should only be used to override the default

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


 * List

Shortcuts
If a work has a shortcut, you can add it using the field. This should be in accordance with the shortcut guidelines, and shortcuts should not be used for every work.

Alternative headers

 * textinfo for recording information on work's talk page
 * versions and translations which also use
 * 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
 * RunningHeader for the headers to be used in source texts
 * [ Derived templates leveraging Template:]
 * [ Derived templates leveraging Template:]

Templates called by this template:
 * plain sister
 * shortcut