Module:RQ:pi:Sai Kam Mong/documentation

Invoking this module as quote is equivalent to invoking a template as, for some yyy, so please read that template for usage. If the argument passages is omitted, the effect is equivalent to invoking the template as a.

The templates and modules for the use of this come in sets of three - a citation selection template, a data module, and a display template.

The citation selection template simply invokes this module's function quote; module invocations are not allowed in the main space pages, but must be wrapped in a template. This function accesses and manipulates the data in the data module, while the display template can function independently of it and the the data.

Wiktionary requests that each template and module have a documentation page. For the first two, boilerplate templates and  provide most of this documentation. The boilerplate templates require that name of the citation slection template be the name of the data module augmented by the word 'quote'. The display template's documentation is less stereotyped, and adaptation of one set's to a new set's must be done manually. Adapting the example looks daunting, but is not as difficult as it looks. The trick is to start from the bottom and work up.

Existing sets include:

If creating a new set, the 'Sai Kam Mong' set would be a bad set to start from, as for historical reasons, it has different and confusing naming conventions. Some of these issues are worked round by the defaults in the documentation templates.