Module:fr-headword/documentation

This module is used for French headword-line templates. This module currently implements, , , , , and several others; see the documentation of those templates for more information.

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):

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


 * head
 * Override the headword display, used to add links to individual words in a multiword term.


 * 1
 * Don't link individual words in the headword of a multiword term. Useful for foreign terms like and  where the expression functions as a whole in French but the individual parts are not French words.


 * 1
 * Indicate that automatic splitting and linking of words should split on hyphens in multiword expressions with spaces in them (splitting on hyphens is automatic if there are no spaces in the term).


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

There is no parameter for the sort key, because this is not necessary. The sort key is automatically generated according to the normal alphabetical ordering in French.

Autosplitting
All templates using this module use an intelligent autosplitting algorithm to link portions of multipart and multiword expressions, as follows:
 * The module will automatically split and link distinct space-separated words, similarly to ; hence, will be linked as.
 * It also splits on apostrophes in the middle of words and includes the apostrophe in the preceding portion. Hence, will be linked as  . (An exception is made for three words,,  and , which will not be split if they occur as part of larger expressions.)
 * In addition, parts of hyphenated compounds in single-word expressions will be linked individually, e.g. will be linked as  . Hyphenated compound words will not be split if they occur in multiword expressions unless 1 is specified, since the compound itself might be a valid word.

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:French suffixes and Category:French POS-forming suffixes rather than Category:French POSs (e.g. Category:French noun-forming suffixes rather than Category:French nouns).