×
Create a new article
Write your page title here:
We currently have 3,033 articles on YumeWiki. Type your article name above or click on one of the titles below and start writing!



YumeWiki
YumeWiki
3,033Articles
in:
Template documentation

Template:Infobox file/doc: Difference between revisions

(create rough doc (needs update))
 
m (ZASNK moved page Template:Infobox image/doc to Template:Infobox file/doc: old name became inaccurate)
 
(7 intermediate revisions by the same user not shown)
Line 3: Line 3:


==Syntax==
==Syntax==
With comments:
''TBA''
<pre><nowiki>{{Infobox image
 
|Wiki =
|Type = <!--choose one of: screenshot, map, character, gamefile, art, other-->
|EditType = <!--use any of: annotated, clarity, layout, recreation-->
|Edits = <!--Explain edits here, if necessary-->
|OldVersion = <!--if old content, which version does it show?-->
|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?-->
}}</nowiki></pre>
Without comments:
<pre><nowiki>{{Infobox image
|Wiki =
|Type =
|EditType =
|Edits =
|OldVersion =
|Unused =
|GameFileType =
|GameFileName =
}}</nowiki></pre>
==Usage==
==Usage==
<!--How to use. Attempt to answer:
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 built to work with [[Form:File]].
- What does it present to the reader?
- Why would an editor choose to use it?
- What is the recommended use?
- What does the template require in order to function?
- What can the template NOT do? (limitations)
- What are some potential issues that should be kept in mind? (troubleshooting)
It may be helpful to give examples in this section instead of waiting until "Sample".-->
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.


{| class="wikitable" style="width:100%"
''TBA''
|+Defines Categories
!style="width:25%"|Type
!style="width:25%"|Category
!style="width:25%"|If Unused
!style="width:25%"|If Old Version
|-
|Screenshot
|% Screenshots
|style="background-color:#cdcdcd"|
|% 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
|-
|colspan="4" style="text-align:center; background-color:#eaecf0;"|'''Special Cases'''
|-
|Art
|% Official Art
|colspan="3" style="text-align:center;"|''If EditType includes "recreation":'' % Art
|-
|Other
|colspan="3" style="text-align:center;"|''Always:'' % Other Images
|}


==Parameters==
==Parameters==
<templatedata> {"description": "The template parameters are unfinished and need updating.","params": {
''TBA''
"Wiki": {
 
"label": "Intended Game/Wiki",
<!--
<templatedata> {"description": "","params": {
"sortkey": {
"label": "Intended Game/Topic",
"type": "string",
"type": "string",
"description": "Explanation",
"description": "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).",
"example": "Example_Input",
"example": "Dotflow",
"default": "Default_If_Static",
"required": true
"required": true
},
},
Line 87: Line 26:
"type": "string",
"type": "string",
"suggestedvalues": ["screenshot","map","character","gamefile","art","other"],
"suggestedvalues": ["screenshot","map","character","gamefile","art","other"],
"description": "Explanation",
"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_Input",
"example": "map",
"required": true
"required": true
},
},
Line 98: Line 37:
"default": "false"
"default": "false"
},
},
"OldVersion": {
"VersionRemoved": {
"label": "Outdated Game Version",
"label": "Version Removed",
"type": "string",
"type": "string",
"description": "If the image showcases something from an older game version, provide the latest version in which it still appears as displayed in the image.",
"description": "If the image showcases something from an older game version, provide the version in which it was made unavailable.",
"example": "0.112a"
"example": "0.112a"
},
},
Line 108: Line 47:
"type": "string",
"type": "string",
"suggestedvalues": ["annotated","clarity","layout","recreation"],
"suggestedvalues": ["annotated","clarity","layout","recreation"],
"description": "Explanation",
"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_Input"
"example": "annotated, layout",
"suggested": true
},
},
"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-language game copy.",
"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 122: Line 62:
"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_Input"
"example": "Picture"
},
},
"Edits": {
"Edits": {
"label": "Fancy_Name",
"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.",
"example": "The background panorama of this world was replaced with a static color to make the pathways easier to see. The path to [[Example:Character|Character]]'s room is outlined using a green line.",
"example": "The background panorama of this world was replaced with a static color to make the pathways easier to see. The path to [[Example:Character|Character]]'s room is outlined using a green line."
"suggested": true
}
}
},
},
"paramOrder": [
"paramOrder": [
"Wiki",
"Game",
"Type",
"Type",
"EditType",
"EditType",
"Edits",
"Edits",
"Unused",
"Unused",
"OldVersion",
"VersionRemoved",
"GameFileName",
"GameFileName",
"GameFileType"
"GameFileType"
Line 145: Line 84:
}
}
</templatedata>
</templatedata>
==Sample== <!-- I need a better example. -->
Remove comment after finishing templatedata-->
==Sample==
If you had this image:
If you had this image:


[[File:Mall.png|border|300px]]
[[File:YN Mall.png|border|300px]]


The following input...
The following input...
<pre><nowiki>{{Infobox image
<pre>
|Wiki = Yume Nikki
TBA
|Type = screenshot
</pre>
|EditType =
|Edits =
|OldVersion =
|Unused =
|GameFileType =
|GameFileName =
}}</nowiki></pre>
...would present this:
...would present this:


{| class="wikitable" style="width:min(700px, 100%)"
''TBA'' <!-- subst -->
|+Image Info
 
! style="width:49.5%;"|
<noinclude>__NOTOC__ [[Category:Template documentation]]</noinclude>
! style="width:50.5%;"|
<includeonly>__NOEDITSECTION__
|-
[[Category:Infobox templates|Image]]
|{{#ifexpr:{{NAMESPACENUMBER:Yume Nikki:Yume Nikki Wiki}} > 2999|Game|Wiki}}
</includeonly>
|{{#if:Yume Nikki|[[:Category:Yume Nikki Images|Yume Nikki]]|Unknown}}
|-
|Type
|{{#ifeq:{{lc:screenshot}}|map|[[Category:Yume Nikki {{#ifeq:|true|Unused|{{#if:|Old Version}}}} Maps]][[:Category:Yume Nikki {{#ifeq:|true|Unused|{{#if:|Old Version}}}} Maps|{{#ifeq:|true|Unused|{{#if:|Outdated}}}} Location Map]]{{#if:{{#pos:|nnotated}}|[[Category:Yume Nikki {{#ifeq:|true|Unused|{{#if:|Old Version}}}} Annotated Maps]]}}}}{{#ifeq:{{lc:screenshot}}|gamefile|[[Category:Yume Nikki {{#ifeq:|true|Unused|{{#if:|Old Version}}}} Game Files]][[:Category:Yume Nikki {{#ifeq:|true|Unused|{{#if:|Old Version}}}} Game Files|{{#ifeq:|true|Unused|{{#if:|Outdated}}}} Game File]]
{{!}}-
{{!}}Original Filename
{{!}}{{#if:||Unknown}}
{{!}}-
{{!}}Folder
{{!}}{{#if:|[[Category:Yume Nikki  Files]][[:Category:Yume Nikki  Files]]|Unspecified}}}}{{#ifeq:{{lc:screenshot}}|character|[[Category:Yume Nikki {{#ifeq:|true|Unused|{{#if:|Old Version}}}} Character Images]][[:Category:Yume Nikki {{#ifeq:|true|Unused|{{#if:|Old Version}}}} Character Images|{{#ifeq:|true|Unused|{{#if:|Old Version}}}} Character Sprite]]}}{{#ifeq:{{lc:screenshot}}|art|[[Category:Yume Nikki {{#if:{{#pos:|ecreation}}||Official}} Art]][[:Category:Yume Nikki {{#if:{{#pos:|ecreation}}||Official}} Art|{{#if:{{#pos:|ecreation}}|Fan-made|Official}} Art]]}}{{#if:{{#pos:screenshot|shot}}|[[Category:Yume Nikki {{#if:|Old Version}} Screenshots]][[:Category:Yume Nikki {{#if:|Old Version}} Screenshots|{{#if:|Outdated}} In-game Screenshot]]}}{{#ifeq:{{lc:screenshot}}|other|[[Category:Yume Nikki Other Images]][[:Category:Yume Nikki Other Images]]}}
|-
{{#if:|{{!}}Version Shown
{{!}}
{{!}}-
{{!}}}}{{#if:|colspan="2" style="text-align:center; background-color:#eaecf0;"{{!}}Edits
{{!}}-
{{#ifeq:{{lc:screenshot}}|map|
{{!}}Annotated
{{!}}{{#if:{{#pos:|nnotated}}|Yes|No}}
{{!}}-
{{!}}Improved Clarity
{{!}}{{#if:{{#pos:|larity}}|Yes|No}}
{{!}}-
{{!}}Changed Layout
{{!}}{{#if:{{#pos:|ayout}}|Yes|No}}
{{!}}-
{{!}}Explanation
{{!}}|{{!}}colspan="2"{{!}}}}{{#if:||No explanation was provided by the uploader.}}}}
{{#ifeq:|true|{{!}}-
{{!}} colspan="2" style="text-align:center;"{{!}}This image showcases unused content that does not appear in-game in any version.}}
|}
<noinclude>__NOTOC__ [[Category:Template Documentation]]</noinclude>
<includeonly>__NOEDITSECTION__</includeonly>

Latest revision as of 05:40, 21 August 2024

Description

Showcases information of images in the File namespace and categorizes the file pages based on provided info.

Syntax

TBA

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 built to work with Form:File.

TBA

Parameters

TBA

Sample

If you had this image:

YN Mall.png

The following input... 

TBA

...would present this:

TBA

Retrieved from "https://yume.wiki/index.php?title=Template:Infobox_file/doc&oldid=488970"