Modulus:links/documentation

This module provides many useful utility functions for creating and processing wikilinks within Wiktionary. It is used by the linking templates {{m}} and {{l}} through the functions in Module:links/templates.

full_link

full_link(data, face, allowSelfLink, dontLinkRecons)

Creates a full link, with annotations (see format_link_annotations), in the style of {{l}} or {{m}}.

The first argument, data, must be a table. It contains the various elements that can be supplied as parameters to {{l}} or {{m}}:

{
	term = entry_to_link_to,
	alt = link_text_or_displayed_text,
	lang = language_object,
	sc = script_object,
	id = sense_id,
	genders = { "gender1", "gender2", ... },
	tr = transliteration,
	gloss = gloss,
	pos = part_of_speech_tag,
	lit = literal_translation,
	accel = accelerated_creation_tags,
	interwiki = interwiki,
}

Any one of the items in the data table may be nil, but an error will be shown if neither term nor alt nor tr is present.

Thus, calling full_link{ term = term, lang = lang, sc = sc }, where term is an entry name, lang is a language object from Module:languages, and sc is a script object from Module:scripts, will give a plain link similar to the one produced by the template {{l}}, and calling full_link( { term = term, lang = lang, sc = sc }, "term" ) will give a link similar to the one produced by the template {{m}}.

The function will:

• Try to determine the script, based on the characters found in the term or alt argument, if the script was not given.
• Call language_link on the term or alt forms, to remove diacritics in the page name, process any embedded wikilinks and create links to Reconstruction or Appendix pages when necessary.
• Call Module:script utilities#tag_text to add the appropriate language and script tags to the term, and to italicize terms written in the Latin script if necessary. Accelerated creation tags, as used by WT:ACCEL, are included.
• Generate a transliteration, based on the alt or term arguments, if the script is not Latin and no transliteration was provided.
• Add the annotations (transliteration, gender, gloss etc.) after the link.

format_link_annotations

format_link_annotations(lang, info)

Formats the annotations that are displayed with a link created by full_link. Annotations are the extra bits of information that are displayed following the linked term, and include things such as gender, transliteration, gloss and so on. The first argument is the language object, the second is a table possessing some or all of the following keys:

genders

Table containing a list of gender specifications in the style of Module:gender and number.

tr

Transliteration.

gloss

Gloss that translates the term in the link, or gives some other descriptive information.

pos

Part of speech of the linked term. If the given argument matches one of the templates in Category:Part of speech tags, then call that to show a part-of-speech tag. Otherwise, just show the given text as it is.

lit

Literal meaning of the term, if the usual meaning is figurative or idiomatic.

Any of the above values can be omitted from the info argument. If a completely empty table is given (with no annotations at all), then an empty string is returned.

language_link

language_link(data, allowSelfLink, dontLinkRecons)

Creates a basic link to the given term. It links to the language section (such as ==English==), but it does not add language and script wrappers, so any code that uses this function should call the tag_text from Module:script utilities to add such wrappers itself at some point.

The first argument, data, may contain the following items, a subset of the items used in the data argument of full_link. If any other items are included, they are ignored.

{
	term = entry_to_link_to,
	alt = link_text_or_displayed_text,
	lang = language_object,
	id = sense_id,
}

term

Text to turn into a link. This is generally the name of a page. The text can contain wikilinks already embedded in it. These are processed individually just like a single link would be. The alt argument is ignored in this case.

alt (optional)

The alternative display for the link, if different from the linked page. If this is nil, the text argument is used instead (much like regular wikilinks). If text contains wikilinks in it, this argument is ignored and has no effect. (Links in which the alt is ignored are tracked with the tracking template Formula:whatlinkshere.)

lang

The language object for the term being linked. If this argument is defined, the function will determine the language's canonical name (see Template:language data documentation), and point the link or links in the term to the language's section of an entry, or to a language-specific senseid if the id argument is defined.

id (optional)

Sense id string. If this argument is defined, the link will point to a language-specific sense id (Formula:ll) created by the template {{senseid}}. A sense id consists of the language's canonical name, a hyphen (-), and the string that was supplied as the id argument. This is useful when a term has more than one sense in a language. If the term argument contains wikilinks, this argument is ignored. (Links in which the sense id is ignored are tracked with the tracking template Formula:whatlinkshere.)

The second argument is as follows:

allowSelfLink

If true, the function will also generate links to the current page. The default (false) will not generate a link but generate a bolded "self link" instead.

The following special options are processed for each link (both simple text and with embedded wikilinks):

• The target page name will be processed to generate the correct entry name. This is done by the makeEntryName function in Module:languages, using the entry_name replacements in the language's data file (see Template:language data documentation for more information). This function is generally used to automatically strip dictionary-only diacritics that are not part of the normal written form of a language.
• If the text starts with *, then the term is considered a reconstructed term, and a link to the Reconstruction: namespace will be created. If the text contains embedded wikilinks, then * is automatically applied to each one individually, while preserving the displayed form of each link as it was given. This allows linking to phrases containing multiple reconstructed terms, while only showing the * once at the beginning.
• If the text starts with :, then the link is treated as "raw" and the above steps are skipped. This can be used in rare cases where the page name begins with * or if diacritics should not be stripped. For example:
  • {{l|en|*nix}} links to the nonexistent page Reconstruction:English/nix (* is interpreted as a reconstruction), but {{l|en|:*nix}} links to *nix.
  • {{l|sl|Franche-Comté}} links to the nonexistent page Franche-Comte (é is converted to e by makeEntryName), but {{l|sl|:Franche-Comté}} links to Franche-Comté.

remove_links

remove_links(text)

Replaces all wikilinks with their displayed text, and removes any categories. This function can be invoked either from a template or from another module.

• [[page|displayed text]] → displayed text
• [[page and displayed text]] → page and displayed text
• [[Category:English lemmas|WORD]] → (nothing)