साचा:Translation header/doc

This is a documentation subpage for साचा:Translation header.
It contains usage information, categories and other content that is not part of the original साचा page.

One can preload Template:Translation header/preload

Usage

{{translation header
 | title    = 
 | author   = 
 | section  = 
 | previous = 
 | next     = 
 | shortcut = 
 | year     = 
 | language = 
 | original = 
 | notes    = 
}}

This template is meant to be used at the top of a work in the Translation: namespace. 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

title = title of the work, for subpage use relative links.
author = name of author, not wikilinked. Not the name of the translator, which will be included automatically as "Wikisource".
- Where control of linking is required add override_author; see No link to author page.
editor = editor of the work, not wikilinked. Use override_editor for full control.
section = name of subdivision of work, usually used on subpages.
contributor = name of the author of this section, if not the same as author the overall work. Not wikilinked; use override_contributor if you need to specify the link target.
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.
language = ISO code of the language in which the work was originally written (find the ISO code here—be sure to use the first one listed), adds work to the category for the original language, see Category:Translations.
original = name of the page that hosts the original language work (or chapter) on the appropriate language Wikisource. A standard interlanguage link to the original language work (or chapter) should also be present, though.
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 tenuous year, enter it as "Y/?" (e.g. 1066/?). This will display as, for example, "1066?"
4. 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 will refer to further information on the work's talk page. (Applied with edition = yes).
notes = notes to explain the work, to add context, or to impart concise information that adds value to the reader.
categories = Forward-slash-separated list of categories.
shortcut = The shortcut to this page, if it exists. This is normally reserved for very large reference works (e.g. EB11).

{{header
 | title      = 
 | author     = 
 | section    = 
 | previous   = 
 | next       = 
 | year       = 
 | language   = 
 | original   = 
 | portal     = 
 | wikipedia  = 
 | commons    = 
 | commonscat = 
 | wikiquote  = 
 | wikinews   = 
 | wiktionary = 
 | wikibooks  = 
 | wikiversity= 
 | wikispecies= 
 | wikivoyage = 
 | wikidata   = 
 | wikilivres = 
 | meta       = 
 | notes      = 
}}

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

Subpages

For subpages in the Translation: namespace, use {{Translation subpage}} where no additional text is required.

Usage examples

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.