Instructions for {{Infobox image}}
== Usage ==
Infobox image exists to enforce a single width for infobox images. It allows us to keep that width in one place so that if we find we need to change the width at a later day — as happens when Fandom suddenly drops a new layout on us — we can do so with a single edit that takes effect wiki-wide.
This template depends upon people defining images without the use of [[File:]] or [[Image:]] syntax. As a result, this template will not be fully operational without bot removal of that syntax, wiki-wide, or some additional programming by which this template ignores [[File:]] and [[Image:]].
This template makes use of the following parameters:
- img1/img2
- Image filenames, omitting the File: prefix. The first is mandatory in all cases. The second is optional - if used, it will lead to both images being displayed side by side.
- alt1/alt2
- Descriptions for both images. While strictly optional, it is considered good style to always add a short text for any image used. This text will be considered the "alternative" to the image - it will be displayed if the image can't be shown. This alternative should actually describe the image in detail, as it is also used by people with visual impairment. This text will not be displayed as a subtitle to the image. If such is considered necessary in a specific sidebar, it should be added via that sidebar template.
- cap1/cap2
- Titles of both images. These will be shown as "mouseover" tooltips.
- size
- This needs to be used only when trying to display two images, and determines the width of the left image. It can be used to tune the relative heights of the two images. It is an optional parameter, defaulting to half of the allowed width.
- format
- Currently, this parameter has only one allowed value, "halfwidth". If used, it will lead to the single image being displayed smaller.