Module:Term/Documentation

This is the main module for the following templates:

• Template:Plural
• Template:Term
• Template:Term/Store

In addition, this module exports the following functions.

FetchTerm

{{#invoke:Term|FetchTerm|page=|game=|plural=}}

Used by Template:Translation/Store to get the raw term without the extra output from Template:Term.

Parameters

Parameter	Status
page	required
game	optional
plural	optional

Examples

#	Input	Output
1	{{#invoke:Term|FetchTerm|page= 2nd Potion|game= Series}}	Red Water of Life
2	{{#invoke:Term|FetchTerm|page= not a page}}

link

link(page, game, options)

Shorthand for printTerm(page, game, { link = true })

Returns

• A link to a term page.

Examples

#	Input	Output	Result	Status
3	link("Bubble", nil, nil)	"[[Bubble|Bubble]]"	Bubble

plural

plural(page, game, options)

Shorthand for printTerm(page, game, { plural = true })

Returns

• A term in plural form.

Examples

#	Input	Output	Result	Status
4	plural("Bubble", nil, nil)	'<span class="term">Bubbles</span>'	Bubbles

pluralLink

pluralLink(page, game, options)

Shorthand for printTerm(page, game, { plural = true, link = true })

Returns

• A plural link to a term page.

Examples

#	Input	Output	Result	Status
5	pluralLink("Bubble", nil, nil)	"[[Bubble|Bubbles]]"	Bubbles

printTerm

printTerm(page, [game], [options])

Parameters

• page

  The name of a wiki article from which to retrieve a term.

• [game="Series"]

  A game code. See Data:Franchise.

• [options]

  [plural]

  If true, the term's plural form is returned.

  [allowSingular]

  If true, no error is returned when plural is true but only a singular term exists. See Module:Wares for example usage.

  [link]

  If truthy, the output will link to the page on which the term is stored.

  [section]

  The section to link to when link is enabled. Defaults to the name of game's base game.

  [display]

  Text to display instead of the term when link is enabled.

Returns

• A term with formatting.

Examples

#	Input	Output	Result	Status
6	printTerm("Dynalfos", "OoT")	'<span class="term">Dinolfos</span>'	Dinolfos
7	printTerm("Kara Kara Bazaar", "BotW", { link = true })	"[[Kara Kara Bazaar#Breath of the Wild|Kara Kara Bazaar]]"	Kara Kara Bazaar
8	printTerm( "Kara Kara Bazaar", "BotW", { section = "Shaillu's General Store", link = true, } )	"[[Kara Kara Bazaar#Shaillu's General Store|Kara Kara Bazaar]]"	Kara Kara Bazaar
9	printTerm( "Kara Kara Bazaar", "BotW", { display = "General Store", section = "Shaillu's General Store", link = true, } )	"[[Kara Kara Bazaar#Shaillu's General Store|General Store]]"	General Store
10	printTerm("invalid term")	'<span class="term--invalid"><span title="Invalid or missing term" class="tooltip">[[invalid term]]</span></span>[[Category:Articles with invalid or missing terms]][[Category:The Legend of Zelda Series articles with invalid or missing terms]]'	invalid term
Checks for redundant display arguments.
11	printTerm("Link", "Series", { display = "Link" })	'<span class="term">Link</span>[[Category:Terms with redundant display arguments]]'	Link

fetchTerm

fetchTerm(page, [game], [options])

Parameters

• page

  The name of a wiki article from which to retrieve a term.

• [game="Series"]

  A game code. See Data:Franchise.

• [options]

  [plural]

  If true, the term's plural form is returned.

  [allowSingular]

  If true, no error is returned when plural is true but only a singular term exists. See Module:Wares for example usage.

Returns

• The term for the given article and game, or nil if none found.
• An error category if no term was found.

Examples

#	Input	Output	Status
12	fetchTerm("Dynalfos", "OoT")	"Dinolfos"
		nil
Defaults to series term.
13	fetchTerm("Dinolfos")	"Dynalfos"
		nil
Defaults to series term when term does not exist for specified game (nor its base game).
14	fetchTerm("Flying Tile", "TPHD")	"Flying Tile"
		nil
Error when page does store any terms (game specified).
15	fetchTerm("Flippityfloppito", "SS")	nil
		{ "Articles with invalid or missing terms", "Skyward Sword articles with invalid or missing terms", }
Error when page does store any terms (no game specified).
16	fetchTerm("Flippityfloppityfloo")	nil
		{ "Articles with invalid or missing terms", "The Legend of Zelda Series articles with invalid or missing terms", }
Error when page has wrong casing
17	fetchTerm("captain's hat")	nil
		{ "Articles with invalid or missing terms", "The Legend of Zelda Series articles with invalid or missing terms", }
Plural
18	fetchTerm("Bubble", "Series", { plural = true })	"Bubbles"
		nil
Returns singular when no plural form exists.
19	fetchTerm("A Brother's Roast", "BotW", { plural = true })	"A Brother's Roast"
		{ "Articles with invalid or missing terms", "Breath of the Wild articles with invalid or missing terms", }
Returns singular when no plural form exists.
20	fetchTerm( "Hestu", "HWAoC", { plural = true, allowSingular = true, } )	"Hestu"
		nil

fetchSubjects

fetchSubjects(term, [game])

See Module:Translation Page for usage.

Parameters

• term

• [game]

Returns

• Returns the names of wiki articles that store the given term. If game is specified, the function will only return articles that store the term for that game.

Examples

#	Input	Output	Result
21	fetchSubjects("Wood")	{"Wood", "Wood (Character)"}
22	fetchSubjects("Wood", "ST")	{"Wood (Character)"}
23	fetchSubjects("Link", "MM")	{ "Link", "Link (Goron)", "Mr. No Fairy", "Professor Link", }
24	fetchSubjects("Fooloo Limpah")	{}