Template:Infobox mod/doc: Difference between revisions

From Celeste Wiki
Jump to navigation Jump to search
Content added Content deleted
(Documentation for mod infobox)
 
(updated documentation)
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",
Line 29:
"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 ⟶ 43:
"label": "Dependencies",
"type": "string",
"suggested": true,
"description": "It's not really needed to list all of them if there are like 20 of them. List only the \"exotic\" ones and those that matter the most. Don't forget to use links."
},
"link": {
"label": "Link to GameBanana",
"description": "OnlyThe thefull URL is required.",
"example": "https://gamebanana.com/mods/53687",
"type": "url",
Line 55 ⟶ 57:
"description": "Defining this parameter does not apply automatic categorization. Useful when you have a narrower category (e.g. Category:Collabs)",
"type": "boolean"
},
"customl1": {
"label": "Custom label 1",
"description": "customl1, customl2, customl3... - for adding custom field LABELS (after Dependencies) IF AND ONLY IF NEEDED for something remarkable. Keep it short (1-2 words max)",
"example": "Languages",
"type": "line"
},
"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! (reasonably)",
"example": "axolotl",
"type": "string"
},
"customl2": {},
"customv2": {},
"customl3": {},
"customv3": {}
},
"description": "This infobox is intended for use in articles about mods.\nIt clarifiesbriefly introduces the general information of a 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 set to- Collabs\"[[Skin]]\"notherwise and- Category:Mods otherwise. You may want to circumvent this: setting\nSetting the nocat parameter to any value does not apply any categorization.",
"paramOrder": [
"name",
Line 66 ⟶ 84:
"link",
"nobr",
"nocat",
"customl1",
"customv1",
"customl2",
"customv2",
"customl3",
"customv3"
],
"format": "block"

Revision as of 18:17, 29 November 2023

This infobox is intended for use in articles about mods. 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.

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
Creator(s)creator

no description

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

It's not really needed to list all of them if there are like 20 of them. List only the "exotic" ones and those that matter the most. Don't forget to use links.

Stringsuggested
Link to GameBananalink

The full URL is required.

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

Check if you don't want to introduce a line break after the image.

Booleanoptional
Do not categorizenocat

Defining this parameter does not apply automatic categorization. Useful when you have a narrower category (e.g. Category:Collabs)

Booleanoptional
Custom label 1customl1

customl1, customl2, customl3... - for adding custom field LABELS (after Dependencies) IF AND ONLY IF NEEDED for something remarkable. 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! (reasonably)

Example
axolotl
Stringoptional
customl2customl2

no description

Unknownoptional
customv2customv2

no description

Unknownoptional
customl3customl3

no description

Unknownoptional
customv3customv3

no description

Unknownoptional