No edit summary |
(add category notice) |
||
(32 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
{{CategorySetting}} | |||
{{PropertySetting}} | |||
<templatedata> | <templatedata> | ||
{ | { "description": "Displays an infobox containing a world's details.", | ||
"params": { | "params": { | ||
"headercolor": { | "headercolor": { | ||
"label": " | "label": "Header color", | ||
"description": "The color | "description": "The header's background color.", | ||
"type": "string", | "type": "string", | ||
" | "suggested": true, | ||
" | "default": "#3366CC" | ||
}, | }, | ||
"headerfontcolor": { | "headerfontcolor": { | ||
"label": " | "label": "Header font color", | ||
"description": "The color | "description": "The header's text color.", | ||
"type": "string", | "type": "string", | ||
"default": "# | "suggested": true, | ||
"default": "#ffffff" | |||
}, | }, | ||
"image": { | "image": { | ||
"label": "image", | "label": "Location image", | ||
"description": "The file name for the image to be displayed | "description": "The file name for the image to be displayed. It should properly represent the location.", | ||
"type": "wiki-file-name" | "type": "wiki-file-name", | ||
"example": "Azure_garden.png", | |||
"required": true | |||
}, | }, | ||
" | "Name": { | ||
"label": " | "label": "Original Name(s)", | ||
"description": "The | "description": "The area's original native-language names, along with any translations thereof, separated by commas. If the original name is Japanese and you specified it for \"JapaneseName\", do not repeat it here.", | ||
"type": "string" | "example": "''Tobirabeya'', Door Room", | ||
"type": "string", | |||
"suggested": true | |||
}, | }, | ||
"JapaneseName": { | "JapaneseName": { | ||
"label": " | "label": "Japanese Name", | ||
"description": "The area's Japanese | "description": "The area's original name in Japanese, if applicable. Only one value is accepted.", | ||
"example": "扉部屋", | "example": "扉部屋", | ||
"type": "string" | "type": "string" | ||
Line 33: | Line 40: | ||
"Effects": { | "Effects": { | ||
"label": "Effects", | "label": "Effects", | ||
"description": "Effects obtainable in | "description": "Effects (or the game's equivalent) obtainable in this location.", | ||
"example": "Chainsaw", | "example": "Chainsaw", | ||
"type": "string" | "type": "string", | ||
"required": true | |||
}, | }, | ||
" | "Collectibles": { | ||
"label": " | "label": "Collectibles", | ||
"description": "Collectibles that you can find in | "description": "Collectibles that you can find in this location.", | ||
"example": "WP #87, Kura Puzzle #45", | "example": "WP #87, Kura Puzzle #45", | ||
"type": "string" | "type": "string", | ||
"aliases": [ | |||
"Wallpapers", | |||
"Menu" | |||
], | |||
"required": true | |||
}, | }, | ||
"Events": { | "Events": { | ||
"label": "Events", | "label": "Events", | ||
"description": "Events that you can encounter.", | "description": "Events that you can encounter in this location.", | ||
"type": "string" | "type": "string", | ||
"required": true | |||
}, | }, | ||
"NPCS": { | "NPCS": { | ||
"label": " | "label": "Notable NPCs", | ||
"description": " | "description": "Noteworthy NPCs that show up in this location.", | ||
"type": "string" | "type": "string", | ||
"required": true | |||
}, | }, | ||
"Connections": { | "Connections": { | ||
"label": " | "label": "Connecting Areas", | ||
"description": " | "description": "List of areas connected to this location (using the Connection template) as of the game's current version.", | ||
"type": "string" | "type": "string", | ||
"example": "{{Connection|Dream Pool|one_way_type=NoEntry}}", | |||
"required": true | |||
}, | }, | ||
"BGM": { | "BGM": { | ||
"label": "BGM", | "label": "BGM", | ||
"description": " | "description": "List of tracks (using the BGM template) that play in this location and/or specific rooms/maps within it.", | ||
"type": "string" | "type": "string", | ||
"example": "{{BGM|title=soto_C5|filename=Soto-C5.ogg|label=Glasses Path}}", | |||
"required": true | |||
}, | }, | ||
"Map ID": { | "Map ID": { | ||
"label": "Map ID", | "label": "Map ID", | ||
"description": " | "description": "List of IDs corresponding to the location's map and its sub-areas. Zero-padded, with four digits. Annotations may be added to each map ID using parentheses.", | ||
"example": "0002, 0003 (Sub-area)", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"VersionAdded": { | |||
"label": "Version Added", | |||
"description": "The version in which the area was first added.", | |||
"example": "0.114", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"VersionsUpdated": { | |||
"label": "Versions Updated", | |||
"description": "The version(s) in which the area has been updated. This should not include VersionAdded, VersionRemoved, or any removed versions in VersionGaps. Use commas to separate multiple instances. Versions may also be followed by a dash and a 1 or 2 character code; this is an update type identifier used by Yume 2kki Explorer, and these are automatically handled by the version manager in the app.", | |||
"example": "0.112, 0.112 patch 1, 0.112d", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"Primary": { | |||
"label": "Primary Author", | |||
"description": "The location's main author(s). Applicable to collaborative games.", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"Contributing": { | |||
"label": "Contributing Authors", | |||
"description": "Authors who have contributed to the location. Applicable to collaborative games.", | |||
"type": "string" | |||
}, | |||
"name": { | |||
"label": "Display Name", | |||
"description": "Overrides using the page name as the header text. If the name of the location should be changed on the wiki, move the page instead of using this parameter.", | |||
"type": "string", | |||
"autovalue": "{{PAGENAME}}" | |||
}, | |||
"headerfontsize": { | |||
"label": "Header font size", | |||
"description": "The header's font size as a percentage.", | |||
"type": "string", | |||
"default": "200%" | |||
}, | |||
"imagewidth": { | |||
"label": "Image width", | |||
"description": "The image width in px.", | |||
"type": "number", | |||
"default": "250" | |||
}, | |||
"caption": { | |||
"label": "Image caption", | |||
"description": "A corresponding caption for the image, visible if a value is provided.", | |||
"type": "string" | |||
}, | |||
"Masks": { | |||
"label": "Masks", | |||
"description": "Yume 2kki Masks available to equip in the location.", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "RemovedConnections": { | ||
"label": " | "label": "Removed Connections", | ||
"description": " | "description": "List of areas connected to this location (using the Connection template) that have since been removed. Be sure to include \"is_removed=true\" in each connection.", | ||
"type": "string", | |||
"example": "{{Connection|Digital Forest|is_removed=true}}" | |||
}, | |||
"Map Type": { | |||
"label": "Map Type", | |||
"description": "Descriptors for a given location, such as the overall map size and whether it loops or otherwise.", | |||
"example": "Small, Non-looping", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "VersionRemoved": { | ||
"label": " | "label": "Version Removed", | ||
"description": "The | "description": "The version in which the area was removed, if applicable.", | ||
"example": "0.115a", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "VersionGaps": { | ||
"label": " | "label": "Version Gaps", | ||
"description": " | "description": "Any gaps where the area was removed only to later be re-added, starting with the version it was removed, followed by a dash, followed by the version it was re-added in. Use commas to separate multiple instances.", | ||
"example": " | "example": "0.110b-0.110b patch 1,0.111-0.113a", | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
" | "format": "{{_\n|_ = _\n}}", | ||
"paramOrder": [ | "paramOrder": [ | ||
"headercolor", | "headercolor", | ||
"headerfontcolor", | "headerfontcolor", | ||
"image", | |||
"Name", | "Name", | ||
"JapaneseName", | "JapaneseName", | ||
"Effects", | "Effects", | ||
" | "Collectibles", | ||
"Events", | "Events", | ||
"NPCS", | "NPCS", | ||
Line 100: | Line 181: | ||
"BGM", | "BGM", | ||
"Map ID", | "Map ID", | ||
"VersionAdded", | |||
"VersionsUpdated", | |||
"Primary", | |||
"Contributing", | "Contributing", | ||
" | "name", | ||
"headerfontsize", | |||
"imagewidth", | |||
"caption", | |||
"Masks", | |||
"RemovedConnections", | |||
"Map Type", | |||
"VersionRemoved", | |||
"VersionGaps" | |||
] | ] | ||
} | } | ||
</templatedata> | </templatedata> | ||
==Semantic properties== | |||
This template exposes the following semantic properties. | |||
{| style="width: 100%;" cellspacing="0" cellpadding="4" class="wikitable" | |||
!style="text-align: center;"|Property name | |||
!style="text-align: center;"|Description | |||
!style="text-align: center;"|Data type | |||
!style="text-align: center;"|Cardinality | |||
|- | |||
|Has location image filename | |||
|The location image's filename. | |||
|Page | |||
|Single | |||
|- | |||
|Header font color | |||
|The color of the locationbox's header text. Used for location-based styling. | |||
|String | |||
|Single | |||
|- | |||
|Header background color | |||
|The color of the locationbox's header background. Used for location-based styling. | |||
|String | |||
|Single | |||
|- | |||
|Has location image | |||
|The path pointing to the location image. Used for external applications to refer to the image. | |||
|String | |||
|Single | |||
|- | |||
|Japanese name | |||
|The area's Japanese (or generally, native-language) name. Used for localization purposes. | |||
|String | |||
|Single | |||
|- | |||
|Version added | |||
|The version where the location was added. Primarily used with the Yume 2kki Explorer. | |||
|String | |||
|Single | |||
|- | |||
|Versions updated | |||
|The version(s) where the location was updated. Primarily used with the Yume 2kki Explorer. | |||
|String | |||
|Multiple | |||
|- | |||
|Version removed | |||
|The version where the location was removed. Primarily used with the Yume 2kki Explorer. | |||
|String | |||
|Single | |||
|- | |||
|Version gaps | |||
|The versions where the location was absent prior to its return. Primarily used with the Yume 2kki Explorer. | |||
|String | |||
|Multiple | |||
|- | |||
|Has map type | |||
|The properties describing a map's nature. | |||
|String | |||
|Multiple | |||
|- | |||
|Has primary author | |||
|The person(s) who created the location; this is applicable to collaborative fangame projects. | |||
|String | |||
|Multiple | |||
|- | |||
|Has contributing author | |||
|The person(s) contributing to the the development of the location; this is applicable to collaborative fangame projects. | |||
|String | |||
|Multiple | |||
|} | |||
==General usage== | ==General usage== | ||
< | <pre style="line-height:1.6;"> | ||
{{Locationbox | {{Locationbox | ||
|headercolor = # | |name = Volcanic Subterrain | ||
|headerfontcolor = # | |headercolor = #4a0400 | ||
|headerfontcolor = #ffa500 | |||
|image = volcanic_subterrain.png | |image = volcanic_subterrain.png | ||
| | |JapaneseName = 鍛冶場 | ||
| | |Name = ''Kajiba'', Foundry | ||
|Effects = None | |Effects = None | ||
|Wallpapers = None | |Wallpapers = None | ||
|Events = None | |Events = None | ||
|NPCS = None | |NPCS = None | ||
|Connections = | |Connections = {{Connection|Chemical Research Facility|one_way_type=NoEntry}} | ||
|BGM = bgm-e | |BGM = {{BGM|title=bgm-e|filename=Bgm-e.ogg|label=after lighting the foundry}} | ||
|Map ID = 1023}} | |Map ID = 1023 | ||
<noinclude>[[Category:Template documentation | |Primary = Ruri | ||
|Contributing = qxy | |||
|VersionAdded = 0.109h patch 4 | |||
|VersionRemoved = 0.112i | |||
}} | |||
</pre> | |||
will return: | |||
{{Locationbox | |||
|name = Volcanic Subterrain | |||
|headercolor = #4a0400 | |||
|headerfontcolor = #ffa500 | |||
|image = volcanic_subterrain.png | |||
|JapaneseName = 鍛冶場 | |||
|Name = ''Kajiba'', Foundry | |||
|Effects = None | |||
|Wallpapers = None | |||
|Events = None | |||
|NPCS = None | |||
|Connections = [[Yume 2kki:Chemical Research Facility|Chemical Research Facility]] <span title="Cannot be entered from this area" tabindex="0" style="font-size:125%; line-height:1em;">⛔</span> | |||
|BGM = {{BGM|title=bgm-e|filename=Bgm-e.ogg|label=after lighting the foundry}} | |||
|Map ID = 1023 | |||
|Primary = Ruri | |||
|Contributing = qxy | |||
|VersionAdded = 0.109h patch 4 | |||
|VersionRemoved = 0.112i | |||
}} | |||
<noinclude>__NOTOC__ [[Category:Template documentation]]</noinclude> | |||
<includeonly>__NOEDITSECTION__ | |||
[[Category:Wiki-dependent]] | |||
[[Category:Location templates]] | |||
[[Category:Infobox templates]] | |||
</includeonly> |
Revision as of 09:34, 29 July 2024
![]() |
This template automatically sets categories on pages. Please only use this template as intended. |
![]() |
This template automatically sets Semantic MediaWiki properties on pages. This may include creating subobjects. Please only use this template as intended. |
Displays an infobox containing a world's details.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Header color | headercolor | The header's background color.
| String | suggested |
Header font color | headerfontcolor | The header's text color.
| String | suggested |
Location image | image | The file name for the image to be displayed. It should properly represent the location.
| File | required |
Original Name(s) | Name | The area's original native-language names, along with any translations thereof, separated by commas. If the original name is Japanese and you specified it for "JapaneseName", do not repeat it here.
| String | suggested |
Japanese Name | JapaneseName | The area's original name in Japanese, if applicable. Only one value is accepted.
| String | optional |
Effects | Effects | Effects (or the game's equivalent) obtainable in this location.
| String | required |
Collectibles | Collectibles Wallpapers Menu | Collectibles that you can find in this location.
| String | required |
Events | Events | Events that you can encounter in this location. | String | required |
Notable NPCs | NPCS | Noteworthy NPCs that show up in this location. | String | required |
Connecting Areas | Connections | List of areas connected to this location (using the Connection template) as of the game's current version.
| String | required |
BGM | BGM | List of tracks (using the BGM template) that play in this location and/or specific rooms/maps within it.
| String | required |
Map ID | Map ID | List of IDs corresponding to the location's map and its sub-areas. Zero-padded, with four digits. Annotations may be added to each map ID using parentheses.
| String | required |
Version Added | VersionAdded | The version in which the area was first added.
| String | required |
Versions Updated | VersionsUpdated | The version(s) in which the area has been updated. This should not include VersionAdded, VersionRemoved, or any removed versions in VersionGaps. Use commas to separate multiple instances. Versions may also be followed by a dash and a 1 or 2 character code; this is an update type identifier used by Yume 2kki Explorer, and these are automatically handled by the version manager in the app.
| String | suggested |
Primary Author | Primary | The location's main author(s). Applicable to collaborative games. | String | suggested |
Contributing Authors | Contributing | Authors who have contributed to the location. Applicable to collaborative games. | String | optional |
Display Name | name | Overrides using the page name as the header text. If the name of the location should be changed on the wiki, move the page instead of using this parameter.
| String | optional |
Header font size | headerfontsize | The header's font size as a percentage.
| String | optional |
Image width | imagewidth | The image width in px.
| Number | optional |
Image caption | caption | A corresponding caption for the image, visible if a value is provided. | String | optional |
Masks | Masks | Yume 2kki Masks available to equip in the location. | String | optional |
Removed Connections | RemovedConnections | List of areas connected to this location (using the Connection template) that have since been removed. Be sure to include "is_removed=true" in each connection.
| String | optional |
Map Type | Map Type | Descriptors for a given location, such as the overall map size and whether it loops or otherwise.
| String | optional |
Version Removed | VersionRemoved | The version in which the area was removed, if applicable.
| String | optional |
Version Gaps | VersionGaps | Any gaps where the area was removed only to later be re-added, starting with the version it was removed, followed by a dash, followed by the version it was re-added in. Use commas to separate multiple instances.
| String | optional |
Semantic properties
This template exposes the following semantic properties.
Property name | Description | Data type | Cardinality |
---|---|---|---|
Has location image filename | The location image's filename. | Page | Single |
Header font color | The color of the locationbox's header text. Used for location-based styling. | String | Single |
Header background color | The color of the locationbox's header background. Used for location-based styling. | String | Single |
Has location image | The path pointing to the location image. Used for external applications to refer to the image. | String | Single |
Japanese name | The area's Japanese (or generally, native-language) name. Used for localization purposes. | String | Single |
Version added | The version where the location was added. Primarily used with the Yume 2kki Explorer. | String | Single |
Versions updated | The version(s) where the location was updated. Primarily used with the Yume 2kki Explorer. | String | Multiple |
Version removed | The version where the location was removed. Primarily used with the Yume 2kki Explorer. | String | Single |
Version gaps | The versions where the location was absent prior to its return. Primarily used with the Yume 2kki Explorer. | String | Multiple |
Has map type | The properties describing a map's nature. | String | Multiple |
Has primary author | The person(s) who created the location; this is applicable to collaborative fangame projects. | String | Multiple |
Has contributing author | The person(s) contributing to the the development of the location; this is applicable to collaborative fangame projects. | String | Multiple |
General usage
{{Locationbox |name = Volcanic Subterrain |headercolor = #4a0400 |headerfontcolor = #ffa500 |image = volcanic_subterrain.png |JapaneseName = 鍛冶場 |Name = ''Kajiba'', Foundry |Effects = None |Wallpapers = None |Events = None |NPCS = None |Connections = {{Connection|Chemical Research Facility|one_way_type=NoEntry}} |BGM = {{BGM|title=bgm-e|filename=Bgm-e.ogg|label=after lighting the foundry}} |Map ID = 1023 |Primary = Ruri |Contributing = qxy |VersionAdded = 0.109h patch 4 |VersionRemoved = 0.112i }}
will return:
Volcanic Subterrain | |
---|---|
![]() | |
Basic Info | |
Japanese Name(s) |
鍛冶場 |
Effects | None |
Events | None |
Notable NPCs | None |
Other | |
Connecting Areas | Chemical Research Facility ⛔ |
BGM | bgm-e (??%): after lighting the foundry |
Map ID | 1023 |
Version Added | 0.109h patch 4 |
Version Removed | 0.112i |
Primary Author | Ruri |
Contributing Author(s) | qxy |