Template:ModuleInfobox: Difference between revisions

ModuleInfobox
Module Type	unknown
Created by	unknown
Compatible MC Versions	unknown

{{{name}}}
	[[File:{{{icon}}}]]
Module Type	{{{type}}}
Created by	creator
Last Updated by	updater
Required Modules	{{{requires}}}
Complementary Modules	{{{complementary}}}
Incompatible Modules	{{{incompatible}}}
Compatible MC Versions	{{{versions}}}

Browse history interactively

VisualWikitext

Latest revision as of 19:35, 13 October 2024

Template documentation[view] [edit] [history] [purge]

This is an example Module Infobox, showing all available parameters.

Below that is the default Infobox, if no parameters are set.

The title, type, creator, and versions parameters should always be set.

"title" - name of the module

"type" - module type (Stand Alone, Base, Expansion, Reliant)

"creator" - original creator of the module

"versions" - the MC versions that the latest module version works with

The "icon" parameter should refer to the image file stored on the wiki. Icons should be named the same as the module name in snake_case (e.g. custom_crafters.png)

If the module doesn't have an image, do not fill in the "icon" parameter. It will default to the GM4 logo if unset.

The "updater" parameter is used only if the latest version of the module was modified by a specific user such that performance or mechanics were changed. This parameter should be the same as displayed on the module download page.

The "requires" parameter should be set if the module is a reliant module or expansion pack, and should link to the page of the base module.

The "complementary" parameter should be set to whatever modules are listed on the download page as a complementary module. Any listed module should be linked to their respective page.

The "incompatible" parameter should be set only if there are modules that conflict with other modules, though this case is very rare, and is more of a remnant before Gamemode 4 became heavily focused on compatibility.

The above documentation is transcluded from Template:ModuleInfobox/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.

The infoxbox on the right of module pages

Template parameters[Edit template data]
Parameter		Description	Type	Status
Name	`name`	Name Example Custom Crafters	Line	deprecated
Icon	`icon`	Icon Default gm4_logo.svg Example Custom Crafters.svg	File	deprecated
Type	`type`	Module Type (Base, Expansion, Reliant, Discontinued) Example Expansion	Line	suggested
Creator	`creator`	List of authors upon release/initial publish Example Bloo___, Misode, and SpecialBuilder32	Line	suggested
Updater	`updater`	List of everyone who has updated the module by a significant amount Example BluePsychoRanger	Line	suggested
Requires	`requires`	List of modules required for this module to function Example Custom Crafters	Line	suggested
Complementary	`complementary`	A list of complementary modules Example Master Crafting, Record Crafting	Line	suggested
Incompatible	`incompatible`	A list of incompatible modules	Line	optional
Versions	`versions`	The range of versions that this module has ever supported Example 1.17+	Line	suggested
Retired	`retired`	Module retirement version Example 1.14	Line	optional

@@ Line 1: / Line 1: @@
+<includeonly>
 {{Infobox
-|title = {{{name|Gamemode 4 Module}}}
+  | title = {{{ name | {{SUBPAGENAME}}}}}
-|image = [[File:{{{icon|gm4_logo.svg}}}|150px]]
+  | image = {{#ifexist: File:{{{icon}}} | [[File:{{{icon}}}|150px|link=]] | {{#ifexist: File:{{SUBPAGENAME}}.svg | [[File:{{SUBPAGENAME}}.svg|150px|link=]] | {{#ifexist: File:{{SUBPAGENAME}}.png | [[File:{{SUBPAGENAME}}.png|150px|link]] | {{#ifexist: File:{{#titleparts: {{FULLPAGENAME}} | -1 | -2 }}.svg | [[File:{{#titleparts: {{FULLPAGENAME}} | -1 | -2 }}.svg|150px|link=]] | {{#ifexist: File:{{#titleparts: {{FULLPAGENAME}} | -1 | -2 }}.png | [[File:{{#titleparts: {{FULLPAGENAME}} | -1 | -2 }}.png|150px|link=]] | {{#ifexist: File:{{#titleparts: {{FULLPAGENAME}} | -2 | -3 }}.svg | [[File:{{#titleparts: {{FULLPAGENAME}} | -2 | -3 }}.svg|150px|link=]] | {{#ifexist: File:{{#titleparts: {{FULLPAGENAME}} | -2 | -3 }}.png | [[File:{{#titleparts: {{FULLPAGENAME}} | -2 | -3 }}.png|150px|link=]] | [[File:{{#setmainimage: gm4_logo.svg }} |150px|link=]] }} }} }} }} }} }} }}
-|header1 = --------------------
+  | header1 = <hr>
-|label2 = Module Type
+  | label2 = Module Type
-|data2 = {{{type|''unknown''}}}
+  | data2 = {{ #switch: {{{type|}}}
-|label3 = Created by
+	| Base = Base {{#if: {{{retired|}}} | | [[Category: All Modules]][[Category:Base Modules]] }}
-|data3 = {{{creator|''unknown''}}}
+	| Expansion = Expansion {{#if: {{{retired|}}} | | [[Category: All Modules]][[Category:Expansion Packs]] }}
-|label4 = Last Updated by
+	| Reliant = Reliant {{#if: {{{retired|}}} | | [[Category: All Modules]][[Category:Reliant Modules]] }}
-|data4 = {{{updater|}}}
+	| Stand Alone = Stand Alone {{#if: {{{retired|}}}| | [[Category: All Modules]] [[Category:Stand Alone Modules]] }}
-|label5 = Required Modules
+    | Library = Library [[Category: All Modules]][[Category: Library]]
-|data5 = {{{requires|}}}
+	| Resource
-|label6 = Complementary Modules
+    | Resource Pack = Resource Pack [[Category: Resource Packs]]
-|data6 = {{{complementary|}}}
+    | ''unknown''
-|label7 = Incompatible Modules
+	}}
-|data7 = {{{incompatible|}}}
+  | label3 = Created by
-|label8 = Latest MC Version(s)
+  | data3 = {{{creator|''unknown''}}}
-|data8 = {{{versions|''unknown''}}}
+  | label4 = Last Updated by
-}}
+  | data4 = {{{updater|}}}
-<noinclude>
+  | label5 = Required Modules
-{{Infobox
+  | data5 = {{{requires|}}}
-|title = {{{name}}}
+  | label6 = Complementary Modules
-|image = [[File:{{{icon}}}]]
+  | data6 = {{{complementary|}}}
-|header1 = --------------------
+  | label7 = Incompatible Modules
-|label2 = Module Type
+  | data7 = {{{incompatible|}}}
-|data2 = {{{type}}}
+  | label8 = Compatible MC Versions
-|label3 = Created by
+  | data8 = {{#if: {{{retired|}}} | {{#ifeq: {{{retired|}}} | true | ''none'' | Retired since {{{retired}}} }} | {{{versions|''unknown''}}} }}
-|data3 = {{{creator}}}
+  | label9 = Resource Pack
-|label4 = Last Updated by
+  | data9 = {{#switch: {{{resource|}}}
-|data4 = {{{updater}}}
+	| Required = Required [[Category: Resource Pack Compatible]] [[Category: Resource Pack Required]]
-|label5 = Required Modules
+    | Optional = Optional [[Category: Resource Pack Compatible]]
-|data5 = {{{requires}}}
+    |
-|label6 = Complementary Modules
+    }}
-|data6 = {{{complementary}}}
+}}</includeonly><noinclude>
-|label7 = Incompatible Modules
+{{Documentation}}
-|data7 = {{{incompatible}}}
+<templatedata>
-|label8 = Latest MC Version(s)
+{
-|data8 = {{{versions}}}
+	"params": {
-}}
+		"name": {
-</noinclude>
+			"label": "Name",
+			"description": "Name",
+			"example": "Custom Crafters",
+			"type": "line",
+			"deprecated": "Will automatically enter based on page name"
+		},
+		"icon": {
+			"label": "Icon",
+"suggested": true,
+			"description": "Icon",
+			"example": "Custom Crafters.svg",
+			"type": "wiki-file-name",
+			"default": "gm4_logo.svg",
+			"deprecated": "Upload a .svg or .png titled the module name, with title case on every word"
+		},
+		"type": {
+			"label": "Type",
+			"description": "Module Type (Base, Expansion, Reliant, Discontinued)",
+			"example": "Expansion",
+			"type": "line",
+			"suggested": true
+		},
+		"retired": {
+			"label": "Retired",
+			"description": "Module retirement version",
+			"example": "1.14",
+			"type": "line"
+		},
+		"creator": {
+			"label": "Creator",
+			"description": "List of authors upon release/initial publish",
+			"example": "Bloo___, Misode, and SpecialBuilder32",
+			"type": "line",
+			"suggested": true
+		},
+		"updater": {
+			"label": "Updater",
+			"description": "List of everyone who has updated the module by a significant amount",
+			"example": "BluePsychoRanger",
+			"type": "line",
+			"suggested": true
+		},
+		"requires": {
+			"label": "Requires",
+			"description": "List of modules required for this module to function",
+			"example": "Custom Crafters",
+			"type": "line",
+			"suggested": true
+		},
+		"complementary": {
+			"label": "Complementary",
+			"description": "A list of complementary modules",
+			"example": "Master Crafting, Record Crafting",
+			"type": "line",
+			"suggested": true
+		},
+		"incompatible": {
+			"label": "Incompatible",
+			"description": "A list of incompatible modules",
+			"type": "line"
+		},
+		"versions": {
+			"label": "Versions",
+			"description": "The range of versions that this module has ever supported",
+			"example": "1.17+",
+			"type": "line",
+			"suggested": true
+		}
+	},
+	"paramOrder": [
+		"name",
+		"icon",
+		"type",
+		"creator",
+		"updater",
+		"requires",
+		"complementary",
+		"incompatible",
+		"versions",
+		"retired"
+	],
+	"description": "The infoxbox on the right of module pages"
+}
+</templatedata></noinclude>



Module Type	unknown
Created by	unknown
Compatible MC Versions	unknown

Template:ModuleInfobox: Difference between revisions

Latest revision as of 19:35, 13 October 2024

Navigation menu

Search