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:

Full parameter set in horizontal format

Full parameter set in vertical format

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

While 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 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 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 wrap automatically; if wrapping is required,  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 in the same format as. For example:

Notice that the  markup is added  the attribution parameters.

Italic override
If italicsoff is set to 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:

Right-to-left text
If rtl1 is set to 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:

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 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 and poem in the following examples:

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

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

TemplateData
{	"description": "Use this template to provide a side-by-side translation of a text", "params": { "1": {			"label": "Original text", "type": "unknown", "autovalue": "", "required": true },		"2": {			"label": "Translation", "type": "unknown", "autovalue": "", "required": true },		"head1": { "label": "Header or title for the original text" },		"head2": { "label": "Header or title for the translation" },		"italicsoff": { "label": "Italics (original text)", "description": "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" },		"italicsoff2": { "label": "Italics (translation)", "description": "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" },		"rtl1": { "label": "Right-to-left (original text)", "description": "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" },		"rtl2": { "label": "Right-to-left (translation)", "description": "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" },		"lang1": { "label": "Language code (original text)", "description": "ISO 639 language code or IETF language tag for the first column of text.", "example": "fr", "aliases": [ "lang" ]		},		"lang2": { "label": "Language code (translation)", "description": "ISO 639 language code or IETF language tag for the second column of text.", "example": "it" },		"attr1": { "label": "Attribution (original text)", "description": "Attribution(s) for the original text", "example": "Rene Descartes (1644), Principles of Philosophy" },		"attr2": { "label": "Attribution (translation)", "description": "Attribution(s) for the translation", "example": "John Smith (1959)" },		"width": { "label": "Width (all texts)", "description": "Limit the width of the template enclosing entire content.", "example": "100%" }	},	"paramOrder": [ "1",		"2",		"head1", "head2", "lang1", "italicsoff", "rtl1", "attr1", "lang2", "italicsoff2", "rtl2", "attr2", "width" ] }