Template:Infobox mod/doc: Difference between revisions

Jump to navigation Jump to search
Content added Content deleted
(Documentation for mod infobox)
 
(updated documentation)
Line 12: Line 12:
"image": {
"image": {
"label": "Image",
"label": "Image",
"description": "Use full file syntax.",
"description": "Use full file syntax. The size (width) is recommended to be either 200px or 250px.",
"example": "[[File:Example.jpg|200px]]",
"example": "[[File:Example.jpg|200px]]",
"type": "wiki-file-name",
"type": "wiki-file-name",
Line 29: Line 29:
"type": {
"type": {
"label": "Type",
"label": "Type",
"description": "The general type of the mod. Use with a [[wikilink]]. Affects categorization: see the template's description for details",
"description": "The general type of the mod. Affects categorization: see the template's description for details",
"example": "[[Helper]]",
"example": "Helper",
"type": "line",
"type": "line",
"suggestedvalues": [
"suggestedvalues": [
"[[Maps]]",
"Helper",
"[[Helper]]",
"Collab",
"[[Skin]]"
"Campaign",
"Skin"
],
],
"suggested": true
"suggested": true
Line 42: Line 43:
"label": "Dependencies",
"label": "Dependencies",
"type": "string",
"type": "string",
"suggested": true
"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": {
"link": {
"label": "Link to GameBanana",
"label": "Link to GameBanana",
"description": "Only the URL is required.",
"description": "The full URL is required.",
"example": "https://gamebanana.com/mods/53687",
"example": "https://gamebanana.com/mods/53687",
"type": "url",
"type": "url",
Line 55: Line 57:
"description": "Defining this parameter does not apply automatic categorization. Useful when you have a narrower category (e.g. Category:Collabs)",
"description": "Defining this parameter does not apply automatic categorization. Useful when you have a narrower category (e.g. Category:Collabs)",
"type": "boolean"
"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 clarifies the general information of a mod to the reader.\nAdditionally, automatic categorizing is applied to the article based on the \"type\" argument:\nThe article will be categorized to Category:Helpers if \"type\" is set to \"[[Helper]]\", Category:Skin mods if \"type\" is set to \"[[Skin]]\" and Category:Mods otherwise. You may want to circumvent this: setting the nocat parameter to any value does not apply categorization.",
"description": "This infobox is intended for use in articles about mods.\nIt briefly introduces the mod to the reader.\nAdditionally, 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):\n\"Helper\" - Helpers\n\"Skin\" - Skin mods\n\"Collab\" - Collabs\notherwise - Mods.\nSetting the nocat parameter to any value does not apply any categorization.",
"paramOrder": [
"paramOrder": [
"name",
"name",
Line 66: Line 84:
"link",
"link",
"nobr",
"nobr",
"nocat"
"nocat",
"customl1",
"customv1",
"customl2",
"customv2",
"customl3",
"customv3"
],
],
"format": "block"
"format": "block"