Module:InfoboxImage
- Afrikaans
- ak:Module:InfoboxImage
- Алтай тил
- አማርኛ
- Anarâškielâ
- Аԥсшәа
- العربية
- অসমীয়া
- Asturianu
- Авар
- Azərbaycanca
- تۆرکجه
- Basa Bali
- বাংলা
- 閩南語 / Bân-lâm-gí
- Basa Banyumasan
- Башҡортса
- Беларуская
- Беларуская (тарашкевіца)
- भोजपुरी
- Bikol Central
- Български
- Bosanski
- Буряад
- Català
- Чӑвашла
- Cebuano
- Chamoru
- Chavacano de Zamboanga
- Chi-Chewa
- ChiShona
- ChiTumbuka
- Cymraeg
- Dansk
- الدارجة
- Deutsch
- Dolnoserbski
- डोटेली
- Eesti
- Ελληνικά
- Español
- Esperanto
- Euskara
- فارسی
- Fiji Hindi
- Føroyskt
- Furlan
- Gaeilge
- Galego
- ГӀалгӀай
- Gĩkũyũ
- گیلکی
- ગુજરાતી
- गोंयची कोंकणी / Gõychi Konknni
- 客家語 / Hak-kâ-ngî
- Хальмг
- 한국어
- Hausa
- Hawaiʻi
- Հայերեն
- हिन्दी
- Hornjoserbsce
- Hrvatski
- Bahasa Hulontalo
- Ilokano
- বিষ্ণুপ্রিয়া মণিপুরী
- Bahasa Indonesia
- Ирон
- IsiXhosa
- IsiZulu
- Íslenska
- Italiano
- עברית
- Jawa
- ಕನ್ನಡ
- ქართული
- Қазақша
- Ikinyarwanda
- Ikirundi
- Kongo
- Kreyòl ayisyen
- Kurdî
- Кыргызча
- Ladin
- Ladino
- ລາວ
- Latgaļu
- Latviešu
- Lëtzebuergesch
- Lietuvių
- Li Niha
- Ligure
- Lingua Franca Nova
- Luganda
- Magyar
- Madhurâ
- मैथिली
- Македонски
- Malagasy
- മലയാളം
- Māori
- मराठी
- მარგალური
- مصرى
- ဘာသာမန်
- مازِرونی
- Bahasa Melayu
- Mfantse
- Minangkabau
- 閩東語 / Mìng-dĕ̤ng-ngṳ̄
- Mirandés
- Мокшень
- Монгол
- မြန်မာဘာသာ
- Na Vosa Vakaviti
- Nederlands
- नेपाली
- 日本語
- Napulitano
- Нохчийн
- Nordfriisk
- Norsk bokmål
- Norsk nynorsk
- Occitan
- ଓଡ଼ିଆ
- Oʻzbekcha / ўзбекча
- ਪੰਜਾਬੀ
- Pangasinan
- Pangcah
- ပအိုဝ်ႏဘာႏသာႏ
- Papiamentu
- پښتو
- Patois
- Português
- Qaraqalpaqsha
- Qırımtatarca
- Română
- Русиньскый
- Русский
- Саха тыла
- Sakizaya
- Gagana Samoa
- संस्कृतम्
- ᱥᱟᱱᱛᱟᱲᱤ
- Sardu
- Scots
- Setswana
- Shqip
- Sicilianu
- සිංහල
- Simple English
- سنڌي
- Slovenščina
- کوردی
- Српски / srpski
- Srpskohrvatski / српскохрватски
- Sunda
- Suomi
- Svenska
- Tagalog
- தமிழ்
- Taqbaylit
- Tarandíne
- Татарча / tatarça
- တႆး
- తెలుగు
- ไทย
- ትግርኛ
- Тоҷикӣ
- ತುಳು
- Türkçe
- Türkmençe
- Українська
- اردو
- ئۇيغۇرچە / Uyghurche
- Vahcuengh
- Vèneto
- Tiếng Việt
- Volapük
- 文言
- Winaray
- 吴语
- Yorùbá
- 粵語
- Zazaki
- 中文
- Batak Toba
- Kadazandusun
- Ghanaian Pidgin
- Kumoring
- Руски
- ᥖᥭᥰ ᥖᥬᥲ ᥑᥨᥒᥰ
- Tolışi
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.
See the protection policy and protection log for more details. Please discuss any changes on the talk page; you may submit an edit request to ask an administrator to make an edit if it is uncontroversial or supported by consensus. You may also request that this page be unprotected.
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 |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 250px 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.
Parameters displayed in image syntax
All parameters:
{{#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}}} }}
[[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):
{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | size=300px | maxsize=250px }}
[[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):
{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | sizedefault=250px | maxsize=200px }}
[[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):
{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | maxsize=256px }}
[[File:{{{image}}}|256px]]
When "size", "sizedefault", and "maxsize" are not defined, "frameless" is added, which displays the image at the default thumbnail size (250px, but logged in users can change this at Special:Preferences) and is required if using "upright" to scale the default size:
{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} }}
[[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):
{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | upright = yes }}
[[File:{{{image}}}|frameless|upright]]
When "alt" is used without "title", the alt text is also used as the title:
{{#invoke:InfoboxImage | InfoboxImage | image={{{image}}} | alt = Alt text }}
[[File:{{{image}}}|frameless|alt=Alt text]]
For more information, see Wikipedia:Extended image syntax.
Sample usage
|image = {{#invoke:InfoboxImage|InfoboxImage|image={{{image|}}}|upright={{{image_upright|1}}}|alt={{{alt|}}}}}
Examples
{{#invoke:InfoboxImage|InfoboxImage}}
{{#invoke:InfoboxImage|InfoboxImage|image=}}
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg}}
{{#invoke:InfoboxImage|InfoboxImage|image=File:Abbey Rd Studios.jpg}}
{{#invoke:InfoboxImage|InfoboxImage|image=Image:Abbey Rd Studios.jpg}}
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|upright=yes}}
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|upright=1.2}}
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100px}}
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|size=100}}
{{#invoke:InfoboxImage|InfoboxImage|image=[[File:Abbey Rd Studios.jpg|200px]]
}}
{{#invoke:InfoboxImage|InfoboxImage|image=[[File:Abbey Rd Studios.jpg|200px]]
|title=Abbey Road!}}
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|sizedefault=250px|alt=The front stairs and door of Abbey Road Studios}}
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}}
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}}
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}}
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}}
The front stairs and door of Abbey Road Studios
{{#invoke:InfoboxImage|InfoboxImage|image=Bandera de Bilbao.svg|size=100|border=yes}}
{{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg}}
{{#invoke:InfoboxImage|InfoboxImage|image=Image is needed male.svg|suppressplaceholder=no}}
{{#invoke:InfoboxImage|InfoboxImage|image=[[File:Image is needed male.svg|200px]]
}}
{{#invoke:InfoboxImage|InfoboxImage|image=[[File:Image is needed male.svg|200px]]
|suppressplaceholder=no}}
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|maxsize=100px}}
{{#invoke:InfoboxImage|InfoboxImage|image=Abbey Rd Studios.jpg|maxsize=100px}}
{{#invoke:InfoboxImage|InfoboxImage|image=[[File:Abbey Rd Studios.jpg|200px]]
|maxsize=100px}}
{{#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={{Multiple image |width=60 |image1=Yellow card.svg |image2=Red card.svg}}}}
Placeholder images which can be suppressed
- File:Blue - replace this image female.svg
- File:Blue - replace this image male.svg
- File:Male no free image yet.png
- File:Flag of None (square).svg
- File:Flag of None.svg
- File:Flag of.svg
- File:Green - replace this image female.svg
- File:Green - replace this image male.svg
- File:Image is needed female.svg
- File:Image is needed male.svg
- File:Location map of None.svg
- File:Male no free image yet.png
- File:Missing flag.png
- File:No flag.svg
- File:No free portrait.svg
- File:No portrait (female).svg
- File:No portrait (male).svg
- File:Red - replace this image female.svg
- File:Red - replace this image male.svg
- File:Replace this image female.svg
- File:Replace this image male (blue).svg
- File:Replace this image male.svg
- 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
Tracking categories
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Subpages of this module.
-- Inputs: -- image - Can either be a bare filename (with or without the File:/Image: prefix) or a fully formatted image link -- page - page to display for multipage images (DjVu) -- size - size to display the image -- maxsize - maximum size for image -- sizedefault - default size to display the image if size param is blank -- alt - alt text for image -- title - title text for image -- border - set to yes if border -- center - set to yes, if the image has to be centered -- upright - upright image param -- suppressplaceholder - if yes then checks to see if image is a placeholder and suppresses it -- link - page to visit when clicking on image -- class - HTML classes to add to the image -- Outputs: -- Formatted image. -- More details available at the "Module:InfoboxImage/doc" page locali={}; localplaceholder_image={ "Blue - Replace this image female.svg", "Blue - Replace this image male.svg", "Flag of None (square).svg", "Flag of None.svg", "Flag of.svg", "Green - Replace this image female.svg", "Green - Replace this image male.svg", "Image is needed female.svg", "Image is needed male.svg", "Location map of None.svg", "Male no free image yet.png", "Missing flag.png", "No flag.svg", "No free portrait.svg", "No portrait (female).svg", "No portrait (male).svg", "Red - Replace this image female.svg", "Red - Replace this image male.svg", "Replace this image female.svg", "Replace this image male (blue).svg", "Replace this image male.svg", "Silver - Replace this image female.svg", "Silver - Replace this image male.svg", "Replace this image.svg", "Cricket no pic.png", "CarersLogo.gif", "Diagram Needed.svg", "Example.jpg", "Image placeholder.png", "No male portrait.svg", "Nocover-upload.png", "NoDVDcover copy.png", "Noribbon.svg", "No portrait-BFD-test.svg", "Placeholder barnstar ribbon.png", "Project Trains no image.png", "Image-request.png", "Sin bandera.svg", "Sin escudo.svg", "Replace this image - temple.png", "Replace this image butterfly.png", "Replace this image.svg", "Replace this image1.svg", "Resolution angle.png", "Image-No portrait-text-BFD-test.svg", "Insert image here.svg", "No image available.png", "NO IMAGE YET square.png", "NO IMAGE YET.png", "No Photo Available.svg", "No Screenshot.svg", "No-image-available.jpg", "Null.png", "PictureNeeded.gif", "Place holder.jpg", "Unbenannt.JPG", "UploadACopyrightFreeImage.svg", "UploadAnImage.gif", "UploadAnImage.svg", "UploadAnImageShort.svg", "CarersLogo.gif", "Diagram Needed.svg", "No male portrait.svg", "NoDVDcover copy.png", "Placeholder barnstar ribbon.png", "Project Trains no image.png", "Image-request.png", "Noimage.gif", } localcategories={ url_image_links="[[Category:Pages using infoboxes with URL in image parameter]]", thumbnail_images="[[Category:Pages using infoboxes with thumbnail images]]", } localfunctiontrackable() localns=mw.title.getCurrentTitle().nsText:lower() returnnot(ns=='user'orns=='user talk') end functioni.IsPlaceholder(image) -- change underscores to spaces image=mw.ustring.gsub(image,"_"," "); assert(image~=nil,'mw.ustring.gsub(image, "_", " ") must not return nil') -- if image starts with [[ then remove that and anything after | ifmw.ustring.sub(image,1,2)=="[["then image=mw.ustring.sub(image,3); image=mw.ustring.gsub(image,"([^|]*)|.*","%1"); assert(image~=nil,'mw.ustring.gsub(image, "([^|]*)|.*", "%1") must not return nil') end -- Trim spaces image=mw.ustring.gsub(image,'^[ ]*(.-)[ ]*$','%1'); assert(image~=nil,"mw.ustring.gsub(image, '^[ ]*(.-)[ ]*$', '%1') must not return nil") -- remove prefix if exists localallNames=mw.site.namespaces[6].aliases allNames[#allNames+1]=mw.site.namespaces[6].name allNames[#allNames+1]=mw.site.namespaces[6].canonicalName fori,nameinipairs(allNames)do ifmw.ustring.lower(mw.ustring.sub(image,1,mw.ustring.len(name)+1))==mw.ustring.lower(name..":")then image=mw.ustring.sub(image,mw.ustring.len(name)+2); break end end -- Trim spaces image=mw.ustring.gsub(image,'^[ ]*(.-)[ ]*$','%1'); -- capitalise first letter image=mw.ustring.upper(mw.ustring.sub(image,1,1))..mw.ustring.sub(image,2); fori,jinpairs(placeholder_image)do ifimage==jthen returntrue end end returnfalse end localfunctionisempty(x) return(notx)orx=="" end functioni.InfoboxImage(frame) localimage=frame.args["image"]; ifisempty(image)then return""; end ifimage==" "then returnimage; end ifframe.args["suppressplaceholder"]~="no"then ifi.IsPlaceholder(image)==truethen return""; end end ifstring.find(image,"^%[*https?:")then -- Error category. returntrackable()andcategories.url_image_linksor"" end ifmw.ustring.sub(image,1,2)=="[["then -- search for thumbnail images and add to tracking cat if found localcat=""; ifmw.title.getCurrentTitle().namespace==0and(mw.ustring.find(image,"|%s*thumb%s*[|%]]")ormw.ustring.find(image,"|%s*thumbnail%s*[|%]]"))then cat=trackable()andcategories.thumbnail_imagesor"" end returnimage..cat; elseifmw.ustring.sub(image,1,2)=="{{"andmw.ustring.sub(image,1,3)~="{{{"then returnimage; elseifmw.ustring.sub(image,1,1)=="<"then returnimage; elseifmw.ustring.sub(image,1,8)==mw.ustring.char(127).."'\"`UNIQ"then -- Found strip marker at begining, so pass don't process at all returnimage; else localresult=""; localpage=frame.args["page"]; localupright=frame.args["upright"]or"" localsize=frame.args["size"]; localmaxsize=frame.args["maxsize"]; localsizedefault=frame.args["sizedefault"]; localalt=frame.args["alt"]; locallink=frame.args["link"]; localtitle=frame.args["title"]; localborder=frame.args["border"]; localthumbtime=frame.args["thumbtime"]or""; localcenter=frame.args["center"]; localclass=frame.args["class"]; -- remove prefix if exists localallNames=mw.site.namespaces[6].aliases allNames[#allNames+1]=mw.site.namespaces[6].name allNames[#allNames+1]=mw.site.namespaces[6].canonicalName fori,nameinipairs(allNames)do ifmw.ustring.lower(mw.ustring.sub(image,1,mw.ustring.len(name)+1))==mw.ustring.lower(name..":")then image=mw.ustring.sub(image,mw.ustring.len(name)+2); break end end ifnotisempty(maxsize)then -- if no sizedefault nor upright, then set to maxsize ifisempty(sizedefault)andisempty(upright)then sizedefault=maxsize end -- check to see if size bigger than maxsize localmaxsizenumber=tonumber(mw.ustring.match(maxsize,"%d*"))or0; ifnotisempty(size)then localsizenumber=tonumber(mw.ustring.match(size,"%d*"))or0; ifsizenumber>maxsizenumberandmaxsizenumber>0then size=maxsize; end end -- check to see if upright bigger than maxsize (at default preferred size) ifnotisempty(upright)then localuprightnumber=tonumber(upright)or(upright=="yes"and0.75)or0 ifuprightnumber*220>maxsizenumberandmaxsizenumber>0then upright=tostring(maxsizenumber/220) end end end -- add px to size if just a number if(tonumber(size)or0)>0then size=size.."px"; end -- add px to sizedefault if just a number if(tonumber(sizedefault)or0)>0then sizedefault=sizedefault.."px"; end result="[[File:"..image; ifnotisempty(page)then result=result.."|page="..page; end ifnotisempty(size)then result=result.."|"..size; elseifnotisempty(sizedefault)andisempty(upright)then result=result.."|"..sizedefault; else result=result.."|frameless"; end ifcenter=="yes"then result=result.."|center" end ifnotisempty(alt)then result=result.."|alt="..alt; end ifnotisempty(link)then result=result.."|link="..link; end ifborder=="yes"then result=result.."|border"; end ifupright=="yes"then result=result.."|upright"; elseifupright~=""then result=result.."|upright="..upright; end ifthumbtime~=""then result=result.."|thumbtime="..thumbtime; end ifnotisempty(class)then result=result.."|class="..class; end -- if alt value is a keyword then do not use as a description ifalt=="thumbnail"oralt=="thumb"oralt=="frameless"oralt=="left"oralt=="center"oralt=="right"oralt=="upright"oralt=="border"ormw.ustring.match(altor"",'^[0-9]*px$',1)~=nilthen alt=nil; end ifnotisempty(title)then -- does title param contain any templatestyles? If yes then set to blank. ifmw.ustring.match(frame:preprocess(title),'UNIQ%-%-templatestyles',1)~=nilthen title=nil; end end ifnotisempty(title)then result=result.."|"..title; end result=result.."]]"; returnresult; end end returni;