Module:RQ:pi:Gyapan/documentation

This module is a data module providing an example for the usage of multiple Pali words in a sentence written in the Mon style. The modules returns a 3-D array (technically a Lua table), indexed as follows:
 * 1) The outer index is the page number (necessarily 1 in this case).
 * 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) and its translation (item 3).

The table has one named element, "reference", that holds the name of the template (namely, RQ:pi:Gyapan 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 overlapping words or discontiguous translations.

The words are transcluded into a page using an invocation of the form 1; this example produces the text:

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