Template:Infobox mod/doc: Difference between revisions

From Celeste Wiki
Jump to navigation Jump to search
Content added Content deleted
(Documentation for mod infobox)
 
(nobr no longer used)
(2 intermediate revisions by the same user not shown)
Line 12:
"image": {
"label": "Image",
"description": "Use full file syntax. The size (width) is recommended to be either 200px or 250px.",
"example": "[[File:Example.jpg|200px]]",
"type": "wiki-file-name",
"suggested": true
},
"nobr": {
"label": "Do not break line",
"description": "Check if you don't want to introduce a line break after the image.",
"type": "boolean"
},
"creator": {
"label": "Creator(s)Key authors",
"type": "string",
"suggested": true,
"aliases": [
"author",
"authors"
],
"description": "List key authors of the mod here as indicated on GameBanana. If there are too many, list the most notable ones. Separate them with <br>.",
"example": "maddie480<br>Programmatic<br>SnipUndercover"
},
"type": {
"label": "Type",
"description": "The general type of the mod. Use with a [[wikilink]]. Affects categorization: see the template's description for details",
"example": "[[Helper]]",
"type": "line",
"suggestedvalues": [
"[[Maps]]Helper",
"[[Helper]]Collab",
"[[Skin]]Campaign",
"Skin"
],
"suggested": true
Line 42 ⟶ 44:
"label": "Dependencies",
"type": "string",
"description": "Dependencies used by the mod, and (if needed) their versions. List only the dependencies that matter the most, or the \"exotic\" ones. Do not list Everest. Separate the dependencies using <br>. Use wiki links to them when possible."
"suggested": true
},
"link": {
"label": "Link to GameBanana",
"description": "OnlyThe thefull URL isto the GameBanana mod requiredpage.",
"example": "https://gamebanana.com/mods/53687",
"type": "url",
"suggested": true,
"aliases": [
"url"
]
},
"nocat": {
"label": "Do not categorize",
"description": "Defining this parameter does not apply automatic categorization. Useful when you have a narrower category (e.g. Category:Collabs)",
"type": "boolean"
},
"nobrcustoml1": {
"label": "DoCustom notlabel break line1",
"description": "customl1, customl2, customl3... - for adding custom field LABELS. Use them only for something remarkable enough. Keep it short (1-2 words max)",
"example": "Languages",
"type": "booleanline"
},
"customv1": {
"label": "Custom value 1",
"description": "customv1, customv2, customv3... - for adding custom fields DATA. Make sure to include the corresponding label as well. Other than that, any text you want/need!",
"example": "axolotl",
"type": "string"
},
"customl2": {
"type": "line"
},
"customv2": {
"type": "string"
},
"customl3": {
"type": "line"
},
"customv3": {
"type": "string"
}
},
"description": "This infobox is intended for use in articles about mods.\nIt clarifiesthat theare generalnot informationmaps of(for acustom maps, use Infobox mod level).\nIt briefly introduces the mod to the reader.\nAdditionally, automatic categorizing is applied to the article based on the \"type\" argument:\nThe. Depending on it (first column, without braces), the article will be categorized tointo Category:Helpersthe ifcategory (second column):\n\"typeHelper\" is set to- Helpers\n\"[[Helper]]Skin\", Category:- Skin mods if \n\"typeCollab\" is- setCollabs\notherwise - Mods.\nSetting the nocat parameter to any value does not apply any categorization.\"[[Skin]]n\"nThis andinfobox Category:Modssupports otherwiseadding up to 3 more fields (shown after Dependencies). YouFor maythat, wantfill toarguments circumventcustoml1 this:(or customl2, etc.) settingwith the nocatfield's parameterlabel, toand anycustomv1 value(or doescustomv2, notetc.) applywith categorizationits data.",
"paramOrder": [
"name",
Line 65 ⟶ 94:
"dep",
"link",
"nobrnocat",
"nocatcustoml1",
"customv1",
"customl2",
"customv2",
"customl3",
"customv3"
],
"format": "block"

Revision as of 12:56, 23 June 2024

This infobox is intended for use in articles about mods that are not maps (for custom maps, use Infobox mod level). It briefly introduces the mod to the reader. Additionally, automatic categorizing is applied to the article based on the "type" argument. Depending on it (first column, without braces), the article will be categorized into the category (second column): "Helper" - Helpers "Skin" - Skin mods "Collab" - Collabs otherwise - Mods. Setting the nocat parameter to any value does not apply any categorization. This infobox supports adding up to 3 more fields (shown after Dependencies). For that, fill arguments customl1 (or customl2, etc.) with the field's label, and customv1 (or customv2, etc.) with its data.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

The mod's name

Default
page name
Linesuggested
Imageimage

Use full file syntax. The size (width) is recommended to be either 200px or 250px.

Example
[[File:Example.jpg|200px]]
Filesuggested
Key authorscreator author authors

List key authors of the mod here as indicated on GameBanana. If there are too many, list the most notable ones. Separate them with <br>.

Example
maddie480<br>Programmatic<br>SnipUndercover
Stringsuggested
Typetype

The general type of the mod. Affects categorization: see the template's description for details

Suggested values
Helper Collab Campaign Skin
Example
Helper
Linesuggested
Dependenciesdep

Dependencies used by the mod, and (if needed) their versions. List only the dependencies that matter the most, or the "exotic" ones. Do not list Everest. Separate the dependencies using <br>. Use wiki links to them when possible.

Stringoptional
Linklink url

The full URL to the GameBanana mod page.

Example
https://gamebanana.com/mods/53687
URLsuggested
Do not categorizenocat

Defining this parameter does not apply automatic categorization. Useful when you have a narrower category.

Booleanoptional
Custom label 1customl1

customl1, customl2, customl3... - for adding custom field LABELS. Use them only for something remarkable enough. Keep it short (1-2 words max)

Example
Languages
Lineoptional
Custom value 1customv1

customv1, customv2, customv3... - for adding custom fields DATA. Make sure to include the corresponding label as well. Other than that, any text you want/need!

Example
axolotl
Stringoptional
customl2customl2

no description

Lineoptional
customv2customv2

no description

Stringoptional
customl3customl3

no description

Lineoptional
customv3customv3

no description

Stringoptional