Difference between revisions of "Help:Images"

From wikisori
Jump to: navigation, search
Line 1: Line 1:
This page explains the image syntax when editing the wiki. Before using images, you must {{mediawiki|Manual:Configuring_file_uploads|configure file uploads}} and [[Help:Managing files|upload a file]].  
+
This page explains the image syntax when editing the wiki. Before using images, your wiki must have file uploads enabled (see the {{mediawiki|Manual:Configuring_file_uploads|technical manual}} for details) and you have to [[Help:Managing files|upload a file]].
  
__TOC__  
+
__TOC__
 
+
{| {{Prettytable}}
{| class="FCK__ShowTableBorders"
 
 
|-
 
|-
| '''Description'''  
+
|{{Hl3}}|'''Description'''
| '''You type'''  
+
|{{Hl3}}|'''You type'''  
| '''You get'''
+
|{{Hl3}}|'''You get'''
 
|-
 
|-
| Embed image<br>(with alt text)  
+
|Embed image<br /> (with alt text)
|  
+
|
<code><nowiki>[[Image:Example.jpg|Sunflowers]]</nowiki></code>  
+
<code><nowiki>[[Image:Binomial_Cube.jpg|Sunflowers]]</nowiki></code>
 
+
|
|  
+
[[Image:Binomial_Cube.jpg|Sunflowers]]
[[Image:Example.jpg|Sunflowers]]  
 
 
 
 
|-
 
|-
| Link to description page  
+
|Link to description page
|  
+
|
<code><nowiki>[[:Image:Example.jpg]]</nowiki></code><br><code><nowiki>[[:Image:Example.jpg|Sunflowers]]</nowiki></code>  
+
<code><nowiki>[[:Image:Binomial_Cube.jpg]]</nowiki></code><br />
 
+
<code><nowiki>[[:Image:Binomial_Cube.jpg|Sunflowers]]</nowiki></code>
|  
+
|
[[Image:Example.jpg]]<br>[[Image:Example.jpg|Sunflowers]]  
+
[[:Image:Binomial_Cube.jpg]]<br />
 
+
[[:Image:Binomial_Cube.jpg|Sunflowers]]
 
|-
 
|-
| Link directly to file  
+
|Link directly to file
|  
+
|
<code><nowiki>[[Media:Example.jpg]]</nowiki></code><br><code><nowiki>[[Media:Example.jpg|Sunflowers]]</nowiki></code>  
+
<code><nowiki>[[Media:Binomial_Cube.jpg]]</nowiki></code><br />
 
+
<code><nowiki>[[Media:Binomial_Cube.jpg|Sunflowers]]</nowiki></code>
|  
+
|
[[Media:Example.jpg|Media:Example.jpg]]<br>[[Media:Example.jpg|Sunflowers]]  
+
[[Media:Binomial_Cube.jpg]]<br />
 
+
[[Media:Binomial_Cube.jpg|Sunflowers]]
 
|-
 
|-
| Thumbnail<br>(centered, 100 pixels<br>wide, with caption)  
+
|Thumbnail<br /> (centered, 100 pixels<br /> wide, with caption)
|  
+
|
<code><nowiki>[[Image:Example.jpg|center|thumb|100px|Sunflowers]]</nowiki></code>  
+
<code><nowiki>[[Image:Binomial_Cube.jpg|center|thumb|100px|Sunflowers]]</nowiki></code>
 
+
|
|  
+
[[Image:Binomial_Cube.jpg|center|thumb|100px|Sunflowers]]
[[Image:Example.jpg|thumb|center|Sunflowers]]  
 
 
 
 
|-
 
|-
| Border<br>(100 pixels) <br>Results in a very small gray border <!-- Note: because the fine gray border can not be seen when used on Image:Exaple.jpg (sunflowers image), an image with a white background is used -->  
+
|Border<br /> (100 pixels) <br /> Results in a very small gray border
|  
+
<!-- Note: because the fine gray border can not be seen when used on Image:Exaple.jpg (sunflowers image), an image with a white background is used -->
<code><nowiki>[[Image:Example-white-bg.jpg|border|100px]]</nowiki></code>  
+
|
 
+
<code><nowiki>[[Image:Example-white-bg.jpg|border|100px]]</nowiki></code>
|  
+
|
[[Image:Example-white-bg.jpg|border|100px]]  
+
[[Image:Example-white-bg.jpg|border|100px]]
 
 
 
|-
 
|-
| Frameless<br>Like thumbnail, respect user preferences for image width but without border and no right float.  
+
|Frameless<br />Like thumbnail, respect user preferences for image width but without border and no right float.
|  
+
|
<code><nowiki>[[Image:Example.jpg|frameless]]</nowiki></code>  
+
<code><nowiki>[[Image:Binomial_Cube.jpg|frameless]]</nowiki></code>
 
+
|
|  
+
[[Image:Binomial_Cube.jpg|frameless]]
[[Image:Example.jpg]]  
 
 
 
 
|}
 
|}
  
== Syntax ==
+
== Syntax ==
 
+
The full syntax for displaying an image is:
The full syntax for displaying an image is:  
 
 
 
 
  <code><nowiki>[[Image:{name}|{options}]]</nowiki></code>
 
  <code><nowiki>[[Image:{name}|{options}]]</nowiki></code>
+
Where options can be zero or more of the following, separated by pipes:
 
+
*<code>thumb</code>, <code>thumbnail</code>, <code>frame</code>, or <code>frameless</code>: Controls how the image is formatted
Where options can be zero or more of the following, separated by pipes:  
+
*<code>left</code>, <code>right</code>, <code>center</code>, <code>none</code>: Controls the alignment of the image on the page
 
+
*<code>baseline</code>, <code>sub</code>, <code>super</code>, <code>top</code>, <code>text-top</code>, <code>middle</code>, <code>bottom</code>, <code>text-bottom</code>: Controls the vertical alignment of the image on the page
*<code>thumb</code>, <code>thumbnail</code>, or <code>frame</code>: Controls how the image is formatted  
+
*<code>{width}px</code>: Resizes the image to the given width in pixels
*<code>left</code>, <code>right</code>, <code>center</code>, <code>none</code>: Controls the alignment of the image on the page  
+
*<code>{caption text}</code>: Must not end with "px"
*<code>{width}px</code>: Resizes the image to the given width in pixels  
+
* Special cases:
*<code>{caption text}</code>  
+
** <code>page=1</code>: Displays the specified page when showing a djvu file
*Special cases:  
+
*<code>link={destination}</code>: Allows to link to an arbitrary title, URL or just nowhere ([[rev:41727|1.14+]])
**<code>page=1</code>: displays the specified page when showing a djvu file.
+
*<code>alt={alternative text}</code>: For changing the alternative text (<code>alt=""</code>) of an image ([[rev:41837|1.14+]])
 
 
The options can be given in any order. 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.
 
  
== Other files  ==
+
The options can be given in any order. 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.
  
 +
== Other files ==
 
You can link to an external file using the same syntax used for linking to an external web page.  
 
You can link to an external file using the same syntax used for linking to an external web page.  
 
 
*<code><nowiki>[http://url.for/some/image.png]</nowiki></code>
 
*<code><nowiki>[http://url.for/some/image.png]</nowiki></code>
 
+
Or with different text:
Or with different text:  
 
 
 
 
*<code><nowiki>[http://url.for/some/image.png link text here]</nowiki></code>
 
*<code><nowiki>[http://url.for/some/image.png link text here]</nowiki></code>
  
If it is enabled on your wiki (see [[Manual:$wgAllowExternalImages|Manual:$wgAllowExternalImages]]), you can also embed external images. To do that, simply insert the image's url:  
+
If it is enabled on your wiki (see {{mediawiki|Manual:$wgAllowExternalImages}}), you can also embed external images. To do that, simply insert the image's url:
 
 
 
*<code><nowiki>http://url.for/some/image.png</nowiki></code>
 
*<code><nowiki>http://url.for/some/image.png</nowiki></code>
  
== Gallery of images ==
+
== Gallery of images ==
 
+
It's easy to make a gallery of thumbnails with the <code><nowiki><gallery></nowiki></code> tag. The syntax is:
It's easy to make a gallery of thumbnails with the <code><nowiki><gallery></nowiki></code> tag. The syntax is:  
+
<pre>
<pre>&lt;gallery&gt;
+
<gallery>
 
Image:{filename}|{caption}
 
Image:{filename}|{caption}
 
Image:{filename}|{caption}
 
Image:{filename}|{caption}
 
{...}
 
{...}
&lt;/gallery&gt;
+
</gallery>
</pre>  
+
</pre>
Captions are optional, and may contain wiki links or other formatting.  
+
Captions are optional, and may contain wiki links or other formatting.
 
 
for example:
 
<pre>&lt;gallery&gt;
 
Image:Example.jpg|Item 1
 
Image:Example.jpg|a link to [[Help:Contents]]
 
Image:Example.jpg
 
Image:Example.jpg
 
Image:Example.jpg|''italic caption''
 
&lt;/gallery&gt;
 
</pre>
 
is formatted as: <gallery>
 
Image:Example.jpg|Item 1
 
Image:Example.jpg|a link to [[Help:Contents]]
 
Image:Example.jpg
 
Image:Example.jpg
 
Image:Example.jpg|''italic caption''
 
</gallery>
 
  
== See also  ==
+
for example:
 +
<pre>
 +
<gallery>
 +
Image:Binomial_Cube.jpg|Item 1
 +
Image:Binomial_Cube.jpg|a link to [[Help:Contents]]
 +
Image:Binomial_Cube.jpg
 +
Image:Binomial_Cube.jpg
 +
Image:Binomial_Cube.jpg|''italic caption''
 +
Image:Binomial_Cube.jpg|on page "{{PAGENAME}}"
 +
</gallery>
 +
</pre>
 +
is formatted as:
 +
<gallery>
 +
Image:Binomial_Cube.jpg|Item 1
 +
Image:Binomial_Cube.jpg|a link to [[Help:Contents]]
 +
Image:Binomial_Cube.jpg
 +
Image:Binomial_Cube.jpg
 +
Image:Binomial_Cube.jpg|''italic caption''
 +
Image:Binomial_Cube.jpg|on page "{{PAGENAME}}"
 +
</gallery>
  
*[[Help:Linked images|Linked images]]
+
== See also ==
 +
* [[Help:Linked images|Linked images]]
  
== External Link ==
+
==External Link==
 +
* [[wikipedia:Project:Extended image syntax|Wikipedia:Extended image syntax]]
  
*[[:wikipedia:Project:Extended image syntax|Wikipedia:Extended image syntax]]
 
  
 
[[Category:Help|Images]]
 
[[Category:Help|Images]]

Revision as of 00:27, 3 November 2008

This page explains the image syntax when editing the wiki. Before using images, your wiki must have file uploads enabled (see the {{ #ifeq:

 wikisori.org

| www.mediawiki.org | technical manual | technical manual }} for details) and you have to upload a file.

Description You type You get
Embed image
(with alt text)

[[Image:Binomial_Cube.jpg|Sunflowers]]

Sunflowers

Link to description page

[[:Image:Binomial_Cube.jpg]]
[[:Image:Binomial_Cube.jpg|Sunflowers]]

Image:Binomial_Cube.jpg
Sunflowers

Link directly to file

[[Media:Binomial_Cube.jpg]]
[[Media:Binomial_Cube.jpg|Sunflowers]]

Media:Binomial_Cube.jpg
Sunflowers

Thumbnail
(centered, 100 pixels
wide, with caption)

[[Image:Binomial_Cube.jpg|center|thumb|100px|Sunflowers]]

Sunflowers
Border
(100 pixels)
Results in a very small gray border

[[Image:Example-white-bg.jpg|border|100px]]

100px

Frameless
Like thumbnail, respect user preferences for image width but without border and no right float.

[[Image:Binomial_Cube.jpg|frameless]]

Binomial Cube.jpg

Syntax

The full syntax for displaying an image is:

[[Image:{name}|{options}]]

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

  • thumb, thumbnail, frame, or frameless: Controls how the image is formatted
  • left, right, center, none: Controls the alignment of the image on the page
  • baseline, sub, super, top, text-top, middle, bottom, text-bottom: Controls the vertical alignment of the image on the page
  • {width}px: Resizes the image to the given width in pixels
  • {caption text}: Must not end with "px"
  • Special cases:
    • page=1: Displays the specified page when showing a djvu file
  • link={destination}: Allows to link to an arbitrary title, URL or just nowhere (1.14+)
  • alt={alternative text}: For changing the alternative text (alt="") of an image (1.14+)

The options can be given in any order. 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.

Other files

You can link to an external file using the same syntax used for linking to an external web page.

  • [http://url.for/some/image.png]

Or with different text:

  • [http://url.for/some/image.png link text here]

If it is enabled on your wiki (see {{ #ifeq:

 wikisori.org

| www.mediawiki.org | Manual:$wgAllowExternalImages | Manual:$wgAllowExternalImages }}), you can also embed external images. To do that, simply insert the image's url:

  • http://url.for/some/image.png

Gallery of images

It's easy to make a gallery of thumbnails with the <gallery> tag. The syntax is:

<gallery>
Image:{filename}|{caption}
Image:{filename}|{caption}
{...}
</gallery>

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

for example:

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

is formatted as:

See also

External Link