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. 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 from this minimal example, the lang parameter should be specified in normal use.

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 ) is lang, which takes an or  language code in the same format as lang. 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 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 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.

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

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" },		"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" },		"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" },		"lang": { "label": "Language code (original text)", "description": "ISO 639 language code or IETF language tag for the first column of text.", "example": "fr" },		"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)" }	},	"paramOrder": [ "1",		"2",		"lang", "italicsoff", "rtl1", "attr1", "attr2" ] }