Template:Verse translation/doc

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|lang=ISO 639 language code or IETF language tag|original text|translation|attr1=original text attribution|attr2=translation attribution|width=width of all contents}}

Full parameter set in horizontal format

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

Full parameter set in vertical format

{{Verse translation
 | lang = 
 | 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
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]

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

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 |lang=, which takes an IETF language tag or ISO 639 language code in the same format as {{lang}}. For example: Template:Markupv 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
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]

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
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]

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 |lang= 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)

Indentation

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

Markup	Renders as
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]

Markup	Renders as
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]

However, it looks markedly different on mobile, and lacks the semantics of <blockquote>.

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.

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.

—Gaius Julius Caesar, Commentarii de Bello Gallico 1.1 —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)	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. 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