Cithakan:Verse Translation/doc

This is a documentation subpage for Cithakan:Verse Translation.
It contains usage information, categories and other content that is not part of the original cithakan page.

Cithakan iki nggunakake TemplateStyles:

Cithakan:Verse Translation/styles.css

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}}

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: Cithakan:Markup 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: Cithakan: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: Cithakan:Markup

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: Cithakan:Markup

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 Cithakan:Xtag in the following examples: Cithakan:Markup Cithakan:Markup

However, it looks markedly different on mobile.

Prose

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

TemplateData

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

Paramèter cithakan
Paramèter		Wedharan	Jinis	Status
Original text	`1`	tanpa wedharan Aji otomatis	Ora kaweruhan	butuh
Translation	`2`	tanpa wedharan Aji otomatis	Ora kaweruhan	butuh
Header or title for the original text	`head1`	tanpa wedharan	Ora kaweruhan	manasuka
Header or title for the translation	`head2`	tanpa wedharan	Ora kaweruhan	manasuka
Language code (original text)	`lang1` `lang`	ISO 639 language code or IETF language tag for the first column of text. Conto fr	Ora kaweruhan	manasuka
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. Conto y	Ora kaweruhan	manasuka
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. Conto y	Ora kaweruhan	manasuka
Attribution (original text)	`attr1`	Attribution(s) for the original text Conto Rene Descartes (1644), ''Principles of Philosophy''	Ora kaweruhan	manasuka
Language code (translation)	`lang2`	ISO 639 language code or IETF language tag for the second column of text; defaults to English. Conto it	Ora kaweruhan	manasuka
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. Conto y	Ora kaweruhan	manasuka
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. Conto y	Ora kaweruhan	manasuka
Attribution (translation)	`attr2`	Attribution(s) for the translation Conto John Smith (1959)	Ora kaweruhan	manasuka
Width (all texts)	`width`	Limit the width of the template enclosing entire content. Conto 100%	Ora kaweruhan	manasuka