Module:File/doc: Difference between revisions

Latest revision as of 16:31, 17 November 2022

This module is intended to be used on File info pages. It eases the addition of types and categorizes it accordingly, with multiple fallbacks.

This module is intended to be used only on File pages.

How to use

{{#invoke:file|main
|description = <Description of the file>
|type = <Type of file>
|source = <Source, origin, and/or author>
}}

All parameters are technically mandatory, but if any is not set (or empty), the file will be categorized under specific maintenance categories, where files without description, type or source can be tracked more easily.

main — the first parameter will always need to be main, otherwise the module invokation will fail.
description — a summary of what the file is about.
type — which type the file is about (it is not case sensitive):
- Official artwork: art, artwork, official artwork, official art
- Audio: audio, music, song, sound
- Box art: boxart, box art
- Chart or diagram: chart, diagram
- Fan Art: fanart
- Flag: flag
- Logo: logo, logotype, logomark, wordmark
- Map: map
- Photograph: photograph, photography, photo
- Scan: scan, magazine
- Screenshot: screenshot, printscreen, prtscr
- Sprite: sprite, spritesheet
- User images: user, user image, user img
- Vector: vector, svg
- Video: video, movie, film, short
- Wiki image: wiki
source — the source, origin, and/or author of the file.

File information

Description	This file is about butterflies or something.
Type	Scan
Source/author	Danny DeVito

@@ Line 14: / Line 14: @@
 All parameters are technically mandatory, but if any is not set (or empty), the file will be categorized under specific maintenance categories, where files without description, type or source can be tracked more easily.
-* <code>main</code> &mdash; '''the first parameter will always need to be''' <code>main</code>, otherwise the infobox invokation will fail.
+* <code>main</code> &mdash; '''the first parameter will always need to be''' <code>main</code>, otherwise the module invokation will fail.
 * <code>description</code> &mdash; a summary of what the file is about.
 * <code>type</code> &mdash; which type the file is about (it is not case sensitive):
-** Artwork: <code>art</code>, <code>artwork</code>
+** Official artwork: <code>art</code>, <code>artwork</code>, <code>official artwork</code>, <code>official art</code>
 ** Audio: <code>audio</code>, <code>music</code>, <code>song</code>, <code>sound</code>
 ** Box art: <code>boxart</code>, <code>box art</code>
+**Chart or diagram: <code>chart</code>, <code>diagram</code>
 ** Fan Art: <code>fanart</code>
 ** Flag: <code>flag</code>