Template:RQ:pi:Sai Kam Mong/passage boilerplate

The following documentation is located at Template:RQ:pi:Sai Kam Mong/passage boilerplate/documentation. ^[edit]

Useful links: root page • root page’s subpages • links • redirects • transclusions • errors (parser/module) • sandbox

Purpose

This template provides boilerplate for the documentation of data modules interpreted by Module:RQ:pi:Sai Kam Mong. It provides a specimen quotation.

Parameters

|1= (optional): The language of the quotations - the name, not the code, and may be a list. Defaults to Pali.
|2= (optional): The name of the reference template
|3= (optional): The page number of the specimen quotation.
|4= (optional): The name of the passage for the specimen quotation within its page.
|5= (optional): The ID number of the highlit word within its passage.

The following parameters depend on the reference template defined in the data, but record whether certain fields can be usefully included in the data.

|nlt=1 (optional): Whether the three fields norm, lit and ts are supported.
|lang=1 (optional): Specify this to record that the lang field in the data will be interpreted as the language of the quotation. Omit or leave blank if not used.
|p1= (optional): Meaning of the field p1 in the data. Omit or leave blank if the field is not used.
|p2= (optional): Meaning of the field p2 in the data. Omit or leave blank if the field is not used.

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:Sai Kam Mong}}) 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:Sai Kam Mong quote|241|namo|3}}; this example produces the text:

2004, Sai Kam Mong, The History and Development of the Shan Scripts, Chiang Mai, Thailand: Silkworm Books, →ISBN, →OCLC, page 241:

ᨶᨾᩮᩣᨲᩔ ᨽᨣᩅᨲᩮᩣ ᩋᩁᩉᨲᩮᩣ ᩈᨾᩜᩣᩈᨾ᩠ᨻᩩᨴ᩠ᨵᩔ

namotassa bhagavato arahato sammāsambuddhassa

Honour to the Blessed One, the Exalted One, the fully Enlightened One

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