Template:ModuleInfobox: Difference between revisions

From Official Gamemode 4 Wiki
Jump to navigation Jump to search
m (Let's try an onlyinclude)
m (Just gonna try this out)
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<includeonly>{{#if: {{{retired|}}} | [[Category: Retired Modules]] | <onlyinclude>[[Category: All Modules]]</onlyinclude> }}
<includeonly>
{{Infobox
{{Infobox
| title = {{{name|Gamemode 4 Module}}}
  | title = {{{ name | {{SUBPAGENAME}}}}}
| image = [[File:{{#setmainimage: {{{icon|gm4_logo.svg}}} }} |150px|link=]]
  | 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 = {{ #switch: {{{type|}}}
  | data2 = {{ #switch: {{{type|}}}
| Base = Base {{#if: {{{retired|}}} | | [[Category:Base Modules]] {{#ifeq: {{#sub:{{{name}}} |-6}} | Shamir | [[Category:Metallurgy]] | }} }}
| Base = Base {{#if: {{{retired|}}} | | [[Category: All Modules]][[Category:Base Modules]] }}
| Expansion = Expansion {{#if: {{{retired|}}} | | [[Category:Expansion Packs]] {{#ifeq:{{#sub:{{{name}}}|-6}}|Shamir|[[Category:Shamirs]] | }} }}
| Expansion = Expansion {{#if: {{{retired|}}} | | [[Category: All Modules]][[Category:Expansion Packs]] }}
| Reliant = Reliant {{#if: {{{retired|}}} | | [[Category:Reliant Modules]] {{#ifeq: {{#sub: {{{name}}} |-6}} | Shamir | [[Category:Shamirs]] | }} }}
| Reliant = Reliant {{#if: {{{retired|}}} | | [[Category: All Modules]][[Category:Reliant Modules]] }}
| Stand Alone = Stand Alone {{#if: {{{retired|}}}|| {{#ifeq: {{#sub:{{{name}}} |-6}} | Shamir | [[Category:Shamirs]] | }} [[Category:Stand Alone Modules]] }}
| Stand Alone = Stand Alone {{#if: {{{retired|}}}| | [[Category: All Modules]] [[Category:Stand Alone Modules]] }}
    | Library = Library [[Category: All Modules]][[Category: Library]]
|''unknown''
|''unknown''
}}
}}
| label3 = Created by
  | label3 = Created by
| data3 = {{{creator|''unknown''}}}
  | data3 = {{{creator|''unknown''}}}
| label4 = Last Updated by
  | label4 = Last Updated by
| data4 = {{{updater|}}}
  | data4 = {{{updater|}}}
| label5 = Required Modules
  | label5 = Required Modules
| data5 = {{{requires|}}}
  | data5 = {{{requires|}}}
| label6 = Complementary Modules
  | label6 = Complementary Modules
| data6 = {{{complementary|}}}
  | data6 = {{{complementary|}}}
| label7 = Incompatible Modules
  | label7 = Incompatible Modules
| data7 = {{{incompatible|}}}
  | data7 = {{{incompatible|}}}
| label8 = Compatible MC Versions
  | label8 = Compatible MC Versions
| data8 = {{#if: {{{retired|}}} | ''none'' | {{{versions|''unknown''}}} }}
  | data8 = {{#if: {{{retired|}}} | {{#ifeq: {{{retired|}}} | true | ''none'' | Retired since {{{retired}}} }} | {{{versions|''unknown''}}} }}
}}</includeonly><noinclude>
}}</includeonly><noinclude>
{{Documentation}}
{{Documentation}}
</noinclude>
<templatedata>
{
"params": {
"name": {
"label": "Name",
"description": "Name",
"example": "Custom Crafters",
"type": "line",
"deprecated": "Will automatically enter based on page name"
},
"icon": {
"label": "Icon",
"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>

Revision as of 07:00, 2 March 2024

Template documentation[view] [edit] [history] [purge]
{{{name}}}
[[File:{{{icon}}}]]

Module Type{{{type}}}
Created bycreator
Last Updated byupdater
Required Modules{{{requires}}}
Complementary Modules{{{complementary}}}
Incompatible Modules{{{incompatible}}}
Compatible MC Versions{{{versions}}}
ModuleInfobox

Module Typeunknown
Created byunknown
Compatible MC Versionsunknown

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 infoxbox on the right of module pages

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
Namename

Name

Example
Custom Crafters
Linedeprecated
Iconicon

Icon

Default
gm4_logo.svg
Example
Custom Crafters.svg
Filedeprecated
Typetype

Module Type (Base, Expansion, Reliant, Discontinued)

Example
Expansion
Linesuggested
Creatorcreator

List of authors upon release/initial publish

Example
Bloo___, Misode, and SpecialBuilder32
Linesuggested
Updaterupdater

List of everyone who has updated the module by a significant amount

Example
BluePsychoRanger
Linesuggested
Requiresrequires

List of modules required for this module to function

Example
Custom Crafters
Linesuggested
Complementarycomplementary

A list of complementary modules

Example
Master Crafting, Record Crafting
Linesuggested
Incompatibleincompatible

A list of incompatible modules

Lineoptional
Versionsversions

The range of versions that this module has ever supported

Example
1.17+
Linesuggested
Retiredretired

Module retirement version

Example
1.14
Lineoptional