Template:Image/doc: Difference between revisions

Jump to navigation Jump to search
(Updated documentation)
(Updated documentation)
Line 6: Line 6:
where
where
*<code>Filename</code> is the name of the file (with extension) uploaded to the wiki (like "myfile.png")
*<code>Filename</code> is the name of the file (with extension) uploaded to the wiki (like "myfile.png")
*<code>Description</code> (optional) is the caption for the thumbnail
*<code>Description</code> (optional) is the caption for the thumbnail. If left blank, the template assumes "screenshot mode" and generates 200px thumbnails. If the caption is specified, the template assumes normal mode and output 300px thumbnail with the caption.
*<code>new row?</code> (optional) should always be <code>br</code> when used. This parameter tell the template if it should create a new row or not.
*<code>new row?</code> (optional) should always be <code>br</code> when used. This parameter tell the template if it should create a new row or not.
==Examples==
==Examples==
* Specifying filename and description. We are embedding only one image, so we should add the <code>br</code> tag to the 3rd parameter. In this example, <code><nowiki>{{Image|Super Smash Bros. Melee-Corrupt Stats.jpg|Corrupt|br}}</nowiki></code> will produce this:
* Specifying filename and description. Since we specified a caption, template assumes normal mode, and we are embedding only one image, so we should add the <code>br</code> tag to the 3rd parameter. In this example, <code><nowiki>{{Image|Super Smash Bros. Melee-Corrupt Stats.jpg|Corrupt|br}}</nowiki></code> will produce this:
{{Image|Super Smash Bros. Melee-Corrupt Stats.jpg|Corrupt|br}}
{{Image|Super Smash Bros. Melee-Corrupt Stats.jpg|Corrupt|br}}


* Specifying only filename leaves the description empty. We are embedding only one image, so we should add the <code>br</code> tag to the 3rd parameter. In this example, <code><nowiki>{{Image|Super Smash Bros. Melee-Non-Corrupt Stats.jpg||br}}</nowiki></code> will produce this:
* Specifying only filename remove the description box and make the template assume "screenshot mode". We are embedding only one image, so we should add the <code>br</code> tag to the 3rd parameter. In this example, <code><nowiki>{{Image|Super Smash Bros. Melee-Non-Corrupt Stats.jpg||br}}</nowiki></code> will produce this:
{{Image|Super Smash Bros. Melee-Non-Corrupt Stats.jpg||br}}<div style="clear:left"></div>
{{Image|Super Smash Bros. Melee-Non-Corrupt Stats.jpg||br}}


==Notes==
==Notes==
* Using multiple calls will make the thumbnails be side-by-side (the last image should ALWAYS include the <code>br</code> tag to the 3rd parameter):
* To force screenshot mode with the <code>br</code> tag, you must null the 2nd parameter by using ||, like this: <code><nowiki>{{Image|<filename>||br}}</nowiki></code>
* The 3rd parameter only accept the <code>br</code> tag. If you include any other tag, nothing will happen.
* Using multiple calls will make the thumbnails be side-by-side (the last image should ALWAYS include the <code>br</code> tag to the 3rd parameter). Normal thumbnails and screenshots thumbnails shouldn't be called in the same row, otherwise you get floating element issues, like the 3rd thumbnail below:
{{Image|Super Smash Bros. Melee-Corrupt Stats.jpg|Corrupt}}
{{Image|Super Smash Bros. Melee-Corrupt Stats.jpg|Corrupt}}
{{Image|Super Smash Bros. Melee-Non-Corrupt Stats.jpg|Appropriate}}
{{Image|Super Smash Bros. Melee-Non-Corrupt Stats.jpg|Appropriate}}