Template:Header/doc

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





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.

Parameters

 * = title of the work, for subpage use relative links
 * = name of author, not wikilinked
 * where control of linking is required add ; see No link to author page
 * = editor of the work, not wikilinked. Use for full control.
 * = name of translator, not wikilinked; or see Translations
 * = name of subdivision of work, usually used on subpages
 * = name of the author of this section, if not the same as author the overall work. Not wikilinked; use if you need to specify the link target.
 * = 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
 * = 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 tenuous year, enter it as "Y/?" (e.g. ).  This will display as, for example, "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.
 * = 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.
 * to refer to further information on the work's talk page.
 * = notes to explain the work, to add context, or to impart concise information that adds value to the reader
 * = Forward-slash-separated list of categories
 * = The shortcut to this page, if it exists. This is normally reserved for very large reference works (e.g. EB11)


 * See Sister, related author, and portal wiki links





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:

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.)

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).

Categories
Topical categories should be added to the head page of every work, as follows (up to 10 categories supported):

| categories = 1st category / 2nd category

Sister, related author, and portal wiki links
You can link to Wikisource portals and other WMF projects using the optional wiki links parameters. These are:



These links are generated using plain sister

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
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
The header values can be extracted using JavaScript by accessing the text values of their span wrappers: