Module:Franchise/Documentation

Lua interface for Data:Franchise.

This is the main module for the following templates:

• Template:Franchise/Store Book
• Template:Franchise/Store Game
• Template:Franchise/Store Group
• Template:Franchise/Store Nonfiction
• Template:Franchise/Store TV

In addition, this module exports the following functions.

Template functions

Article

{{#invoke:Franchise|Article|<game>|nowarn=}}

Parameters

Parameter		Status	Description
1	game	required	The code for a game or other entry in Data:Franchise.
nowarn		optional	If present, the template will not issue an editor warning when game is invalid. Use this when a template needs custom error handling (see examples). However, an editor warning will still be issued if a game code is written with incorrect casing (e.g. oot instead of OoT)

Examples

#	Input	Result	Categories added
1	{{#invoke:Franchise|Article|OoT}}	The Legend of Zelda: Ocarina of Time
2	{{#invoke:Franchise|Article|OoT (Himekawa)}}	The Legend of Zelda: Ocarina of Time (Himekawa)
Error handling
3	{{#invoke:Franchise|Article|oot}}	The Legend of Zelda: Ocarina of Time	Category:Articles Using Invalid Arguments in Template Calls
4	{{#invoke:Franchise|Article|notAGame}}		Category:Articles Using Invalid Arguments in Template Calls
5	{{#invoke:Franchise|Article|}}		Category:Articles Using Invalid Arguments in Template Calls
6	{{#iferror:{{#invoke:Franchise|Article|invalid game}}|custom error handling}}	custom error handling

BaseGame

{{#invoke:Franchise|BaseGame|<game>|nowarn=}}

Parameters

Parameter		Status	Description
1	game	required	The code for a game entry in Data:Franchise.
nowarn		optional	If present, the template will not issue an editor warning when game is invalid. Use this when a template needs custom error handling (see examples). However, an editor warning will still be issued if a game code is written with incorrect casing (e.g. oot instead of OoT)

Examples

#	Input	Result	Categories added
7	{{#invoke:Franchise|BaseGame|TWW}}		Category:Articles Using Invalid Arguments in Template Calls
8	{{#invoke:Franchise|BaseGame|TWWHD}}	TWW
Error handling
9	{{#invoke:Franchise|BaseGame|notAGame}}		Category:Articles Using Invalid Arguments in Template Calls
10	{{#invoke:Franchise|BaseGame|twwhd}}	TWW	Category:Articles Using Invalid Arguments in Template Calls
11	{{#invoke:Franchise|BaseGame|}}		Category:Articles Using Invalid Arguments in Template Calls
12	{{#iferror:{{#invoke:Franchise|BaseGame|invalid game}}|custom error handling}}	custom error handling

Display

{{#invoke:Franchise|Display|<game>|nowarn=}}

Parameters

Parameter		Status	Description
1	game	required	The code for a game or other Zelda-related title defined at Data:Franchise.
nowarn		optional	If present, the template will not issue an editor warning when game is invalid. Use this when a template needs custom error handling (see examples). However, an editor warning will still be issued if a game code is written with incorrect casing (e.g. oot instead of OoT)

Examples

#	Input	Result	Categories added
13	{{#invoke:Franchise|Display|LA}}	Link's Awakening
14	{{#invoke:Franchise|Display|LANS}}	Link's Awakening for Nintendo Switch
15	{{#invoke:Franchise|Display|LA (Cagiva)}}	Link's Awakening (Cagiva)
16	{{#invoke:Franchise|Display|invalid game}}		Category:Articles Using Invalid Arguments in Template Calls
17	{{#invoke:Franchise|Display|}}		Category:Articles Using Invalid Arguments in Template Calls

Link

{{#invoke:Franchise|Link|<game>|nowarn=}}

Parameters

Parameter		Status	Description
1	game	required	The code for a game or other Zelda-related title defined at Data:Franchise.
nowarn		optional	If present, the template will not issue an editor warning when game is invalid. Use this when a template needs custom error handling (see examples). However, an editor warning will still be issued if a game code is written with incorrect casing (e.g. oot instead of OoT)

Examples

#	Input	Result	Categories added
18	{{#invoke:Franchise|Link|OoT}}	Ocarina of Time
19	{{#invoke:Franchise|Link|OoT (Himekawa)}}	Ocarina of Time (Himekawa)
Error handling
20	{{#invoke:Franchise|Link|oot}}	Ocarina of Time	Category:Articles Using Invalid Arguments in Template Calls
21	{{#invoke:Franchise|Link|notAGame}}		Category:Articles Using Invalid Arguments in Template Calls
22	{{#invoke:Franchise|Link|}}		Category:Articles Using Invalid Arguments in Template Calls
23	{{#iferror:{{#invoke:Franchise|Link|invalid game}}|custom error handling}}	custom error handling

ShortName

{{#invoke:Franchise|ShortName|<game>|nowarn=}}

Parameters

Parameter		Status	Description
1	game	required	The code for a game or other Zelda-related title defined at Data:Franchise.
nowarn		optional	If present, the template will not issue an editor warning when game is invalid. Use this when a template needs custom error handling (see examples). However, an editor warning will still be issued if a game code is written with incorrect casing (e.g. oot instead of OoT)

Examples

#	Input	Result	Categories added
24	{{#invoke:Franchise|ShortName|OoT}}	Ocarina of Time
25	{{#invoke:Franchise|ShortName|OoT (Himekawa)}}	Ocarina of Time (Himekawa)
26	{{#invoke:Franchise|ShortName|E}}	Encyclopedia
Error handling
27	{{#invoke:Franchise|ShortName|oot}}	Ocarina of Time	Category:Articles Using Invalid Arguments in Template Calls
28	{{#invoke:Franchise|ShortName|notAGame}}		Category:Articles Using Invalid Arguments in Template Calls
29	{{#invoke:Franchise|ShortName|}}		Category:Articles Using Invalid Arguments in Template Calls
Custom error handling
30	{{#iferror:{{#invoke:Franchise|ShortName|invalid game}}|[[Dodongo]]|[[Dodongo#{{#invoke:Franchise|ShortName|invalid game}}]]}}	Dodongo
31	{{#iferror:{{#invoke:Franchise|ShortName|oot}}|[[Dodongo]]|[[Dodongo#{{#invoke:Franchise|ShortName|oot}}]]}}	Dodongo#Ocarina of Time	Category:Articles Using Invalid Arguments in Template Calls
32	{{#iferror:{{#invoke:Franchise|ShortName|OoT}}|[[Dodongo]]|[[Dodongo#{{#invoke:Franchise|ShortName|OoT}}]]}}	Dodongo#Ocarina of Time

Module functions - all media

enum

enum(options)

See also enumGames.

Returns

• An array of all codes in canon order, plus a reference key so that it can be used for documentation and validation.

Examples

#	Input	Output	Status
33	local enum = Franchise.enum() return utilsTable.take(enum, 10)	{ "TLoZ", "TAoL", "ALttP", "LA", "LADX", "LANS", "OoT", "OoT3D", "MM", "MM3D", }
34	return Franchise.enum().reference	"[[Data:Franchise]]"
When includeSeries is true, then Series is the first item in the enum.
35	local enum = Franchise.enum({ includeSeries = true, }) return utilsTable.take(enum, 3)	{"Series", "TLoZ", "TAoL"}
When includeNonfiction is true, then books such as Encyclopedia are in the list.
36	local enum = Franchise.enum({ includeNonfiction = true, }) return utilsTable.includes(enum, "E")	true
When includeGroups is true, then collective terms such as A Link to the Past & Four Swords are included in the list.
37	local enum = Franchise.enum({ includeGroups = true, }) return utilsTable.includes(enum, "ALttP&FS")	true

article

article(code)

Returns

• Wiki article name for the title

Examples

#	Input	Output	Status
38	article("LA")	"The Legend of Zelda: Link's Awakening"
39	article("la")	"The Legend of Zelda: Link's Awakening"
40	article("LANS")	"The Legend of Zelda: Link's Awakening (Nintendo Switch)"
41	article("TAoL")	"Zelda II: The Adventure of Link"
42	article("TLoZ")	"The Legend of Zelda"
43	article("Series")	"The Legend of Zelda (Series)"
44	article("E")	"The Legend of Zelda: Encyclopedia"
45	article("SSB4")	"Super Smash Bros. for Nintendo 3DS / Wii U"

canonicity

canonicity(code)

Returns

• A string: canon, ambiguous, or non-canon.

Examples

#	Input	Output	Status
46	canonicity("LA")	"canon"
47	canonicity("la")	"canon"
48	canonicity("CoH")	"ambiguous"
49	canonicity("LA (Cagiva)")	"non-canon"
50	canonicity("E")	"canon"
51	canonicity("fake")	nil

code

code(code)

Returns

• The same code but correctly formatted, or nil if no such code exists

Examples

#	Input	Output	Status
52	code("alttp")	"ALttP"
53	code("fakegame")	nil

display

display(code)

Returns

• Formatted text for the title.

Examples

#	Input	Output	Result	Status
54	display("LA")	"''Link's Awakening''"	Link's Awakening
55	display("la")	"''Link's Awakening''"	Link's Awakening
56	display("LANS")	"''Link's Awakening'' for Nintendo Switch"	Link's Awakening for Nintendo Switch
57	display("E")	"''Encyclopedia''"	Encyclopedia
58	display("ALttP&FS")	"''A Link to the Past & Four Swords''"	A Link to the Past & Four Swords
59	display("Series")	"''The Legend of Zelda'' series"	The Legend of Zelda series
60	display("fakeGame")	nil

isCanon

isCanon(code)

Returns

• True if title is canon, else false.

Examples

#	Input	Output	Result
61	isCanon("LANS")	true
62	isCanon("lans")	true
63	isCanon("CoH")	false
64	isCanon("SSBU")	false
65	isCanon("E")	true
66	isCanon("Series")	true

link

link(code)

Returns

• Formatted link used in infoboxes and so on.

Examples

#	Input	Output	Result	Status
67	link("LA")	"''[[The Legend of Zelda: Link's Awakening|Link's Awakening]]''"	Link's Awakening
68	link("la")	"''[[The Legend of Zelda: Link's Awakening|Link's Awakening]]''"	Link's Awakening
69	link("LADX")	"''[[The Legend of Zelda: Link's Awakening DX|Link's Awakening DX]]''"	Link's Awakening DX
70	link("LANS")	"[[The Legend of Zelda: Link's Awakening (Nintendo Switch)|''Link's Awakening'' for Nintendo Switch]]"	Link's Awakening for Nintendo Switch
For books, comics and manga, see also phraseLink.
71	link("LA (Cagiva)")	"[[The Legend of Zelda: Link's Awakening (Cagiva)|''Link's Awakening'' (Cagiva)]]"	Link's Awakening (Cagiva)
72	link("E")	"''[[The Legend of Zelda: Encyclopedia|Encyclopedia]]''"	Encyclopedia
73	link("ALttP&FS")	"''[[The Legend of Zelda: A Link to the Past & Four Swords|A Link to the Past & Four Swords]]''"	A Link to the Past & Four Swords
74	link("Series")	"[[The Legend of Zelda (Series)|''The Legend of Zelda'' series]]"	The Legend of Zelda series
75	link("fakeGame")	nil

logo

logo(code)

Returns

• Filename for the title's logo.

Examples

#	Input	Output	Result	Status
76	logo("TWW")	"File:TWW English Logo.png"	File:TWW English Logo.png
77	logo("tww")	"File:TWW English Logo.png"	File:TWW English Logo.png
78	logo("E")	"File:The Legend of Zelda Encyclopedia Cover.png"	File:The Legend of Zelda Encyclopedia Cover.png
79	logo("Series")	"File:Zelda Logo TP.png"	File:Zelda Logo TP.png
80	logo("fakeGame")	nil

releaseDate

releaseDate(code)

Returns

• The "main" release date for a title.

Examples

#	Input	Output	Status
81	releaseDate("LA")	"1993-08-06"
82	releaseDate("LANS")	"2019-09-20"
83	releaseDate("LA (Cagiva)")	"1994-05-01"
84	releaseDate("E")	"2018-06-19"
85	releaseDate("ALttP&FS")	"2002-12-02"
86	releaseDate("Series")	""
87	releaseDate("fakeGame")	""

shortName

shortName(code)

Returns

• Short name for franchise title used in category names. Usually the subtitle.

Examples

#	Input	Output	Result	Status
88	shortName("LA")	"Link's Awakening"	Link's Awakening
89	shortName("la")	"Link's Awakening"	Link's Awakening
90	shortName("LANS")	"Link's Awakening (Nintendo Switch)"	Link's Awakening (Nintendo Switch)
91	shortName("LA (Cagiva)")	"Link's Awakening (Cagiva)"	Link's Awakening (Cagiva)
92	shortName("E")	"Encyclopedia"	Encyclopedia
93	shortName("ALttP&FS")	"A Link to the Past & Four Swords"	A Link to the Past & Four Swords
94	shortName("Series")	"The Legend of Zelda Series"	The Legend of Zelda Series
95	shortName("fakeGame")	nil

Module functions - games

type

type(code)

Returns

• One of: "main", "remake", "spin-off", "" (other games)

Examples

#	Input	Output	Result	Status
96	type("BotW")	"main"	main
97	type("HWAoC")	"spin-off"	spin-off
98	type("SSBU")	Expected "" Actual nil

enumGames

enumGames(includeSeries)

Returns

• An array of all game codes in canon order, plus a reference key so that it can be used for documentation and validation.

Examples

#	Input	Output	Status
99	local enum = Franchise.enumGames() return utilsTable.slice(enum, 18, 20)	{"TMC", "TP", "TPHD"}
100	return Franchise.enumGames().reference	"[[Data:Franchise]]"
When includeSeries is true, then Series is the first item in the enum.
101	local enum = Franchise.enumGames(true) return utilsTable.take(enum, 3)	{"Series", "TLoZ", "TAoL"}

baseGame

baseGame(code)

Returns

• If code is a remake, returns the code for the original game, else returns code as-is.

Examples

#	Input	Output	Status
102	baseGame("LANS")	"LA"
103	baseGame("LA")	Expected "LA" Actual nil
104	baseGame("fake")	nil

family

family(code)

Returns

• A grouping name used for certain non-canon games on the Main Page.

Examples

#	Input	Output	Status
105	family("OoT")	""
106	family("LCT")	""
107	family("FPTRR")	"Tingle"
108	family("HWDE")	"Hyrule Warriors"

graphics

graphics(code)

Returns

• A string: 2D or 3D.

Examples

#	Input	Output	Status
109	graphics("LA")	"2D"
110	graphics("la")	"2D"
111	graphics("LANS")	"3D"
112	graphics("fake")	nil

hasRemakes

hasRemakes(code)

Returns

• True if game has at least one remake, remaster, or enhanced port. Else false.

Examples

#	Input	Output	Result
113	hasRemakes("LA")	true
114	hasRemakes("LADX")	true
115	hasRemakes("ST")	false
116	hasRemakes("fakeGame")	false

isRemake

isRemake(code)

Returns

• True if game is a remake, remaster, or enhanced port. Else false.

Examples

#	Input	Output	Result
117	isRemake("LANS")	true
118	isRemake("LADX")	true
119	isRemake("LA")	false

remakes

remakes(code)

Returns

• List of remakes for a specific game, or a table of all remakes if no game specified

Examples

#	Input	Output	Result
120	remakes("LA")	{"LADX", "LANS"}
121	remakes("LADX")	{"LANS"}
122	remakes("ST")	{}
123	remakes("fake")	{}

Module functions - books

publisher

publisher(code)

Returns

• The book's publisher - in North America if available.

Examples

#	Input	Output	Result	Status
124	publisher("OoT (Himekawa)")	"VIZ Media"	VIZ Media
125	publisher("E")	"Dark Horse Books"	Dark Horse Books

phraseLink

phraseLink(code)

Returns

• Formatted link to page and authors.

Examples

#	Input	Output	Result	Status
126	phraseLink("TLoZ (Ran)")	"[[The Legend of Zelda (Ran)|''The Legend of Zelda'' manga]] by [[Maru Ran]]"	The Legend of Zelda manga by Maru Ran
127	phraseLink("tloz (ran)")	"[[The Legend of Zelda (Ran)|''The Legend of Zelda'' manga]] by [[Maru Ran]]"	The Legend of Zelda manga by Maru Ran
128	phraseLink("AOV")	"''[[The Legend of Zelda: An Original Version|The Legend of Zelda: An Original Version]]''"	The Legend of Zelda: An Original Version
129	phraseLink("fake")	nil
Nonfiction books such as Encyclopedia are not included in this.
130	phraseLink("E")	nil