Module:RQ:pi:Sinhala Dhammapada/documentation

This module is a data module providing a catalogue of passages from one particular book or article for each passage to demonstrate the existence of multiple Pali words. The modules returns a 3-D array (technically a Lua table), indexed as follows:

1. The outer index is the page number.
2. The second index is a character string serving as the name of the passage within the page - using the first word is the simplest scheme.
3. The third index is an element number - the text (item 1), its transliteration (item 2) (optional) and its translation (item 3). There are three optional items - normalisation, which corrects significant aberrant spelling or significant grammatical errors in the quoted text (item norm), literal translation (item lit), and normalisation of the transliteration (item ts) to bring it into line with Roman script Pali. The changed text is delimited by ⧁⧀ pairs so that it may be flexibly highlighted, and the effects should cascade from normalisation to transliteration to normalised transliteration.

The table has one named element, "reference", that holds the name of the template (namely, {{RQ:pi:Sinhala Dhammapada}}) used to identify the source to the reader and format the quote, its transliteration and its translation. The table structure allows fields lang, p1 and p2 for uninterpreted passage to the reference template to customise its output. This particular module's table uses lang as the language code of the quoted passage andp1 as the Pali name of the section, e.g. Yamakavagga. The field applied to the innermost of the passage, page and table is the value passed on.

The intention is that the word will be highlighted when selected by these three indices. Words are assigned positive numbers and their boundaries are marked up in the form {number-word}. This mark up can be nested, so that words may contain other words. Different sections may have the same number; this allows for repeated words, overlapping words, and discontiguous translations.

The words are transcluded into a page using an invocation of the form {{RQ:pi:Sinhala Dhammapada quote|26|akkocchi4|13}}; this example produces the text:

c. 50 BC, The Buddha, Dhammapada(pāḷi), Yamakavagga, page 26; republished in The Eighteenth Book in the Suttanta-Pitaka: Khuddaka-Nikāya‎^[1], Colombo, 2009:

4. අක‍්කොච‍්ඡි මං අවධි මං අජිනි මං අහාසි මෙ 4
යෙ තං න උපනය‍්හන‍්ති වෙරං තෙසූපසම‍්මති.

4. Akkocchi maṃ avadhi maṃ ajini maṃ ahāsi me 4
Ye taṃ na upanayhanti veraṃ tesūpasammati.

He abused me, he struck me, he defeated me, he robbed me.
Hatred subsides in those who do not nurse grudges thus.

(Wiktionary translation adapted from translation of the Pali by Ajahn Sujato.)

There is no advantage in including a passage for the sake of one word; one can use {{RQ:pi:Sinhala Dhammapada}} directly for that purpose.