Template:Verse translation/doc

__EXPECTED_UNCONNECTED_PAGE__

Usage

This template may be used when a verse text in its original language and its translation into English are to be displayed together. It displays the original text in italics and the translation in roman type. Optionally, it displays attributions for each text below. The main parameter set is the following:

{{Verse translation|lang1=ISO 639 language code or IETF language tag|original text|translation|attr1=original text attribution|attr2=translation attribution|width=width of all contents}}

Further information: List of ISO 639-1 codes and List of ISO 639-2 codes

Full parameter set in horizontal format

{{Verse translation|lang1=|rtl1=|italicsoff=|head1=|<!--original text-->|attr1=|lang2=|rtl2=|italicsoff2=|head2=|<!--translation-->|attr2=}}

Full parameter set in vertical format

{{Verse translation
 | lang1 = 
 | rtl1 = 
 | italicsoff = 
 | head1 =
 | <!--original text-->
 | attr1 = 
 | lang2 = 
 | rtl2 = 
 | italicsoff2 = 
 | head2 =
 | <!--translation-->
 | attr2 = 
}}

Examples

Basic example

The first two parameters are required, unlabelled, and hold the two texts. For example:

Markup	Renders as
{{Verse translation |head1=German|lang1=de |Sprechen Sie Deutsch? Ich benötige Hilfe. |head2=English|3= |Do you speak German? I require assistance.}}	German Sprechen Sie Deutsch? Ich benötige Hilfe. Translation: English Do you speak German? I require assistance.

While |lang1=de is omitted in minimal examples, the |lang1= parameter should be specified in normal use for any language other than English.

|lang1= can also be specified as the alias |lang=, though the other numbered parameters do not have such aliases, and the inconsistency will not be helpful for later editors.

Line breaks in the code texts are preserved in the display. Extra markup like <br /> is not required, but will also be displayed if included. As shown below, correctly formatted inline references can also be added to both texts.

Full example

The parameters |attr1= and |attr2= are optional, must be labelled, and do not preserve line breaks in the code. They are meant to contain the attributions for (1) the original text and (2) the translation. Either, both, or neither may be used. Their content will be displayed preceded by a dash and in slightly reduced text. These texts do not wrap automatically; if wrapping is required, <br /> can be used, as below. Also optional (though recommended by Manual of Style/Accessibility § Other languages) is |lang1=, which takes an IETF language tag or ISO 639 language code. For example:

Markup

{{Verse translation|lang1=es| ¿Qué es la vida? — Una ilusión, Una sombra, una ficción, Y el mayor bien es pequeño; Que toda la vida es sueño, Y los sueños sueño son.<ref>{{cite book|title=La vida es sueño|last=Calderón de la Barca|first=Pedro|author-link=Pedro Calderón de la Barca|editor-last=Comfort|editor-first=William Wistar|location=New York|publisher=American Book Company|date=1904|page=104|url=https://archive.org/details/lavidaessueo00comfgoog}}</ref> |What is life? A thing that seems, A mirage that falsely gleams, Phantom joy, delusive rest, Since is life a dream at best, And even dreams themselves are dreams.<ref>''Calderon's Dramas'', pp. 78–79. London: Henry S. King & Co., 1873.</ref> |attr1=[[Pedro Calderón de la Barca|Calderón]]: ''{{lang|es|[[La vida es sueño]]}}''<br />Act II, Scene 19, lines 1197–1201 |attr2=[[Denis Florence Mac-Carthy]] }} {{Reflist}}

Renders as

¿Qué es la vida? — Una ilusión, Una sombra, una ficción, Y el mayor bien es pequeño; Que toda la vida es sueño, Y los sueños sueño son. — Calderón: La vida es sueño Act II, Scene 19, lines 1197–1201 Translation: What is life? A thing that seems, A mirage that falsely gleams, Phantom joy, delusive rest, Since is life a dream at best, And even dreams themselves are dreams. — Denis Florence Mac-Carthy

Notice that the <ref>...</ref> markup is added before the attribution parameters.

Italic override

If |italicsoff= is set to any value, the first column's italics are turned off. This is useful for original texts in non-Latin scripts, for which italics may be neither useful nor appropriate:

Markup	Renders as
{{Verse translation|lang1=ka|italicsoff=y| მელნად ვიხმარე გიშრის ტბა და კალმად მე ნა რხეული, ვინცა ისმინოს, დაესვას ლახვარი გულსა ხეული. |attr1=[[Shota Rustaveli]]: from ''[[The Knight in the Panther's Skin]]'' |For ink I have used a lake of jet, and for pen a pliant crystal. Whoever hears, a jagged spear will pierce his heart.}}	მელნად ვიხმარე გიშრის ტბა და კალმად მე ნა რხეული, ვინცა ისმინოს, დაესვას ლახვარი გულსა ხეული. — Shota Rustaveli: from The Knight in the Panther's Skin Translation: For ink I have used a lake of jet, and for pen a pliant crystal. Whoever hears, a jagged spear will pierce his heart.

Right-to-left text

If |rtl1= is set to any value, the first column's text is aligned right. This is useful for original texts in right-to-left languages like Arabic, as exemplified below:

Markup	Renders as
{{Verse translation|lang1=ar|italicsoff=y|rtl1=y| خل الذنوب صغيرهاو كبيرها ذاك التقى و اصنع كماش فوق أرض الشوك يحذر ما يرى لا تحقرن صغيرةً إن الجبال من الحصى |Abandon sins, big and small – that is Tawqa And be like the one who walks on a thorny path, he is cautious of what he sees Do not belittle the small sins; truly mountains are made from pebbles}}	خل الذنوب صغيرهاو كبيرها ذاك التقى و اصنع كماش فوق أرض الشوك يحذر ما يرى لا تحقرن صغيرةً إن الجبال من الحصى Translation: Abandon sins, big and small – that is Tawqa And be like the one who walks on a thorny path, he is cautious of what he sees Do not belittle the small sins; truly mountains are made from pebbles

Tips

Special characters

As with many other templates, if the characters = or | appear in the verse texts, they will break the template's display. The easiest solution is to replace them with {{=}} or {{!}} respectively.

Language markup

The |lang1= parameter covers the first block of text in this template. It is good practice to enclose any other non-English text—such as in |attr1=—in the {{lang}} template, as in the full example above.

The |lang2= parameter is similar but covers the second block of text (it may be translated in another language than English); defaults to |lang2=en if not specified.

Indentation

The indentation provided automatically in this template is approximately equal to <blockquote> and <poem> in the following examples:

Markup	Renders as
Text. <blockquote>Indented text.</blockquote> More text.	Text. Quoted text. More text.

Markup	Renders as
Text. <poem style="margin-left: 3em; font-style:italic">Indented text.</poem> More text.	Text. Indented text. More text.

However, it looks markedly different on mobile.

Prose

Although optimized for verse, the template works equally well for prose. For example:

Gallia est omnis divisa in partes tres, quarum unam incolunt Belgae, aliam Aquitani, tertiam qui ipsorum lingua Celtae, nostra Galli appellantur. Hi omnes lingua, institutis, legibus inter se differunt. Gallos ab Aquitanis Garumna flumen, a Belgis Matrona et Sequana dividit. Horum omnium fortissimi sunt Belgae, propterea quod a cultu atque humanitate provinciae longissime absunt, minimeque ad eos mercatores saepe commeant atque ea quae ad effeminandos animos pertinent important, proximique sunt Germanis, qui trans Rhenum incolunt, quibuscum continenter bellum gerunt. Qua de causa Helvetii quoque reliquos Gallos virtute praecedunt, quod fere cotidianis proeliis cum Germanis contendunt, cum aut suis finibus eos prohibent aut ipsi in eorum finibus bellum gerunt.

— Gaius Julius Caesar, Commentarii de Bello Gallico 1.1

Translation:

All Gaul is divided into three parts, one of which the Belgae inhabit, the Aquitani another, those who in their own language are called Celts, in our Gauls, the third. All these differ from each other in language, customs and laws. The river Garonne separates the Gauls from the Aquitani; the Marne and the Seine separate them from the Belgae. Of all these, the Belgae are the bravest, because they are furthest from the civilization and refinement of [our] Province, and merchants least frequently resort to them, and import those things which tend to effeminate the mind; and they are the nearest to the Germans, who dwell beyond the Rhine, with whom they are continually waging war; for which reason the Helvetii also surpass the rest of the Gauls in valor, as they contend with the Germans in almost daily battles, when they either repel them from their own territories, or themselves wage war on their frontiers.

— translated by W.A. McDevitte and W.S. Bohn

TemplateData

Use this template to provide a side-by-side translation of a text

Template parameters

Parameter		Description	Type	Status
Original text	1	no description Auto value	Unknown	required
Translation	2	no description Auto value	Unknown	required
Header or title for the original text	head1	no description	Unknown	optional
Header or title for the translation	head2	no description	Unknown	optional
Language code (original text)	lang1 lang	ISO 639 language code or IETF language tag for the first column of text. Example fr	Unknown	optional
Italics (original text)	italicsoff	If set to any value, the first column's italics are turned off. This is useful for original texts in non-Latin scripts, for which italics may be neither useful nor appropriate. Example y	Unknown	optional
Right-to-left (original text)	rtl1	If set to any value, the first column's text is aligned right. This is useful for original texts in right-to-left languages like Arabic. Example y	Unknown	optional
Attribution (original text)	attr1	Attribution(s) for the original text Example Rene Descartes (1644), ''Principles of Philosophy''	Unknown	optional
Language code (translation)	lang2	ISO 639 language code or IETF language tag for the second column of text; defaults to English. Example it	Unknown	optional
Italics (translation)	italicsoff2	If set to any value, the second column's italics are turned off. This is useful for original texts in non-Latin scripts, for which italics may be neither useful nor appropriate. Example y	Unknown	optional
Right-to-left (translation)	rtl2	If set to any value, the second column's text is aligned right. This is useful for original texts in right-to-left languages like Pashto. Example y	Unknown	optional
Attribution (translation)	attr2	Attribution(s) for the translation Example John Smith (1959)	Unknown	optional
Width (all texts)	width	Limit the width of the template enclosing entire content. Example 100%	Unknown	optional

See also

Template:Verse translation invokes Module:Navbox using Lua.

Usage

This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.

The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.

Syntax

{{navbox
|state      = uncollapsed, collapsed, plain, autocollapse (default)
|name       = mandatory - name of the template
|style      = optional - style for the whole table
|title      = mandatory - navbox header
|gtitleN    = optional - title of N-th group of items
|styleN     = optional - style for groupN; i.e. text-align
|groupN     = mandatory - list of groups of items
|fstyle     = optional - style for footer ; i.e. text-align
|footer     = optional - navbox footer
}}

• Groups: Currently there is no technical limit to the maximum number of groups.
  • Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
• Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
• Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
  • Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
• Line breaks: Line-breaks (<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN.
• Bullets: Create unordered lists with lines beginning with *.
• Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! ({{!}}).

States

• Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
  • Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
• Uncollapsed: Forces the navbox to be displayed.
  • All of the navboxes in this documentation are in the uncollapsed state.
• Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
  • Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
• Plain: Removes the "show/hide" link.

Sub-groups

• For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
• To create sub-groups within {{navbox}}, certain parameters are to be included:
  • The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
  • The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.

{{navbox
|name    =
|title   =
|gtitle1 =
|group1  =
|gtitle2 =  
|gtype2  = Subgroup (mandatory)
|group2  = 
  {{navbox
  |subgroup = yes (mandatory)
  |gtitle1  = 
  |group1   =
  |gtitle2  = 
  |group2   = 
  }}
}}

Collapsible sub-groups

• For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
• To create collapsible sub-groups within {{navbox}}, these parameters need to be included:
  • The parent navbox is almost always uncollapsed (state=uncollapsed).
  • The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
  • The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
  • The nested collapsible navbox is forcefully collapsed (state=collapsed).

{{navbox
|state  = uncollapsed
|name   = 
|gtype1 = Subgroup
|group1 = 
  {{navbox
  |collapsible = yes
  |state   = collapsed
  |title   = 
  |gtitle1 = 
  |group1  = 
  |gtitle2 = 
  |group2  = 
  }}
}}

Use of images

• The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
• Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.

Link and file share the same name

{{plink|Item}}

File name differs from the link

{{plink|Item|File}}

Link and file share the same name, but different text is desired to display

{{plink|Item|alt=Text}}

File name differs from the link and different text is desired to display

{{plink|Item|File|alt=Text}}

Categorising

Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.

There are 2 methods of categorising pages with navboxes:

The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.

Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.

Examples

To see the following navboxes in action, see Template:Navbox.

Single line navbox with centered list

{{navbox
|name    = 
|title   = 
|style1  = text-align:center
|group1  =
}}

Navbox with standard footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|footer  = Centered footer
}}

Navbox with styled footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|fstyle  = text-align:right
|footer  = Right-aligned footer
}}

Multiple line navbox

{{navbox
|name    = 
|title   = 
|gtitle1 = Group title 1
|group1  = 
|gtitle2 = Group title 2
|group2  = 
|gtitle3 = Group title 3
|group3  = 
}}

Collapsed navbox

{{navbox
|state   = collapsed
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox with Tnavbar

{{navbox
|state   = plain
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox without Tnavbar

{{navbox
|state   = plain
|title   = 
|style1  = text-align:center
|group1  = 
}}

Complicated navbox

{{navbox
|state   = uncollapsed
|name    = 
|title   = 
|gtitle1 = Level 1 Title 1
|group1  = 
|gtitle2 = Level 1 Title 2
|group2  = 
|gtitle3 = Level 1 Title 3
|group3  = 
|gtitle4 = Level 1 Title 4
|group4  = 
|gtitle5 = Level 1 Title 5
|gtype5  = Subgroup
|group5  = 
  {{navbox
  |subgroup = Yes
  |gtitle1  = Level 2 Title 1
  |group1   =
  |gtitle2  = Level 2 Title 2
  |group2   =
  |gtitle3  = Level 2 Title 3
  |gtype3   = Subgroup
  |group3   = 
    {{navbox
    |subgroup = Yes
    |gtitle1  = Level 3 Title 1
    |group1   =
    |gtitle2  = Level 3 Title 2
    |group2   =
    }}
  |gtitle4  = Level 2 Title 4
  |group4   = 
  }}
|gtitle6 = Level 1 Title 6
|group6  = 
|gtitle7 = Level 1 Title 7
|group7  = 
|fstyle  = 
|footer  = 
}}

Preventing unwanted documentation

The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).

Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.