Template:Image/doc

{{#if: |

40px	This is the template documentation page for Template:Image.
	This page may not be intended to be viewed directly. Links using variables may appear broken; do not replace these with hardcoded page names or URLs.

{{#if:x||

}} |{{#ifeq: doc | doc

 | 

{{

   #ifeq: show | show
   | {{
 {{#switch:
 {{#if: 
   | 
   | {{#if: 
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     | 
       {{#ifeq:template|template talk
       | talk
       | template 
       }}
     }}
   }}

| main | = ambox | talk = tmbox | user = ombox | wikipedia = ombox | file | image = imbox | mediawiki = ombox | template = ombox | help = ombox | category = cmbox | portal = ombox | book = ombox | other | #default = ombox

}} | type = notice | image = none | imageright = | class = | style = | textstyle = | text = This is a documentation subpage for Template:Image (see that page for the {{ #if: Template | template | article }} itself).
It contains usage information, categories and other content that is not part of the original {{ #if: Template |template page|article}}. | small = | smallimage = | smallimageright = | smalltext = | subst = | date = }}

   }}{{
   #if: 
   | 
   | [[Category:{{
     #if: Template
     | Template
     | Article
   }} documentation]]
 }}

| }} }} This template can be used as a wrapper to simplify the inclusion of an image in a template, where users may use several different forms of syntax.

It is primarily of use in templates and should not be used in articles directly (see File: syntax: meta:Help:File).

Usage

• {{Image | Example.svg | 20px}} → {{#if: Example.svg

| {{#ifeq: Template:Str left | [

 |  Example.svg    
 | [[{{
 safesubst:#if:  Example.svg 
     
 | {{
     safesubst:#ifeq:  | File
     | Example.svg
     | File:{{safesubst:#if:X| Example.svg 
     }}
   }}
 |

}}{{#ifeq: a | b

     | |alt={{{alt}}}
     }}{{#ifeq: a | b
     | |link={{{link}}}
     }}{{#ifeq: a | b
     | |upright={{{upright}}}
     }}{{#ifeq:  20px |  20px
     | | 20px
     }}{{#ifeq: a | b
     | |{{{3}}}
     }}{{#ifeq: a | b
     | |{{{4}}}
     }}{{#ifeq: a | b
     | |{{{5}}}
     }}{{#ifeq: a | b
     | |{{{6}}}
     }}]]
 }}

| }}

• {{Image | File:Example.svg | 20px}} → {{#if: File:Example.svg

| {{#ifeq: Template:Str left | [

 |  File:Example.svg    
 | [[{{
 safesubst:#if:  File:Example.svg 
     
 | {{
     safesubst:#ifeq: File | File
     | File:Example.svg
     | File:{{safesubst:#if:X| File:Example.svg 
     }}
   }}
 |

}}{{#ifeq: a | b

     | |alt={{{alt}}}
     }}{{#ifeq: a | b
     | |link={{{link}}}
     }}{{#ifeq: a | b
     | |upright={{{upright}}}
     }}{{#ifeq:  20px |  20px
     | | 20px
     }}{{#ifeq: a | b
     | |{{{3}}}
     }}{{#ifeq: a | b
     | |{{{4}}}
     }}{{#ifeq: a | b
     | |{{{5}}}
     }}{{#ifeq: a | b
     | |{{{6}}}
     }}]]
 }}

| }}

• {{Image | :File:Example.svg | 20px}} → {{#if: :File:Example.svg

| {{#ifeq: Template:Str left | [

 |  :File:Example.svg    
 | [[{{
 safesubst:#if:  :File:Example.svg 
     
 | {{
     safesubst:#ifeq: File | File
     | File:Example.svg
     | File:{{safesubst:#if:X| :File:Example.svg 
     }}
   }}
 |

}}{{#ifeq: a | b

     | |alt={{{alt}}}
     }}{{#ifeq: a | b
     | |link={{{link}}}
     }}{{#ifeq: a | b
     | |upright={{{upright}}}
     }}{{#ifeq:  20px |  20px
     | | 20px
     }}{{#ifeq: a | b
     | |{{{3}}}
     }}{{#ifeq: a | b
     | |{{{4}}}
     }}{{#ifeq: a | b
     | |{{{5}}}
     }}{{#ifeq: a | b
     | |{{{6}}}
     }}]]
 }}

| }}

• {{Image | [[File:Example.svg|30px]] | 20px}} → {{#if: 30px

| {{#ifeq: Template:Str left | [

 |  30px    
 | [[{{
 safesubst:#if:  30px 
     
 | {{
     safesubst:#ifeq:  | File
     | 
     | File:{{safesubst:#if:X| 30px 
     }}
   }}
 |

}}{{#ifeq: a | b

     | |alt={{{alt}}}
     }}{{#ifeq: a | b
     | |link={{{link}}}
     }}{{#ifeq: a | b
     | |upright={{{upright}}}
     }}{{#ifeq:  20px |  20px
     | | 20px
     }}{{#ifeq: a | b
     | |{{{3}}}
     }}{{#ifeq: a | b
     | |{{{4}}}
     }}{{#ifeq: a | b
     | |{{{5}}}
     }}{{#ifeq: a | b
     | |{{{6}}}
     }}]]
 }}

| }}

Note that additional parameters are (deliberately) ignored if full image syntax is passed in the first parameter. You can pass up to five parameters directly otherwise:

• {{Image | Example.svg | 20px | thumb | none | Foo}} → {{#if: Example.svg

| {{#ifeq: Template:Str left | [

 |  Example.svg    
 | [[{{
 safesubst:#if:  Example.svg 
     
 | {{
     safesubst:#ifeq:  | File
     | Example.svg
     | File:{{safesubst:#if:X| Example.svg 
     }}
   }}
 |

}}{{#ifeq: a | b

     | |alt={{{alt}}}
     }}{{#ifeq: a | b
     | |link={{{link}}}
     }}{{#ifeq: a | b
     | |upright={{{upright}}}
     }}{{#ifeq:  20px  |  20px 
     | | 20px 
     }}{{#ifeq:  thumb  |  thumb 
     | | thumb 
     }}{{#ifeq:  none  |  none 
     | | none 
     }}{{#ifeq:  Foo |  Foo
     | | Foo
     }}{{#ifeq: a | b
     | |{{{6}}}
     }}]]
 }}

| }}

You can also pass arbitrary parameters accepted by the Image syntax if you separate them with {{!}}. You may need to number them explicitly if they contain an equals sign "=":

• {{Image | Example.svg | 2= 20px{{!}}link=Main Page}} → {{#if: Example.svg

| {{#ifeq: Template:Str left | [

 |  Example.svg    
 | [[{{
 safesubst:#if:  Example.svg 
     
 | {{
     safesubst:#ifeq:  | File
     | Example.svg
     | File:{{safesubst:#if:X| Example.svg 
     }}
   }}
 |

}}{{#ifeq: a | b

     | |alt={{{alt}}}
     }}{{#ifeq: a | b
     | |link={{{link}}}
     }}{{#ifeq: a | b
     | |upright={{{upright}}}
     }}{{#ifeq: 20px|link=Main Page | 20px|link=Main Page
     | |20px|link=Main Page
     }}{{#ifeq: a | b
     | |{{{3}}}
     }}{{#ifeq: a | b
     | |{{{4}}}
     }}{{#ifeq: a | b
     | |{{{5}}}
     }}{{#ifeq: a | b
     | |{{{6}}}
     }}]]
 }}

| }}

See also

• {{Double image}}
• {{Multiple image}}
• {{File title}}
• {{Linked}}
• {{px}}