Template:Image classification/doc: Difference between revisions

From Ring of Brodgar
Jump to navigation Jump to search
(TemplateData test.)
("Info" class update -- (Switching "Img-Graph" to "Img-Info").)
 
(7 intermediate revisions by 2 users not shown)
Line 6: Line 6:


;Syntax
;Syntax
:To use the template, type <code>{{t|image_classification|<classification1, classification2, ...>}}</code>.
:To use the template, type <code>{{t|image_classification|<classification1, classification2, ...>}}</code> and place it at the top of the content-page.
:To classify some image as a "Inventory-item image" and a "Resource pulled image" it becomes <code>{{t|image_classification| Inv-Obj, Res-Img}}</code>.
:To classify some image as a "''Inventory-item image''" and a "''Resource pulled image''" it becomes <code>{{t|image_classification| Inv-Obj, Res-Img}}</code>.
:Unknown class-names are ignored. (''no error is triggered in such a case''.)
:Unknown class-names are ignored. (''no error is triggered in such a case''.)
:Class-names are '''not''' case sensitive.


;Classifcation key-words
;Classification names.
:(''This part is still a work in progress. So changes are to be expected''.)
:(''This part is still a work in progress. So changes are to be expected''.)
{| class="wikitable"
{| class="wikitable"
! Class || Description
! Class || Description
|-
|-
| Unclassified || The default classification if no classification(s) where given.<br>Can also be specified. But other classifications will be ignored in that case.
| <b><i>Unclassified<i></b> || The default classification if no classification is given.<br>Can also be specified as classification. But other classifications will be ignored in that case.
|-
|-
| Legacy || For Legacy images. Acts similar to ''Unclassified''.<br
| <b>Legacy</b> || For Legacy images. Acts similar to ''Unclassified''.<br
>ie: Other classifications will be ignore if used. (overruled by ''Unclassified'')
>ie: Other classifications will be ignore if used. (Overruled by <b><i>Unclassified<i></b>)
|-
|-
| colspan=2 |
| colspan=2 |
----
----
|-
|-
| Graph || Flow charts, Graphs, Data tables, etc.
| colspan=2 | The following Class-names are mutual exclusive.<br>''Currently collision cases are displayed in red (debug output)''.
|-
|-
| Inv-Obj || Inventory-item image (not seen as object)
| <b>Info</b> || Images with additional information. Flow charts, Graphs, Plots, Data tables, Game-Gui images, ... including Object mages with additional info.
|-
|-
| Obj-Img || Specific to a given object (no additional added info)
| <b>Inv-Obj</b> || Inventory-item image.<br>(''Used Item-definition: Stuff that can be placed inside the character's inventory.'')
|-
|-
| Obj-Info || Specific to a given object. (with additional added info)
| <b>Obj-Img</b> || Specific to a given object, without additional added info in image.<br>(''Used Object-definition: Stuff that is not an Item.'')
|-
|-
| Game-Scene || General scene not specific to a given object ...
| <b>Icon-Other</b> || Other in-game icon images. Build/craft, Experience, Skills, Credo, ...
|-
|-
| Res-Img || True copy of some image pulled from a game-resource file.<br
| <b>Game-Scene</b> || General scene not specific(visual) to a given object ...
>Currently the only one where it makes sense to use it with some other classification.<br
|-
>(''Not available with Legacy classification though''. ...)
| <b>Character</b> || Just about anything that has a sufficiently present dressed-character.
|-
| <b>Texture</b> || Stuff like Mini-map terrain tiles, pavement tiles, ... including texture related images/sets.
|-
| colspan=2 |
----
|-
| <b>Res-Img</b> || True copy of some image pulled from a game-resource file.<br
>(<i>Not available with </i><b>Legacy</b><i> classification<i>. ...)
|-
| <b>Res-Img-HR</b> || For res-pulled image that are in new high-resolution format (new or redrawn).<br
>(<i>Implies </i><b>Res-Img</b><i>, so no need to specify both.</i>)
|}
|}


<includeonly>[[Category:Category templates|{{PAGENAME}}]]</includeonly>
<includeonly>[[Category:Category templates|{{PAGENAME}}]]</includeonly>
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
----
<templatedata>
<templatedata>
{
{
"description": "",
"description": "Image classification",
"format": "{{_|_= _}}\n",
"format": "{{_|_= _}}\n",
"params": {
"params": {
Line 49: Line 62:
"description": "Classifications",
"description": "Classifications",
"type": "line",
"type": "line",
"suggestedvalues": ["aaa","bbb","ccc"]
"suggestedvalues": [
}
"Inv-Obj",
"Inv-Obj, Res-Img(-HR)",
"Obj-Img",
"Obj-Img, Res-Img(-HR)",
"Icon-Other, Res-Img(-HR)",
"Icon-Other",
"Game-Scene",
"Character",
"Texture",
"Info",
"Legacy",
"Unclassified"
]
}
}
}
}</templatedata>
}</templatedata>
<includeonly>[[Category:TemplateData templates|{{PAGENAME}}]]</includeonly>
<includeonly>[[Category:TemplateData templates|{{PAGENAME}}]]</includeonly>

Latest revision as of 17:17, 20 August 2023

Description
This template is used in "Files:" pages to add some classifications to an image.
By default it always adds the images to the general Images Category.
If no classification is given (ie:left empty) it will also add the image to the Img-Unclassified Category.
All image classification-categories can be found in the Image_Types Category.
Syntax
To use the template, type {{image_classification|<classification1, classification2, ...>}} and place it at the top of the content-page.
To classify some image as a "Inventory-item image" and a "Resource pulled image" it becomes {{image_classification| Inv-Obj, Res-Img}}.
Unknown class-names are ignored. (no error is triggered in such a case.)
Class-names are not case sensitive.
Classification names.
(This part is still a work in progress. So changes are to be expected.)
Class Description
Unclassified The default classification if no classification is given.
Can also be specified as classification. But other classifications will be ignored in that case.
Legacy For Legacy images. Acts similar to Unclassified.
ie: Other classifications will be ignore if used. (Overruled by Unclassified)

The following Class-names are mutual exclusive.
Currently collision cases are displayed in red (debug output).
Info Images with additional information. Flow charts, Graphs, Plots, Data tables, Game-Gui images, ... including Object mages with additional info.
Inv-Obj Inventory-item image.
(Used Item-definition: Stuff that can be placed inside the character's inventory.)
Obj-Img Specific to a given object, without additional added info in image.
(Used Object-definition: Stuff that is not an Item.)
Icon-Other Other in-game icon images. Build/craft, Experience, Skills, Credo, ...
Game-Scene General scene not specific(visual) to a given object ...
Character Just about anything that has a sufficiently present dressed-character.
Texture Stuff like Mini-map terrain tiles, pavement tiles, ... including texture related images/sets.

Res-Img True copy of some image pulled from a game-resource file.
(Not available with Legacy classification. ...)
Res-Img-HR For res-pulled image that are in new high-resolution format (new or redrawn).
(Implies Res-Img, so no need to specify both.)

Image classification

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Label11

Classifications

Suggested values
Inv-Obj Inv-Obj, Res-Img(-HR) Obj-Img Obj-Img, Res-Img(-HR) Icon-Other, Res-Img(-HR) Icon-Other Game-Scene Character Texture Info Legacy Unclassified
Lineoptional