m (update to new param names) |
m (add more info and finish parameters) |
||
Line 26: | Line 26: | ||
}}</nowiki></pre> | }}</nowiki></pre> | ||
==Usage== | ==Usage== | ||
The purpose of this template is to automatically categorize image files on the wiki. This allows the category names to be changed more easily in the future, or for the structure to be made more specific or general depending on needs. Instead of changing every file page with a command, the template can be changed to use different category names. It is also more visually appealing and intuitive to visitors of the file page. | The purpose of this template is to automatically categorize image files on the wiki. This allows the category names to be changed more easily in the future, or for the structure to be made more specific or general depending on needs. Instead of changing every file page with a command, the template can be changed to use different category names. It is also more visually appealing and intuitive to visitors of the file page. | ||
Line 72: | Line 64: | ||
|colspan="3" style="text-align:center;"|''Always:'' % Other Images | |colspan="3" style="text-align:center;"|''Always:'' % Other Images | ||
|} | |} | ||
The ''edit types'' that may be used to describe an image are defined as followed: | |||
*'''Annotated:''' Labels, circles, arrows, guiding lines, markers | |||
*'''Clarity:''' Increased brightness, altered colours/saturation, changed background | |||
*'''Layout:''' For maps where different parts are moved around to make paths more clear, or when multiple areas are combined to create one large map image | |||
*'''Recreation:''' Recreations of other images, such as [[:File:Mall_Poster_1.png|art]] and [[:File:001RECONSTRUCTION.png|maps]] | |||
==Parameters== | ==Parameters== | ||
<templatedata> {"description": " | <templatedata> {"description": "","params": { | ||
"Game": { | "Game": { | ||
"label": "Intended Game/Topic", | "label": "Intended Game/Topic", | ||
Line 86: | Line 82: | ||
"type": "string", | "type": "string", | ||
"suggestedvalues": ["screenshot","map","character","gamefile","art","other"], | "suggestedvalues": ["screenshot","map","character","gamefile","art","other"], | ||
"description": " | "description": "The type of image. Screenshots are from normal gameplay, maps are the full worlds, character is for NPC sprites and events, gamefile is self-explanatory, art is for any official or fanmade art of maps and characters, and finally other is for anything else.", | ||
"example": " | "example": "map", | ||
"required": true | "required": true | ||
}, | }, | ||
Line 107: | Line 103: | ||
"type": "string", | "type": "string", | ||
"suggestedvalues": ["annotated","clarity","layout","recreation"], | "suggestedvalues": ["annotated","clarity","layout","recreation"], | ||
"description": " | "description": "What kind of edits were made to the image if any. Use the list under the Usage section of the documentation if unsure of what fits.", | ||
"example": " | "example": "annotated, layout" | ||
}, | }, | ||
"GameFileName": { | "GameFileName": { | ||
"label": "Name in Game Files", | "label": "Name in Game Files", | ||
"type": "string", | "type": "string", | ||
"description": "If Type is 'gamefile', provide the original filename as read from the game files of the original | "description": "If Type is 'gamefile', provide the original filename as read from the game files of the (original language) game copy.", | ||
"example": "【FC】主人公_A003.xyz" | "example": "【FC】主人公_A003.xyz" | ||
}, | }, | ||
Line 121: | Line 117: | ||
"suggestedvalues": ["ChipSet","CharSet","Panorama","Picture","FaceSet","Battle","System","Title"], | "suggestedvalues": ["ChipSet","CharSet","Panorama","Picture","FaceSet","Battle","System","Title"], | ||
"description": "If Type is 'gamefile', provide the folder the game file is found in.", | "description": "If Type is 'gamefile', provide the folder the game file is found in.", | ||
"example": " | "example": "Picture" | ||
}, | }, | ||
"Edits": { | "Edits": { | ||
"label": " | "label": "Edits", | ||
"type": "content", | "type": "content", | ||
"description": "If the image is edited in any way, please explain how it is edited and why the edits were made.", | "description": "If the image is edited in any way, please explain how it is edited and why the edits were made.", |
Revision as of 01:14, 4 October 2023
Description
Showcases information of images in the File namespace and categorizes the file pages based on provided info.
Syntax
With comments:
{{Infobox image |Game = |Type = <!--choose one of: screenshot, map, character, gamefile, art, other--> |EditType = <!--use any of: annotated, clarity, layout, recreation--> |Edits = <!--Explain edits here, if necessary--> |VersionRemoved = <!--if old content, whhen was it removed?--> |Unused = <!--set to "true" if the thing was never even used--> |GameFileType = <!--use any of: ChipSet, CharSet, Panorama, Picture--> |GameFileName = <!--if a file from the game's folder, what is it actually named?--> }}
Without comments:
{{Infobox image |Game = |Type = |EditType = |Edits = |VersionRemoved = |Unused = |GameFileType = |GameFileName = }}
Usage
The purpose of this template is to automatically categorize image files on the wiki. This allows the category names to be changed more easily in the future, or for the structure to be made more specific or general depending on needs. Instead of changing every file page with a command, the template can be changed to use different category names. It is also more visually appealing and intuitive to visitors of the file page.
Type | Category | If Unused | If Old Version | |
---|---|---|---|---|
Screenshot | % Screenshots | % Old Version Screenshots | ||
Map | % Maps | % Unused Maps | % Old Version Maps | |
Character | % Character Images | % Unused Character Images | % Old Version Character Images | |
Gamefile | % Game Files | % Unused Game Files | % Old Version Game Files | |
Special Cases | ||||
Art | % Official Art | If EditType includes "recreation": % Art | ||
Other | Always: % Other Images |
The edit types that may be used to describe an image are defined as followed:
- Annotated: Labels, circles, arrows, guiding lines, markers
- Clarity: Increased brightness, altered colours/saturation, changed background
- Layout: For maps where different parts are moved around to make paths more clear, or when multiple areas are combined to create one large map image
- Recreation: Recreations of other images, such as art and maps
Parameters
Parameter | Description | Type | Status | |
---|---|---|---|---|
Intended Game/Topic | Game | The name of the game the image is from or about. Use the name exactly as it is written for the YumeWiki namespace, or as the page name (English text only).
| String | required |
Image Type | Type | The type of image. Screenshots are from normal gameplay, maps are the full worlds, character is for NPC sprites and events, gamefile is self-explanatory, art is for any official or fanmade art of maps and characters, and finally other is for anything else.
| String | required |
Edit Type | EditType | What kind of edits were made to the image if any. Use the list under the Usage section of the documentation if unsure of what fits.
| String | optional |
Edits | Edits | If the image is edited in any way, please explain how it is edited and why the edits were made.
| Content | suggested |
Unused Image | Unused | If the image is completely unused in every game version.
| Boolean | optional |
Version Removed | VersionRemoved | If the image showcases something from an older game version, provide the version in which it was made unavailable.
| String | optional |
Name in Game Files | GameFileName | If Type is 'gamefile', provide the original filename as read from the game files of the (original language) game copy.
| String | optional |
Game Folder | GameFileType | If Type is 'gamefile', provide the folder the game file is found in.
| String | optional |
Sample
If you had this image:
The following input...
{{Infobox image |Game = Yume Nikki |Type = screenshot |EditType = |Edits = |VersionRemoved = |Unused = |GameFileType = |GameFileName = }}
...would present this:
Game | Yume Nikki |
Type | In-game Screenshot |