(5 intermediate revisions by the same user not shown)
Line 1:
Line 1:
{{used in system}}
[[File:Abbey Rd Studios.jpg|thumb]]
{{Module rating|protected}}
The `Module:InfoboxImage` is a Lua module used in the MediaWiki software to handle the display and formatting of images within infoboxes on Wikipedia and other MediaWiki-based sites. This module is part of the larger effort to improve the functionality and maintainability of infoboxes by using Lua scripting, which offers more flexibility and efficiency compared to traditional wikitext templates.
==Overview==
== Overview ==
This module is used within infoboxes to process the image parameters and tidy up the formatting of the result.
==Parameters==
The `Module:InfoboxImage` is designed to simplify the process of adding images to infoboxes, which are summary tables typically found at the top of Wikipedia articles. Infoboxes provide a quick overview of key information about the subject of the article, and images are a crucial component of these infoboxes, offering visual context.
{| class="wikitable"
! Parameter
! Description
|-
| image
| Required. The main parameter that should be passed over which contains the image info.
|-
| size
| Size to display image, in pixels. Use is discouraged per [[WP:THUMBSIZE]]; see {{Para|upright}} below instead.
|-
| maxsize
| Maximum size to display image. Note: If no size or sizedefault params specified then image will be shown at maxsize.
|-
| sizedefault
| The size to use for the image if no size param is specified. Defaults to [[Wikipedia:Autosizing images|frameless]].
|-
| alt
| Alt text for the image.
|-
| title
| Title text for image (mouseover text).
|-
| border
| If yes, then a border is added.
|-
| page
| The page number to be displayed when using a multi-page image.
|-
| upright
| If upright=yes, adds "upright" which displays image at 75% of default image size (which is 220px if not changed at [[Special:Preferences]]). If a value, adds "upright=''value''" to image, where values less than 1 scale the image down (0.9 = 90%) and values greater than 1 scale the image up (1.15 = 115%).
|-
| center
| If yes, then the image is centered.
|-
| thumbtime
| thumbtime param, used for video clips.
|-
| suppressplaceholder
| If no, then will not suppress certain placeholder images. See {{section link||Placeholder images which can be suppressed}}.
|-
| link
| Page to go to when clicking on the image.
|-
| class
| HTML classes to add to the image.
|}
Note: If you specify the maxsize or sizedefault params, then you should include the px after the number.
=== Purpose ===
==Parameters displayed in image syntax==
The primary purpose of the `Module:InfoboxImage` is to:
3. '''Increase Flexibility''': Allow for more complex logic and customization in how images are displayed, including handling different image sizes, captions, and alignment options.
When "size" is not defined, "sizedefault" is used, even if larger than "maxsize" (in actual use "px" is required after the number; omitted here to show it is not added by the module):
When "size" and "sizedefault" are not defined, "maxsize" is used (in actual use "px" is required after the number; omitted here to show it is not added by the module):
The module provides several features that enhance the functionality of infobox images:
When "size", "sizedefault", and "maxsize" are not defined, "frameless" is added, which displays the image at the default thumbnail size (220px, but logged in users can change this at [[Special:Preferences]]) and is required if using "upright" to scale the default size:
* '''Automatic Resizing''': Automatically adjusts image sizes to fit within the constraints of the infobox, ensuring that images are neither too large nor too small.
* '''Alignment Options''': Offers options for aligning images within the infobox, such as left, right, or center alignment.
* '''Error Handling''': Includes mechanisms to handle errors gracefully, such as missing images or incorrect parameters, ensuring that the infobox remains functional even if the image cannot be displayed.
Use of "upright" without a number value, which displays the image at approximately 75% of the user's default size (multiplied by 0.75 then rounded to nearest 10):
When "alt" is used without "title", the alt text is also used as the title:
The `Module:InfoboxImage` is maintained by the Wikipedia community, with contributions from editors who have expertise in Lua scripting and template design. Changes to the module are typically discussed on its talk page, where editors can propose improvements, report bugs, and collaborate on enhancements.
:<syntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | alt = Alt text }}</syntaxhighlight>
:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | alt = Alt text }}</code>
For more information, see [[Wikipedia:Extended image syntax]].
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|sizedefault{{=}}250px|alt{{=}}The front stairs and door of Abbey Road Studios}}
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|sizedefault=250px|alt=The front stairs and door of Abbey Road Studios}}
|-
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|sizedefault{{=}}250|alt{{=}}The front stairs and door of Abbey Road Studios}}
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|sizedefault=250|alt=The front stairs and door of Abbey Road Studios}}
|-
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|sizedefault{{=}}250px|alt{{=}}The front stairs and door of Abbey Road Studios|title=Exterior, front view of Abbey Road studios}}
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|sizedefault=250px|alt=The front stairs and door of Abbey Road Studios|title=Exterior, front view of Abbey Road studios}}
|-
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|alt{{=}}The front stairs and door of Abbey Road Studios}}
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|alt=The front stairs and door of Abbey Road Studios}}
|-
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}Abbey Rd Studios.jpg|size{{=}}100px|alt{{=}}The front stairs and door of Abbey Road Studios}}
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px|alt=The front stairs and door of Abbey Road Studios}}
|-
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}Bandera de Bilbao.svg|size{{=}}100|border{{=}}yes}}
| {{#invoke:InfoboxImage|InfoboxImage|image=Bandera de Bilbao.svg|size=200|border=yes}}
|-
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}Image is needed male.svg}}
| {{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg}}
|-
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}Image is needed male.svg|suppressplaceholder=no}}
| {{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg|suppressplaceholder=no}}
|-
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc|File:Image is needed male.svg|200px}}}}
| {{#invoke:InfoboxImage|InfoboxImage|image=[[File:Image is needed male.svg|200px]]}}
|-
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc|File:Image is needed male.svg|200px}}|suppressplaceholder{{=}}no}}
| {{#invoke:InfoboxImage|InfoboxImage|image=[[File:Image is needed male.svg|200px]]|suppressplaceholder=no}}
* [[:File:Silver - replace this image female.svg]]
* [[:File:Silver - replace this image male.svg]]
* [[:File:Replace this image.svg]]
* [[:File:Cricket no pic.png]]
* [[:File:CarersLogo.gif]]
* [[:File:Diagram Needed.svg]]
* [[:File:Example.jpg]]
* [[:File:Image placeholder.png]]
* [[:File:No male portrait.svg]]
* [[:File:Nocover-upload.png]]
* [[:File:NoDVDcover copy.png]]
* [[:File:Noribbon.svg]]
* [[:File:No portrait-BFD-test.svg]]
* [[:File:Placeholder barnstar ribbon.png]]
* [[:File:Project Trains no image.png]]
* [[:File:Image-request.png]]
* [[:File:Sin bandera.svg]]
* [[:File:Sin escudo.svg]]
* [[:File:Replace this image - temple.png]]
* [[:File:Replace this image butterfly.png]]
* [[:File:Replace this image.svg]]
* [[:File:Replace this image1.svg]]
* [[:File:Resolution angle.png]]
* [[:File:Image-No portrait-text-BFD-test.svg]]
* [[:File:Insert image here.svg]]
* [[:File:No image available.png]]
* [[:File:NO IMAGE YET square.png]]
* [[:File:NO IMAGE YET.png]]
* [[:File:No Photo Available.svg]]
* [[:File:No Screenshot.svg]]
* [[:File:No-image-available.jpg]]
* [[:File:Null.png]]
* [[:File:PictureNeeded.gif]]
* [[:File:Place holder.jpg]]
* [[:File:Unbenannt.JPG]]
* [[:File:UploadACopyrightFreeImage.svg]]
* [[:File:UploadAnImage.gif]]
* [[:File:UploadAnImage.svg]]
* [[:File:UploadAnImageShort.svg]]
* [[:File:CarersLogo.gif]]
* [[:File:Diagram Needed.svg]]
* [[:File:No male portrait.svg]]
* [[:File:NoDVDcover copy.png]]
* [[:File:Placeholder barnstar ribbon.png]]
* [[:File:Project Trains no image.png]]
* [[:File:Image-request.png]]
{{div col end}}
== Tracking categories ==
* {{clc|Pages using infoboxes with thumbnail images}}
* {{clc|Pages using infoboxes with URL in image parameter}}
<includeonly>{{Sandbox other||
{{DEFAULTSORT:Image, {{PAGENAME}}}}
[[Category:Modules for image handling]]
[[Category:Modules that add a tracking category]]
[[Category:Infobox modules]]
}}</includeonly><noinclude>
[[Category:Module documentation pages]]
</noinclude>
Latest revision as of 00:26, 6 January 2025
The `Module:InfoboxImage` is a Lua module used in the MediaWiki software to handle the display and formatting of images within infoboxes on Wikipedia and other MediaWiki-based sites. This module is part of the larger effort to improve the functionality and maintainability of infoboxes by using Lua scripting, which offers more flexibility and efficiency compared to traditional wikitext templates.
The `Module:InfoboxImage` is designed to simplify the process of adding images to infoboxes, which are summary tables typically found at the top of Wikipedia articles. Infoboxes provide a quick overview of key information about the subject of the article, and images are a crucial component of these infoboxes, offering visual context.
The primary purpose of the `Module:InfoboxImage` is to:
1. Standardize Image Display: Ensure that images in infoboxes are displayed consistently across different articles.
2. Enhance Performance: Use Lua scripting to improve the performance of image rendering compared to traditional template-based methods.
3. Increase Flexibility: Allow for more complex logic and customization in how images are displayed, including handling different image sizes, captions, and alignment options.
The module provides several features that enhance the functionality of infobox images:
Automatic Resizing: Automatically adjusts image sizes to fit within the constraints of the infobox, ensuring that images are neither too large nor too small.
Caption Support: Allows for the inclusion of captions beneath images, providing additional context or information about the image.
Alignment Options: Offers options for aligning images within the infobox, such as left, right, or center alignment.
Error Handling: Includes mechanisms to handle errors gracefully, such as missing images or incorrect parameters, ensuring that the infobox remains functional even if the image cannot be displayed.
The `Module:InfoboxImage` is maintained by the Wikipedia community, with contributions from editors who have expertise in Lua scripting and template design. Changes to the module are typically discussed on its talk page, where editors can propose improvements, report bugs, and collaborate on enhancements.
