Template:Image/doc: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
(Documentation for Template:Image)
 
(Updated documentation)
Line 3: Line 3:
==Usage==
==Usage==
The Image template should be called in the following way:
The Image template should be called in the following way:
*<code><nowiki>{{Image|<filename>|<description>}}</nowiki></code>
*<code><nowiki>{{Image|<filename>|<description>|<new row?>}}</nowiki></code>
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
*<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, <code><nowiki>{{Image|Super Smash Bros. Melee-Corrupt Stats.jpg|Corrupt}}</nowiki></code> produces this:
* 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:
{{Image|Super Smash Bros. Melee-Corrupt Stats.jpg|Corrupt}}<div style="clear:left"></div>
{{Image|Super Smash Bros. Melee-Corrupt Stats.jpg|Corrupt|br}}


* Specifying only filename leaves the desciption empty (<code><nowiki>{{Image|Super Smash Bros. Melee-Non-Corrupt Stats.jpg}}</nowiki></code>):
* 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:
{{Image|Super Smash Bros. Melee-Non-Corrupt Stats.jpg}}<div style="clear:left"></div>
{{Image|Super Smash Bros. Melee-Non-Corrupt Stats.jpg||br}}<div style="clear:left"></div>


==Notes==
==Notes==
* Using multiple calls will make the thumbnails be side-by-side:
* 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):
{{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}}
{{Image|Super Smash Bros. Brawl-Classic Results.png}}
{{Image|Super Smash Bros. Brawl-Classic Results.png||br}}
<div style="clear:left"></div>


* ALWAYs add this after calling the template to properly show other elements from the page or when you need one thumbnail in each "line":
* When you need one image in each row, you should add the <code>br</code> tag to the 3rd parameter of all images, not just the last:
<pre><div style="clear:left"></div></pre>
{{Image|Super Smash Bros. Melee-Corrupt Stats.jpg|Corrupt|br}}
{{Image|Super Smash Bros. Melee-Corrupt Stats.jpg|Corrupt}}<div style="clear:left"></div>
{{Image|Super Smash Bros. Melee-Non-Corrupt Stats.jpg|Appropriate|br}}
{{Image|Super Smash Bros. Melee-Non-Corrupt Stats.jpg|Appropriate}}<div style="clear:left"></div>
{{Image|Super Smash Bros. Brawl-Classic Results.png}}
{{Image|Super Smash Bros. Brawl-Classic Results.png}}


* If you use this template and forget to use a <code>&lt;div style="clear:left"&gt;&lt;/div&gt;</code> after calling it, you'll get something weird, like this topic!
* If you use this template and forget to add the <code>br</code> tag to the 3rd parameter after calling the last image, you'll get something weird, like this topic!

Revision as of 22:27, 8 November 2012

This template provides a simplified way to use thumbnails of images uploaded to this wiki. It automatically uses the standard thumbnail size and position used on this wiki

Usage

The Image template should be called in the following way:

  • {{Image|<filename>|<description>|<new row?>}}

where

  • Filename is the name of the file (with extension) uploaded to the wiki (like "myfile.png")
  • Description (optional) is the caption for the thumbnail
  • new row? (optional) should always be br when used. This parameter tell the template if it should create a new row or not.

Examples

  • Specifying filename and description. We are embedding only one image, so we should add the br tag to the 3rd parameter. In this example, {{Image|Super Smash Bros. Melee-Corrupt Stats.jpg|Corrupt|br}} will produce this:
  • Specifying only filename leaves the description empty. We are embedding only one image, so we should add the br tag to the 3rd parameter. In this example, {{Image|Super Smash Bros. Melee-Non-Corrupt Stats.jpg||br}} will produce this:

Notes

  • Using multiple calls will make the thumbnails be side-by-side (the last image should ALWAYS include the br tag to the 3rd parameter):
  • When you need one image in each row, you should add the br tag to the 3rd parameter of all images, not just the last:
  • If you use this template and forget to add the br tag to the 3rd parameter after calling the last image, you'll get something weird, like this topic!