Module:InfoboxImage/doc: Difference between revisions
Jump to navigation
Jump to search
m (1 revision imported) |
(→Examples: replace deprecated "Image:" with "File:"; fix example with param "title") |
||
| Line 14: | Line 14: | ||
|- | |- | ||
| size | | size | ||
| Size to display image. | | Size to display image, in pixels. Use is discouraged per [[WP:THUMBSIZE]]; see {{Para|upright}} below instead. | ||
|- | |- | ||
| maxsize | | maxsize | ||
| Line 59: | Line 59: | ||
==Parameters displayed in image syntax== | ==Parameters displayed in image syntax== | ||
All parameters: | All parameters: | ||
:<syntaxhighlight lang=" | :<syntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size={{{size}}} | maxsize={{{maxsize}}} | sizedefault={{{sizedefault}}} | upright={{{upright}}} | alt={{{alt}}} | title={{{title}}} | thumbtime={{{thumbtime}}} | link={{{link}}} | border=yes | center=yes | page={{{page}}} | class={{{class}}} }}</syntaxhighlight> | ||
:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size={{{size}}} | maxsize={{{maxsize}}} | sizedefault={{{sizedefault}}} | upright={{{upright}}} | alt={{{alt}}} | title={{{title}}} | thumbtime={{{thumbtime}}} | link={{{link}}} | border=yes | center=yes | page={{{page}}} | class={{{class}}}}}</code> | :<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size={{{size}}} | maxsize={{{maxsize}}} | sizedefault={{{sizedefault}}} | upright={{{upright}}} | alt={{{alt}}} | title={{{title}}} | thumbtime={{{thumbtime}}} | link={{{link}}} | border=yes | center=yes | page={{{page}}} | class={{{class}}}}}</code> | ||
When "size" and "maxsize" are defined, the smaller of the two is used (if "px" is omitted it will be added by the module): | When "size" and "maxsize" are defined, the smaller of the two is used (if "px" is omitted it will be added by the module): | ||
:<syntaxhighlight lang=" | :<syntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size=300px | maxsize=250px }}</syntaxhighlight> | ||
:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size=300px | maxsize=250px }}</code> | :<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size=300px | maxsize=250px }}</code> | ||
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" 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): | ||
:<syntaxhighlight lang=" | :<syntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | sizedefault=250px | maxsize=200px }}</syntaxhighlight> | ||
:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | sizedefault=250px | maxsize=200px }}</code> | :<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | sizedefault=250px | maxsize=200px }}</code> | ||
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): | 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): | ||
:<syntaxhighlight lang=" | :<syntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | maxsize=250px }}</syntaxhighlight> | ||
:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | maxsize=250px }}</code> | :<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | maxsize=250px }}</code> | ||
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: | 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: | ||
:<syntaxhighlight lang=" | :<syntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} }}</syntaxhighlight> | ||
:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} }}</code> | :<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} }}</code> | ||
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): | 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): | ||
:<syntaxhighlight lang=" | :<syntaxhighlight lang="wikitext" style="overflow:auto;">{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | upright = yes }}</syntaxhighlight> | ||
:<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | upright = yes }}</code> | :<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | upright = yes }}</code> | ||
When "alt" is used without "title", the alt text is also used as the title: | When "alt" is used without "title", the alt text is also used as the title: | ||
:<syntaxhighlight lang=" | :<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> | :<code>{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | alt = Alt text }}</code> | ||
| Line 89: | Line 89: | ||
==Sample usage== | ==Sample usage== | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="wikitext" style="overflow:auto;"> | ||
|image = {{#invoke:InfoboxImage|InfoboxImage|image={{{image|}}}|upright={{{image_upright|1}}}|alt={{{alt|}}}}} | |image = {{#invoke:InfoboxImage|InfoboxImage|image={{{image|}}}|upright={{{image_upright|1}}}|alt={{{alt|}}}}} | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 121: | Line 121: | ||
| {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px}} | | {{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px}} | ||
|- | |- | ||
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc| | | {{mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc|File:Abbey Rd Studios.jpg|200px}}}} | ||
| {{#invoke:InfoboxImage|InfoboxImage|image=[[ | | {{#invoke:InfoboxImage|InfoboxImage|image=[[File:Abbey Rd Studios.jpg|200px]]}} | ||
|- | |- | ||
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc| | | {{mlx|InfoboxImage|InfoboxImage|image{{=}}{{elc|File:Abbey Rd Studios.jpg|200px}}|title{{=}}Abbey Road!}} | ||
| {{#invoke:InfoboxImage|InfoboxImage|image=[[ | | {{#invoke:InfoboxImage|InfoboxImage|image=[[File:Abbey Rd Studios.jpg|200px]]|title=Abbey Road!}} | ||
|- | |- | ||
| {{mlx|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{{=}}250px|alt{{=}}The front stairs and door of Abbey Road Studios}} | ||
| Line 171: | Line 171: | ||
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}no such image|maxsize{{=}}100px|center{{=}}yes}}<!-- this issue sh'd be fixed somewhow--> | | {{mlx|InfoboxImage|InfoboxImage|image{{=}}no such image|maxsize{{=}}100px|center{{=}}yes}}<!-- this issue sh'd be fixed somewhow--> | ||
| {{#invoke:InfoboxImage|InfoboxImage|image=no such image|maxsize=100px|center=yes}} | | {{#invoke:InfoboxImage|InfoboxImage|image=no such image|maxsize=100px|center=yes}} | ||
|- | |||
| {{mlx|InfoboxImage|InfoboxImage|image{{=}}{{tji|Multiple image|width: 60|image1: Yellow card.svg|image2: Red card.svg}}}} | |||
| {{#invoke:InfoboxImage|InfoboxImage|image={{multiple image|width=50|image1=Yellow card.svg|image2=Red card.svg}}}} | |||
|} | |} | ||
Revision as of 17:43, 16 December 2023
| File:Ambox important.svg | This Lua module is used {{#if:|{{{1}}}|in system messages}}, and on approximately 4,470,000 pages, or roughly 47132% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
{{#if:{{#ifeq:doc|sandbox|1}}{{#ifeq:doc|doc|1}}||{{#switch:Lua error: First parameter must be one of edit, move, create, upload, undelete, autoreview.|sysop|templateeditor|interfaceadmin=|#default=}}}}
{{#ifeq:doc|doc|{{#if:|Template:Pp}}|{{#switch:
{{#if:
|
| {{#ifeq:Module|Module
| module
| other
}}
}}
| module =
{{#switch: protected
| pre-alpha | prealpha | pa = File:Ambox warning blue construction.svg | alpha | a = File:Alpha lowercase.svg | beta | b = File:Greek lc beta.svg | release | r | general | g = File:Green check.svg | protected | protect | p = [[File:{{#switch:Lua error in Module:Effective_protection_level at line 14: attempt to index local 'title' (a nil value).|autoconfirmed=Semi|extendedconfirmed=Extended|accountcreator|templateeditor=Template|#default=Full}}-protection-shackle.svg|40x40px|link=|alt=Protected]] | semiprotected | semiprotect | semi =File:Semi-protection-shackle.svg}} | {{#switch: protected
| pre-alpha | prealpha | pa = This module is rated as pre-alpha. It is unfinished, and may or may not be in active development. It should not be used from article namespace pages. Modules remain pre-alpha until the original editor (or someone who takes one over if it is abandoned for some time) is satisfied with the basic structure.{{#switch: doc|doc|sandbox= | {{#ifeq: | true | | }} }} | alpha | a = This module is rated as alpha. It is ready for third-party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome.{{#switch: doc|doc|sandbox= | {{#ifeq: | true | | }} }} | beta | b = This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected.{{#switch: doc|doc|sandbox= | {{#ifeq: | true | | }} }} | release | r | general | g = This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.{{#switch: doc|doc|sandbox= | {{#ifeq: | true | | }} }} | protected | protect | p = This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.{{#switch: doc|doc|sandbox= | {{#ifeq: | true | | }} }} | semiprotected | semiprotect | semi = This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is semi-protected from editing.{{#switch: doc|doc|sandbox= | {{#ifeq: | true | | }} }} | #default = Template:Error}} |
| other | #default = Template:Error }}}}
Overview
This module is used within infoboxes to process the image parameters and tidy up the formatting of the result.
Parameters
| 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 |{{SAFESUBST:#if:upright|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 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 § 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.
{{#ifeq:{{ safesubst:#if:
| {{ safesubst:#titleparts:{{ safesubst:#if:|{{{1}}}|Module:InfoboxImage/doc}}|1}}
| {{ safesubst:#if:|{{{1}}}|Module:InfoboxImage/doc}}
}}|Wikipedia:Template messages||{{#ifexpr:{{#if:Module|0|1}}+{{#ifeq:yes|yes|0|1}}
|{{#if:July 2016
|{{#ifexist:Category:Use dmy dates from July 2016
||}}
|[[Category:{{#if:
||Use dmy dates}}]]}}{{#if:
|[[Category:]]}}}}}}
Parameters displayed in image syntax
All parameters:
- <syntaxhighlight lang="wikitext" style="overflow:auto;">[[File:{{{image}}}|page={{{page}}}|{{{size}}}|center|alt={{{alt}}}|link={{{link}}}|border|upright={{{upright}}}|thumbtime={{{thumbtime}}}|class={{{class}}}|{{{title}}}]]</syntaxhighlight>
[[File:{{{image}}}|page={{{page}}}|{{{size}}}|center|alt={{{alt}}}|link={{{link}}}|border|upright={{{upright}}}|thumbtime={{{thumbtime}}}|class={{{class}}}|{{{title}}}]]
When "size" and "maxsize" are defined, the smaller of the two is used (if "px" is omitted it will be added by the module):
- <syntaxhighlight lang="wikitext" style="overflow:auto;">[[File:{{{image}}}|250px]]</syntaxhighlight>
[[File:{{{image}}}|250px]]
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):
- <syntaxhighlight lang="wikitext" style="overflow:auto;">[[File:{{{image}}}|250px]]</syntaxhighlight>
[[File:{{{image}}}|250px]]
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):
- <syntaxhighlight lang="wikitext" style="overflow:auto;">[[File:{{{image}}}|250px]]</syntaxhighlight>
[[File:{{{image}}}|250px]]
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:
- <syntaxhighlight lang="wikitext" style="overflow:auto;">[[File:{{{image}}}|frameless]]</syntaxhighlight>
[[File:{{{image}}}|frameless]]
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):
- <syntaxhighlight lang="wikitext" style="overflow:auto;">[[File:{{{image}}}|frameless|upright]]</syntaxhighlight>
[[File:{{{image}}}|frameless|upright]]
When "alt" is used without "title", the alt text is also used as the title:
- <syntaxhighlight lang="wikitext" style="overflow:auto;">[[File:{{{image}}}|frameless|alt=Alt text]]</syntaxhighlight>
[[File:{{{image}}}|frameless|alt=Alt text]]
For more information, see Wikipedia:Extended image syntax.
Sample usage
<syntaxhighlight lang="wikitext" style="overflow:auto;"> |image = </syntaxhighlight>
Examples
{{#invoke:InfoboxImage|InfoboxImage}}
|
||
{{#invoke:InfoboxImage|InfoboxImage|image=}}
|
||
|
|
File:Abbey Rd Studios.jpg | |
|
|
File:Abbey Rd Studios.jpg | |
|
|
File:Abbey Rd Studios.jpg | |
|
|
File:Abbey Rd Studios.jpg | |
{{#invoke:InfoboxImage|InfoboxImage|image= |
200px}}]]}} | File:Abbey Rd Studios.jpg |
{{#invoke:InfoboxImage|InfoboxImage|image= |
title=Abbey Road!}} | File:Abbey Rd Studios.jpg |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|sizedefault=250px|alt=The front stairs and door of Abbey Road Studios}}
|
File:Abbey Rd Studios.jpg | |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|sizedefault=250|alt=The front stairs and door of Abbey Road Studios}}
|
File:Abbey Rd Studios.jpg | |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|sizedefault=250px|alt=The front stairs and door of Abbey Road Studios}}
|
Exterior, front view of Abbey Road studios | |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|alt=The front stairs and door of Abbey Road Studios}}
|
File:Abbey Rd Studios.jpg | |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px|alt=The front stairs and door of Abbey Road Studios}}
|
File:Abbey Rd Studios.jpg | |
{{#invoke:InfoboxImage|InfoboxImage|image=Bandera de Bilbao.svg|size=100|border=yes}}
|
File:Bandera de Bilbao.svg | |
{{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg}}
|
||
{{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg}}
|
File:Image is needed male.svg | |
{{#invoke:InfoboxImage|InfoboxImage|image= |
200px}}]]}} | |
{{#invoke:InfoboxImage|InfoboxImage|image= |
suppressplaceholder=no}} | File:Image is needed male.svg |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|maxsize=100px}}
|
File:Abbey Rd Studios.jpg | |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|maxsize=100px}}
|
File:Abbey Rd Studios.jpg | |
{{#invoke:InfoboxImage|InfoboxImage|image= |
maxsize=100px}} | File:Abbey Rd Studios.jpg |
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|maxsize=100px|center=yes}}
|
||
{{#invoke:InfoboxImage|InfoboxImage|image=no such image|maxsize=100px|center=yes}}
|
||
{{#invoke:InfoboxImage|InfoboxImage|image={{#if:Multiple image|{{[[Template:{{#if:1|Multiple image}}|{{#if:1|Multiple image}}]]
|
Placeholder images which can be suppressed
.svg&action=edit&redlink=1){kind=link}
.svg&action=edit&redlink=1){kind=link}
.svg&action=edit&redlink=1){kind=link}
.svg&action=edit&redlink=1){kind=link}
.svg&action=edit&redlink=1){kind=link}
Tracking categories
Categories:
- Pages with script errors
- Pages with broken file links
- Pages used in system messages needing protection
- Modules in pre-alpha development
- Modules in alpha
- Modules in beta
- Modules for general use
- Modules subject to page protection
- Pages with templates in the wrong namespace
- Use dmy dates from July 2016
- Articles with invalid date parameter in template