Template:Infobox mod level/doc: Difference between revisions

From Celeste Wiki
Jump to navigation Jump to search
Content added Content deleted
(Updated)
(Updated documentation)
Line 5: Line 5:
"name": {
"name": {
"label": "Name",
"label": "Name",
"description": "Map name, will use page name if blank",
"description": "The map name",
"type": "line",
"type": "line",
"suggested": true
"suggested": true,
"default": "the article's name"
},
},
"image": {
"image": {
"label": "Image filename",
"label": "Image filename",
"description": "The full filename of the map's image",
"description": "The full filename of the map's image. The default syntax is [[File:FILENAME.ext|200px|frameless]] where FILENAME is the name of the file, and ext is its extension.",
"example": "[[File:Example.png|200px]]",
"example": "[[File:Example.png|200px|frameless]]",
"type": "wiki-file-name",
"type": "wiki-file-name",
"suggested": true
"suggested": true
Line 19: Line 20:
"label": "Creator",
"label": "Creator",
"suggested": true,
"suggested": true,
"type": "string"
"type": "string",
"description": "The name (nickname) of the map's creator.",
"example": "Maddy Thorson"
},
},
"author": {
"author": {
"label": "Other authors",
"label": "Other authors",
"description": "Arrange them in a list using <br> tags",
"description": "Arrange them in a list using <br> tags.",
"type": "string"
"type": "string",
"example": "Noel Berry (programmer)<br>Lena Raine (composer)<br>Pedro Medeiros (artist)"
},
},
"pack": {
"pack": {
"label": "Map pack or collab name",
"label": "Map pack or collab name",
"description": "Ignore (and un-tick) if you don't want it be a map pack or collab"
"description": "The name of the map pack or the collab of this map. Ignore (and un-tick) if it isn't in a map pack or collab",
"type": "string"
},
},
"collab": {
"collab": {
"label": "Is it a collab?",
"label": "Is it a collab?",
"description": "Specify yes if collab, has no effect if pack argument is blank",
"description": "Specify yes if it's in a collab. This argument has no effect if \"Map pack or collab name\" argument is blank.",
"type": "boolean"
"type": "boolean"
},
},
"dep": {
"dep": {
"label": "Dependencies",
"label": "Dependencies",
"description": "Use <br> tags to separate, provide links if possible"
"description": "Use <br> tags to separate.",
"type": "string"
},
},
"num": {
"num": {
"label": "Is numbering used?",
"label": "Is numbering used?",
"description": "Un-tick if numbering (8D, 7X, whatever) is not used. If defined, define arguments chaptertext, chapter, level",
"description": "Un-tick if numbering (9B, 8D, 2X, whatever) is not used. Otherwise, tick this argument and define \"Chapter number\" and \"Chapter letter\".",
"type": "boolean"
"type": "boolean"
},
},
"chaptertext": {
"chaptertext": {
"label": "Chaptertext",
"label": "Chaptertext",
"description": "It's the text that replaces \"Level\" in the numeration, no effect if num is undefined",
"description": "Text that replaces \"Level\" in the numeration.",
"default": "Level"
"default": "Level",
"example": "Lobby"
},
},
"chapter": {
"chapter": {
"label": "Chapter number",
"label": "Chapter number",
"description": "No effect if num is undefined",
"description": "No effect if numbering is not used.",
"example": "1"
"example": "1",
"type": "number",
"suggestedvalues": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9"
]
},
},
"level": {
"level": {
"label": "Chapter letter",
"label": "Chapter letter",
"description": "No effect if num is undefined",
"description": "No effect if numbering is not used.",
"example": "A"
"example": "A",
"suggestedvalues": [
"A",
"B",
"C",
"D"
]
},
},
"strawberries": {
"strawberries": {
"label": "Strawberries",
"label": "Strawberries",
"description": "Strawberries in the mod/collab/map. Use {{Silverberry}} for substituting the silverberry image",
"description": "Strawberries in the mod/collab/map. Use {{Silverberry}} for the silverberry image.",
"example": "10 {{Strawberry}} 5 {{Silverberry}}",
"example": "10 {{Strawberry}} 5 {{Silverberry}}",
"suggested": true
"suggested": true,
"type": "string"
},
},
"difficulty": {
"difficulty": {
"label": "Difficulty",
"label": "Difficulty",
"description": "No limitations within the template, but it is suggested to use the Spring Collab scale (Beginner...Grandmaster++). Do not use abbreviations.",
"description": "Use your favorite scale, no extra requirements",
"suggested": true
"suggested": true,
"suggestedvalues": [
"Beginner",
"Intermediate",
"Advanced",
"Expert",
"Grandmaster",
"Grandmaster+",
"Grandmaster++"
]
},
},
"music": {
"music": {
"label": "Soundtrack",
"label": "Soundtrack",
"description": "You may want to use the soundtrack template"
"description": "You may want to use the [[Template:Soundtrack|soundtrack template]]."
},
},
"nav": {
"nav": {
"label": "Is there navigation?",
"label": "Is there navigation?",
"description": "Use it if there's an A-Side and a B-Side and a C-Side and level navigation... not quite sure what that means. Anyway it's yes/no",
"description": "Type \"yes\" if there's an A-Side and a B-Side and a C-Side. It will enable the navigation bar.",
"type": "boolean"
"type": "boolean"
},
},
"sides": {
"sides": {
"label": "Sides",
"label": "Sides",
"description": "No effect if nav is set to no, it's yes/no and if yes, it'll provide links to XA, XB and XC, where X is the value of the chapter number argument earlier",
"description": "No effect if navigation is not used. If this argument is \"yes\", it'll provide links to XA, XB, and XC, where X is the value of the \"Chapter number\" argument earlier",
"type": "boolean"
"type": "boolean"
},
},
"previous": {
"previous": {
"label": "Previous map",
"label": "Previous map",
"description": "Used in navigation, no effect if nav is no or undefined. Only the name is required, will be linked automatically",
"description": "Used in navigation, no effect if no navigation. Only the name is required, will be linked automatically.",
"type": "line"
"type": "line"
},
},
"next": {
"next": {
"label": "Next map",
"label": "Next map",
"description": "Used in navigation, no effect if nav is no or undefined. Only the name is required, will be linked automatically",
"description": "Used in navigation, no effect if no navigation. Only the name is required, will be linked automatically",
"type": "line"
"type": "line"
}
}
},
},
"description": "An infobox for custom maps.\nDocumentation was not written or reviewed by the template author, and the documentation author doesn't have a lot of experience playing custom maps, so it may be incorrect or incomplete.\n Good luck there, feel free to correct the documentation if you know how"
"description": "An infobox for custom maps.\nThe documentation may be incorrect or incomplete. No arguments are required, but it is strongly recommended to fill in everything you know.",
"format": "block"
}
}
</templatedata>
</templatedata>

Revision as of 09:40, 5 July 2023

An infobox for custom maps. The documentation may be incorrect or incomplete. No arguments are required, but it is strongly recommended to fill in everything you know.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

The map name

Default
the article's name
Linesuggested
Image filenameimage

The full filename of the map's image. The default syntax is [[File:FILENAME.ext|200px|frameless]] where FILENAME is the name of the file, and ext is its extension.

Example
[[File:Example.png|200px|frameless]]
Filesuggested
Creatorcreator

The name (nickname) of the map's creator.

Example
Maddy Thorson
Stringsuggested
Other authorsauthor

Arrange them in a list using <br> tags.

Example
Noel Berry (programmer)<br>Lena Raine (composer)<br>Pedro Medeiros (artist)
Stringoptional
Map pack or collab namepack

The name of the map pack or the collab of this map. Ignore (and un-tick) if it isn't in a map pack or collab

Stringoptional
Is it a collab?collab

Specify yes if it's in a collab. This argument has no effect if "Map pack or collab name" argument is blank.

Booleanoptional
Dependenciesdep

Use <br> tags to separate.

Stringoptional
Is numbering used?num

Un-tick if numbering (9B, 8D, 2X, whatever) is not used. Otherwise, tick this argument and define "Chapter number" and "Chapter letter".

Booleanoptional
Chaptertextchaptertext

Text that replaces "Level" in the numeration.

Default
Level
Example
Lobby
Unknownoptional
Chapter numberchapter

No effect if numbering is not used.

Suggested values
1 2 3 4 5 6 7 8 9
Example
1
Numberoptional
Chapter letterlevel

No effect if numbering is not used.

Suggested values
A B C D
Example
A
Unknownoptional
Strawberriesstrawberries

Strawberries in the mod/collab/map. Use {{Silverberry}} for the silverberry image.

Example
10 {{Strawberry}} 5 {{Silverberry}}
Stringsuggested
Difficultydifficulty

No limitations within the template, but it is suggested to use the Spring Collab scale (Beginner...Grandmaster++). Do not use abbreviations.

Suggested values
Beginner Intermediate Advanced Expert Grandmaster Grandmaster+ Grandmaster++
Unknownsuggested
Soundtrackmusic

You may want to use the [[Template:Soundtrack|soundtrack template]].

Unknownoptional
Is there navigation?nav

Type "yes" if there's an A-Side and a B-Side and a C-Side. It will enable the navigation bar.

Booleanoptional
Sidessides

No effect if navigation is not used. If this argument is "yes", it'll provide links to XA, XB, and XC, where X is the value of the "Chapter number" argument earlier

Booleanoptional
Previous mapprevious

Used in navigation, no effect if no navigation. Only the name is required, will be linked automatically.

Lineoptional
Next mapnext

Used in navigation, no effect if no navigation. Only the name is required, will be linked automatically

Lineoptional