Editing Help:Images

{{External Programs}}

{{shortcut|S:IMG|S:IMAGE}}
This page explains the '''image''' syntax when editing the wiki. An image has to be already [[Help:Managing Files|uploaded]] before it can be used on a page.
 
== Syntax ==

The full syntax for displaying an image is:

  [[File:{file_name}|{options}]]

Where options can be zero or more of the following, separated by pipes:

* ''border'', ''frame'', ''thumb'', or ''frameless'': Controls how the image is formatted
* ''left'', ''right'', ''center'', ''none'': Controls the alignment of the image within a text
* ''baseline'', ''sub'', ''super'', ''top'', ''text-top'', ''middle'', ''bottom'', ''text-bottom'': Controls the vertical alignment of the image within a text
* ''{width} px'': Resizes the image to the given width in pixels
* ''{width}x{height}px'': Resizes the image to fit within the given width and height in pixels; it is possible to specify only the height by writing ''x{height}px''
** ''Note that the image will always retain its aspect ratio.''
*  ''link={destination}'': Allows to link to an arbitrary title, URL or just nowhere ([[mediawikiwiki:rev:41727|1.14+]])
** ''link= '': Will display an image without link, e.g. <code><nowiki>[[</nowiki>File:Example.jpg|20px|link=Help:Images]]</code> → [[File:Example.jpg|20px|link=Help:Images]].
** ''Note that ''link'' cannot be used in conjunction with ''thumb'' as thumb is always meant to link to the larger version of the image.  In addition, ''link'' cannot be used with ''frame''.''
* ''alt={alternative text}'': For changing the alternative text (''alt=""'') of an image ([[mediawikiwiki:rev:41837|1.14+]])
* Special cases:
** ''page=1'': Displays the specified page when showing a djvu or pdf file

The options can be given in any order. If the given options conflict each other, the latter is applied, except for the format options, where the options take the priority in the order of ''frame'', ''thumb'', and ''frameless'' and/or ''border''.

If a given option does not match any of the other possibilities, it is assumed to be the caption text. Caption text can contain wiki links or other formatting. If no caption text is supplied a caption is automatically created showing the file name; to completely remove the caption, set it to <code><nowiki><span title=""></span></nowiki></code>. For example, <code><nowiki>[[File:Example.jpg|20px|<span title=""></span>]]</nowiki></code> → [[File:Example.jpg|20px|<span title=""></span>]].

== Format ==

The following table shows the effect of all available formats.

{| class="wikitable plainlinks"
|-
!Description
!You type
{{Help:Images/frame|frame=|ex=no format specified}}
{{Help:Images/frame|frame=border|ex=border results in a very small gray border}}
{{Help:Images/frame|frame=frame}}
{{Help:Images/frame|frame=thumb}}
{{Help:Images/frame|frame=frameless|ex=frameless, like thumbnail, respect user preferences for image width but without border and no right float}}
{{Help:Images/frame|frame=frameless|2=border|ex=frameless and border}}
{{Help:Images/frame|2=link=Scratch Wiki Home|ex=internal link}}
{{Help:Images/frame|2=link=http://wikipedia.org|ex=external link}}
{{Help:Images/frame|2=link=|ex=no link (external or file page)}}
|}

When the height of an image in thumbnail is bigger than its width and you find it too outstanding, you may try the option <code>upright</code>, which will try to adjust its size to more desirable size.

Note that by writing <code>thumb={filename}</code>, you can use a different image for the thumbnail.

== Alignment ==

Note that when using <code>frame</code> or <code>thumb</code>, the default alignment will be <code>right</code>.

{| class="wikitable"
!Description
!You type
{{Help:Images/frame|frame=|ex='''no alignment specified''', or default alignment}}
{{Help:Images/frame|frame=none|ex=specify alignment as '''none'''}}
{{Help:Images/frame|frame=center}}
{{Help:Images/frame|frame=left}}
{{Help:Images/frame|frame=right}}
|}

=== Vertical alignment ===

 text <nowiki>[[</nowiki>File:Example.jpg|20px]]
 text <nowiki>[[</nowiki>File:Example.jpg|20px|baseline]]
 text <nowiki>[[</nowiki>File:Example.jpg|20px|sub]]
 text <nowiki>[[</nowiki>File:Example.jpg|20px|super]]
 text <nowiki>[[</nowiki>File:Example.jpg|20px|text-top]]
 text <nowiki>[[</nowiki>File:Example.jpg|20px|middle]]
 text <nowiki>[[</nowiki>File:Example.jpg|20px|bottom]]
 text <nowiki>[[</nowiki>File:Example.jpg|20px|text-bottom]]

results in (the text is underlined to show the result more clearly)

<u>text [[File:Example.jpg|20px]]
text [[File:Example.jpg|20px|baseline]]
text [[File:Example.jpg|20px|sub]]
text [[File:Example.jpg|20px|super]]
text [[File:Example.jpg|20px|text-top]]
text [[File:Example.jpg|20px|middle]]
text [[File:Example.jpg|20px|bottom]]
text [[File:Example.jpg|20px|text-bottom]]</u>

== Size and Frame ==

Among different formats, the effect of the size parameter may be different, as shown below.

* When the format is not specified, or only <code>border</code>ed, the size can be both reduced and enlarged.
* An image with <code>frame</code> always ignores the size specification.
* The size of an image with <code>thumb</code> and <code>frameless</code> can be reduced, but can not be enlarged beyond the original size of the image.

For how it appears when its size is not specified, see [[#Format|Format]] section above.

{| class="wikitable"
!Format!!Result
{{Help:Images/size|frame=}}
{{Help:Images/size|frame=border}}
{{Help:Images/size|frame=frame}}
{{Help:Images/size|frame=thumb}}
{{Help:Images/size|frame=frameless}}
|}

== Stopping text flow ==

On occasion it is desirable to stop text from flowing around an image.  Depending on the web browser's screen resolution and such, text flow on the right side of an image may cause a section header (for instance, <nowiki>== My Header ==</nowiki>) to appear to the right of the image, instead of below it, as a user may expect.  The text flow can be stopped by placing '''<nowiki><br style="clear: both" /></nowiki>''' before the text that should start after the image.

== Gallery of images ==

It's easy to make a gallery of '''thumbnails only''', not other images, with the <code><nowiki><gallery></nowiki></code> tag. The syntax is:

 <nowiki><gallery></nowiki>
 File:Image Name.ext|caption
 File:Image Name.ext|caption
 {...}
 </gallery>

Note that the image code is not enclosed in brackets when enclosed in gallery tags. 

Captions are optional, and may contain wiki links or other formatting.

for example:

 <nowiki><gallery></nowiki>
 File:Example.jpg|Item 1
 File:Example.jpg|a link to <nowiki>[[</nowiki>Help:Contents]]
 File:Example.jpg
 File:Example.jpg
 File:Example.jpg| <nowiki>''italic caption''</nowiki>
 File:Example.jpg|on page "<nowiki>{{</nowiki>PAGENAME}}"
 </gallery>

is formatted as:

<gallery>
File:Example.jpg|Item 1
File:Example.jpg|a link to [[Help:Contents]]
File:Example.jpg
File:Example.jpg
File:Example.jpg|''italic caption''
File:Example.jpg|on page "{{PAGENAME}}"
</gallery>

However, due to the fixed-width website, parameters should be used to make sure the images do not cut off.

=== Parameters ===

The gallery tag itself takes several additional parameters:

<pre><gallery {parameters}>
{images}
</gallery></pre>

* <code>caption={caption}</code>: sets a caption on the gallery.
* <code>widths={width}px</code>: sets the widths of the images. ''Note the plural, width'''s'''''
* <code>heights={heights}px</code>: sets the (max) heights of the images.
* <code>perrow={integer}</code>: sets the number of images per row.

Due to the small, fixed-width of this website, it is recommended to either use Perrow:5 with Widths:71, or Perrow:4 with Widths:100, so images do not get cut off.

Example:

Coding:

<pre>
<gallery widths=71px perrow=5 caption="Example">
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
</gallery>
</pre>

Result:

<gallery widths=71px perrow=5 caption="Example">
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
File:Example.jpg
</gallery>

== Links ==

=== Link to description page ===

If you put a colon (<code>:</code>) before <code>{{ns:image}}:</code>, the image will not be embedded and the link will lead to the description page of the file.

 <nowiki>*[[</nowiki>:{{ns:image}}:Example.jpg]]
 <nowiki>*[[</nowiki>:{{ns:image}}:Example.jpg|Sunflowers]]

results in

*[[:{{ns:image}}:Example.jpg]]
*[[:{{ns:image}}:Example.jpg|Sunflowers]]

=== Link to another page ===

This will make a picture with a link to the page [[Scratch Wiki]]:

 <nowiki>[[</nowiki>File:Scratch Cat-cropped.png|link=Scratch Wiki]]

[[File:Scratch Cat-cropped.png|link=Scratch Wiki]]

=== Link directly to file ===

You can use the pseudo-namespace “{{ns:media}}” to link directly to a file, bypassing the description page.

 <nowiki>*[[</nowiki>{{ns:media}}:Example.jpg]]
 <nowiki>*[[</nowiki>{{ns:media}}:Example.jpg|Sunflowers]]

results in

*[[{{ns:media}}:Example.jpg]]
*[[{{ns:media}}:Example.jpg|Sunflowers]]

You can also use:&nbsp;

 <nowiki>[[</nowiki>{{#special:Filepath}}/Example.jpg]]

which can be used to link to a potential file, even if it does not exist. You can also use:

 <nowiki>{{</nowiki>FILEPATH:Example.jpg<nowiki>}}</nowiki>

which generates an external URL to the file inline: {{FILEPATH:Example.jpg}}

== Requisites ==

Before using images in your page, the system administrator of your wiki must have [[mediawikiwiki:Manual:Configuring file uploads|enabled file uploads]] and a user has to [[Help:Managing Files|upload the file]]. System administrators may also set the wiki to accept files from [[mediawikiwiki:Manual:Image Administration#Foreign Repositories|foreign repositories]], such as the [[commons:|Wikimedia Commons]]. For server side image resizing it is necessary to have a scaler configured (such as GD2, ImageMagick, etc.).

== Files at other websites ==

You can link to an external file available online using the same syntax used for linking to an external web page.
<pre>[http://url.for/some/image.png]</pre>
Or with different text:
<pre>[http://url.for/some/image.png link text here]</pre>

== Compressing a file ==
To compress a file is to decrease its file size. There are different ways to compress files.
{{note|Different compression methods have varying results. Some compression methods decrease file quality for the sake of decreasing file size (called "lossy compression"), while others decrease the file size without decreasing quality (called "lossless compression").}}

=== Snipping Tool ===
Snipping Tool is a built-in screenshot taking program on Windows devices. To use this for compressing, take a screenshot of the image. This will reduce the file quality down to at most the resolution of the device's screen, but will significantly decrease the file size (lossy).

=== GIMP ===
GIMP is an image-editing program that can be downloaded from [https://gimp.org gimp.org]. To use this for compressing, go to ''Image > Mode > Indexed'' and set the options for compression.
<!-- TODO: find out if this is lossy or lossless -->
<br/><br/>
=== Photopea ===
Photopea is a free image editing webpage that can be used through [https://photopea.com photopea.com]. To use this for compressing, upload the image, go to ''File > Export as > .JPG'' and change the quality slider.

=== TinyPNG ===
The most-used method of compressing images on the Wiki is a website called [https://tinypng.com TinyPNG] which allows the user to simply upload up to 20 images at once and shrinks them down to a surprisingly small file size with lossless quality. If an image is not compressed, a bot may use TinyPNG to replace the image automatically, but it is recommended that the user should do it themself before uploading.

=== BeFunky ===
BeFunky is a mostly free image editing webpage that can be used through [https://www.befunky.com befunky.com]. To use this for compressing images, go to ''Edit a photo > Open > Computer (Ctrl+O) > Select file > Save > Computer (Ctrl+S) > JPG '' and select the quality via the slider.

[[Category:Help|Images]]