Difference between revisions of "Template:Sourceheader/doc"
(Created page with '<section begin="Usage" /><pre> {{header | title = | author = | year = | translator = | section = | previous = | next = | notes = }}…') |
m (→JavaScript extraction) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
<section begin="Usage" /><pre> | <section begin="Usage" /><pre> | ||
| − | {{ | + | {{sourceheader |
| title = | | title = | ||
| author = | | author = | ||
| Line 21: | Line 21: | ||
===Chapter titles=== | ===Chapter titles=== | ||
In general, include chapter titles in the "section" field, but avoid including them in the "previous" and "next" fields. For example: | In general, include chapter titles in the "section" field, but avoid including them in the "previous" and "next" fields. For example: | ||
| − | {{ | + | {{sourceheader |
| title = [[How the Other Half Lives]] | | title = [[How the Other Half Lives]] | ||
| author = Jacob Riis | | author = Jacob Riis | ||
| Line 46: | Line 46: | ||
===Normal=== | ===Normal=== | ||
<pre> | <pre> | ||
| − | {{ | + | {{sourceheader |
| title = [[../]] | | title = [[../]] | ||
| author = Lewis Carroll | | author = Lewis Carroll | ||
| Line 55: | Line 55: | ||
}} | }} | ||
</pre> | </pre> | ||
| − | {{ | + | {{sourceheader |
| title = [[Alice's Adventures in Wonderland]] | | title = [[Alice's Adventures in Wonderland]] | ||
| author = Lewis Carroll | | author = Lewis Carroll | ||
| Line 66: | Line 66: | ||
===No author link=== | ===No author link=== | ||
<pre> | <pre> | ||
| − | {{ | + | {{sourceheader |
| title = Peerage Act 1963 | | title = Peerage Act 1963 | ||
| author = |override_author= the United Kingdom Parliament | | author = |override_author= the United Kingdom Parliament | ||
| Line 75: | Line 75: | ||
}} | }} | ||
</pre> | </pre> | ||
| − | {{ | + | {{sourceheader |
| title = Peerage Act 1963 | | title = Peerage Act 1963 | ||
| author = |override_author= the United Kingdom Parliament | | author = |override_author= the United Kingdom Parliament | ||
| Line 86: | Line 86: | ||
===Translation=== | ===Translation=== | ||
<pre> | <pre> | ||
| − | {{ | + | {{sourceheader |
| title = Fables | | title = Fables | ||
| author = Jean de La Fontaine | | author = Jean de La Fontaine | ||
| Line 95: | Line 95: | ||
| notes = | | notes = | ||
}} | }} | ||
| − | {{ | + | {{sourceheader |
| title = Pantagruel | | title = Pantagruel | ||
| author = François Rabelais | | author = François Rabelais | ||
| Line 105: | Line 105: | ||
}} | }} | ||
</pre> | </pre> | ||
| − | {{ | + | {{sourceheader |
| title = Fables | | title = Fables | ||
| author = Jean de La Fontaine | | author = Jean de La Fontaine | ||
| Line 114: | Line 114: | ||
| notes = | | notes = | ||
}} | }} | ||
| − | {{ | + | {{sourceheader |
| title = Pantagruel | | title = Pantagruel | ||
| author = François Rabelais | | author = François Rabelais | ||
| Line 126: | Line 126: | ||
==Advanced manipulation== | ==Advanced manipulation== | ||
===JavaScript extraction=== | ===JavaScript extraction=== | ||
| − | The header values can be extracted using [[ | + | The header values can be extracted using [[Wikipedia:JavaScript|JavaScript]] by accessing the text values of their span wrappers: |
{| class="prettytable" | {| class="prettytable" | ||
! value | ! value | ||
Latest revision as of 16:44, 21 September 2009
<section begin="Usage" />
{{sourceheader
| title =
| author =
| year =
| translator =
| section =
| previous =
| next =
| notes =
}}
<section end="Usage" />
This template is meant to be used at the top of an article. 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.
Contents
Documentation[edit]
Relative links[edit]
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 naming conventions, with works in the form [[Work title]] and [[Work title/Subpage]].
Chapter titles[edit]
In general, include chapter titles in the "section" field, but avoid including them in the "previous" and "next" fields. For example:
| ←Chapter X | How the Other Half Lives by Jacob Riis Chapter XI: The Sweaters of Jewtown |
Chapter XII→ |
Special cases[edit]
Translations[edit]
|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[edit]
| 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[edit]
Normal[edit]
{{sourceheader
| 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 =
}}
| ←Chapter 2 | Alice's Adventures in Wonderland by Lewis Carroll Chapter 3: A Caucus-Race and a Long Tale |
Chapter 4→ |
No author link[edit]
{{sourceheader
| title = Peerage Act 1963
| author = |override_author= the United Kingdom Parliament
| section =
| previous =
| next =
| notes =
}}
| Peerage Act 1963 |
Translation[edit]
{{sourceheader
| title = Fables
| author = Jean de La Fontaine
| translator= Elizur Wright
| section =
| previous =
| next =
| notes =
}}
{{sourceheader
| title = Pantagruel
| author = François Rabelais
| translator= [[Author:Thomas Urquhart|]] and [[Author:Peter Antony Motteux|]]
| section =
| previous =
| next =
| notes =
}}
| Fables by Jean de La Fontaine , translated by Elizur Wright |
| Pantagruel by François Rabelais , translated by Thomas Urquhart and Peter Antony Motteux |
Advanced manipulation[edit]
JavaScript extraction[edit]
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 |
