Module:phi-headword/documentation

This module is used for Philippine-language headword-line templates. Currently it supports:
 * Bikol Central (see }: bcl-noun, bcl-proper noun, bcl-verb, bcl-adj, bcl-adv and bcl-head (for other parts of speech);
 * Cebuano (see }: ceb-noun, ceb-proper noun, ceb-verb, ceb-adj, ceb-adv, ceb-num (for numerals) and ceb-head (for other parts of speech);
 * Chavacano (see }: cbk-noun, cbk-proper noun, cbk-verb, cbk-adj, cbk-adv and cbk-head (for other parts of speech);
 * Hiligaynon (see }: hil-noun, hil-proper noun, hil-verb, hil-adj, hil-adv and hil-head (for other parts of speech);
 * Ilocano (see }: ilo-noun, ilo-proper noun, ilo-verb, ilo-adj, ilo-adv and ilo-head (for other parts of speech);
 * Kapampangan (see }: pam-noun, pam-proper noun, pam-verb, pam-adj, pam-adv and pam-head (for other parts of speech);
 * Kinaray-a (see }: krj-noun, krj-proper noun, krj-verb, krj-adj, krj-adv and krj-head (for other parts of speech);
 * Maguindanao (see }: mdh-noun, mdh-proper noun, mdh-verb, mdh-adj, mdh-adv and mdh-head (for other parts of speech);
 * Maranao (see }: mrw-noun, mrw-proper noun, mrw-verb, mrw-adj, mrw-adv and mrw-head (for other parts of speech);
 * Pangasinan (see }: pag-noun, pag-proper noun, pag-verb, pag-adj, pag-adv and pag-head (for other parts of speech);
 * Tagalog (see }: tl-noun, tl-proper noun, tl-verb, tl-adj, tl-adv, tl-num (for numerals), tl-prep (for prepositions), tl-pron (for pronouns) and tl-head (for other parts of speech);
 * Tausug (see }: tsg-noun, tsg-proper noun, tsg-verb, tsg-adj, tsg-adv and tsg-head (for other parts of speech);
 * Waray-Waray (see }: war-noun, war-proper noun, war-verb, war-adj, war-adv and war-head (for other parts of speech).

The rest of this documentation describes parameters from the point of view of Tagalog, but other languages work very similarly.

The module is always invoked the same way, by passing a single parameter to the "show" function. This parameter is the name of the part of speech, but in plural (examples given are for nouns, and for adjective forms respectively):

If the part of speech is omitted, the template being implemented must have the part of speech (in its singular form, e.g. ) specified in 1. This is used to support tl-head.

The template will, by default, accept the following parameters (specific parts of speech may accept or require others):


 * 1, head2, head3, ...
 * Override the headword display; used to add accents to the headword and/or links to individual words in a multiword term. Use the value  to explicitly request the default (which is the same as the page name). Note that it no longer works to specify a blank parameter to request the default; you must use  . Note also that if the invoking template is tl-head, parameter 1 is instead the part of speech (in its singular form, e.g.  ), and 2 is the first explicit headword.


 * b, b2, b3, ...
 * Specify the corresponding Baybayin-script or other native-script spelling of a Latin-script term, for languages that support native scripts: Basahan for Bikol Central, Badlit for Cebuano, Kur-itan for Ilocano and Baybayin for Tagalog. The value can be either the actual Baybayin/etc. spelling or the Latin-script equivalent. The value  is equivalent to specifying the page name.


 * j, j2, j3, ...
 * Specify the corresponding Arabic-script spelling of a Latin-script term, for languages that support Arabic scripts (Maguindanao, where it goes by the name of Jawi, and Maranao, where it goes by the name of batang Arab). Currently the value must be the Arabic script spelling; unlike for native scripts, the Latin-script equivalent cannot be given.


 * tr, tr2, tr3, ...
 * Override the default transliteration, if the page name is in the Baybayin script (or other native script) or Arabic script, rather than the Latin script. tr corresponds to 1, tr2 to head2, tr3 to head3, etc. Rarely necessary.


 * id
 * Sense ID for linking to this headword. See senseid for more information.


 * 1 or 1
 * Don't link individual words in the headword of a multiword term. Useful for foreign or otherwise unanalyzable terms, where the expression functions as a whole in Tagalog but the individual parts are not Tagalog words.


 * 1
 * Indicate that a term is a suffix even if it doesn't begin with a hyphen. Useful for Baybayin-script suffixes. See below.


 * 1
 * Prevent terms beginning with a hyphen from being interpreted as suffixes. See below.


 * addlpos
 * Comma-separated list of additional parts of speech that suffix can form. See below.


 * pagename
 * Override the page name used to compute default values of various sorts. Useful when testing, for documentation pages, etc.

Suffix handling
If the term begins with a hyphen, it is assumed to be a suffix rather than a base form, and is categorized into Category:Tagalog suffixes and Category:Tagalog POS-forming suffixes rather than Category:Tagalog POSs (e.g. Category:Tagalog noun-forming suffixes rather than Category:Tagalog nouns). This behavior can also be obtained for terms not beginning with a hyphen using 1, and can be prevented using 1. If the suffix can form multiple parts of speech and it is not desirable to use separate headers for these (e.g. for alternative forms), use addlpos to specify the additional parts of speech (comma-separated).