Module:RQ:pi:Thai chant book/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:
- The outer index is the page number.
- 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.
- The third index is an element number - the text (item 1), its transliteration (item 2) (optional) and its translation (item 3).
The table has one named element, "reference", that holds the name of the template (namely, {{RQ:pi:Thai chant book}}) used to identify the source to the reader and format the quote, its transliteration and its translation.
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:Thai chant book quote|4|buddham|2}}; this example produces the text:
- พุทธัง สะระณัง คัจฉามิ ธัมมัง สะระณัง คัจฉามิ สังฆัง สะระณัง คัจฉามิ
- buddhaṃ saraṇaṃ gacchāmi. dhammaṃ saraṇaṃ gacchāmi. saṅghaṃ saraṇaṃ gacchāmi.
- I go to the Buddha as a refuge. I go to the dharma as a refuge. I go to the sangha as a refuge.
There is no advantage in including a passage for the sake of one word; one can use {{RQ:pi:Thai chant book}} directly for that purpose.