When you connect to this website, you send your IP address and sometimes some cookies. You may also give us personal identifying information, such as your name and contact information. All this data is used to securely provide you with the services that you request. We encourage you to review our privacy policy to make sure that you understand how your data is managed, and to contact us if you have any questions. View Privacy Policy
 

Difference between revisions of "Help:Images"

From NASPAWiki

You are viewing a condensed mobile version of this NASPA webpage.
Switch to full version.

(New page: {{PD Help Page}} Redirects are used to forward users from one page name to another. They can be useful if a particular article is referred to by multiple names, or has alternative punctua...)
 
(Replaced Help:Redirect with Help:Images)
 
Line 1: Line 1:
 
{{PD Help Page}}
 
{{PD Help Page}}
 +
This page explains the '''image''' syntax when editing the wiki. You or another user must usually [[Help:Managing files|upload an image]] before you can use it 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 ([[rev:41727|1.14+]])
 +
** ''link= '': Will display an image without link, e.g. <code><nowiki>[[</nowiki>File:Name.jpg|20px|link=Help:Images]]</code> → [[File:Name.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 ([[rev:41837|1.14+]])
 +
* Special cases:
 +
** ''page=1'': Displays the specified page when showing a djvu file
  
−
Redirects are used to forward users from one page name to another. They can be useful if a particular article is referred to by multiple names, or has alternative punctuation, capitalization or spellings.
+
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.
  
−
==Creating a redirect==
+
== Format ==
−
You may start a new page with the name you want to direct from (see [[Help:Starting a new page]]). You can also use an existing page that you are making inactive as a page by going to that page and using the "edit" tab at the top. In either case, you will be inserting the following code at the very first text position of the Edit window for the page:
+
The following table shows the effect of all available formats.
−
<nowiki>#REDIRECT [[</nowiki>''pagename''<nowiki>]]</nowiki>
 
−
where ''pagename'' is the name of the destination page. The word "redirect" is not case-sensitive, but there must be no space between the "#" symbol. Any text before the code will disable the code and prevent a redirect. Any text or regular content code after the redirect code will be ignored (and should be deleted from an existing page). However, to put or keep the current page name listed in a Category, the usual tag for that category is entered or kept on a line after the redirect code entry.
 
  
−
You should use the 'preview' button below the Edit window, or Alt-P, to check that you have entered the correct destination page name. The preview page will not look like the resulting redirect page, it will look like a numbered list, with the destination page in blue:
+
{| class="wikitable plainlinks"
−
1. REDIRECT  <span style="color:blue">''pagename''</span>
+
|-
−
If the ''pagename'' as you typed it is not a valid page, it will show in red. Until there is a valid destination page, you should not make the redirect.
+
!Description
 +
!You type
 +
!You get
 +
{{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=Main Page|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)}}
 +
|}
  
−
==Viewing a redirect==
+
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.
−
After making a redirect at a page, you can no longer get to that page by using its name or by any link using that name; and they do not show up in wiki search results, either. However, near the top of the destination page, a notice that you have been forwarded appears, with the source pagename as an active link to it. Click this to get back to the redirected page, showing the large bent arrow symbol and the destination for the redirect.
 
  
−
By doing this, you can do all the things that any wiki page allows. You can go to the associated discussion page to discuss the redirect. You can view the history of the page, including a record of the redirect. You can edit the page if the redirect is wrong, and you can revert to an older version to remove the redirect.
+
Note that by writing <code>thumb={filename}</code>, you can use a different image for the thumbnail.
  
−
==Deleting a redirect==
+
== Alignment ==
−
There's generally no need to delete redirects. They do not occupy a significant amount of database space. If a page name is vaguely meaningful, there's no harm (and some benefit) in having it as a redirect to the more relevant or current page.  
+
Note that when using <code>frame</code> or <code>thumb</code>, the default alignment will be <code>right</code>.
  
−
If you do need to delete a redirect, e.g. if the page name is offensive, or you wish to discourage people from referring to a concept by that name, then you simply go to the redirect page as mentioned above, and follow the procedures at [[Help:Deleting a page]].
+
{| class="wikitable"
 +
!Description
 +
!You type
 +
!You get
 +
{{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}}
 +
|}
  
−
==Double redirects ==
+
=== Vertical alignment ===
−
A double redirect is a page redirecting to a page which is itself a redirect, and it will not work. Instead, people will be presented with a view of the next redirect page. This is a deliberate restriction, partly to prevent infinite loops, and partly to keep things simple.  
+
text text <nowiki>[[</nowiki>File:Example.jpg|20px]]
 +
text text <nowiki>[[</nowiki>File:Example.jpg|20px|baseline]]
 +
text text <nowiki>[[</nowiki>File:Example.jpg|20px|sub]]
 +
text text <nowiki>[[</nowiki>File:Example.jpg|20px|super]]
 +
text text <nowiki>[[</nowiki>File:Example.jpg|20px|text-top]]
 +
text text <nowiki>[[</nowiki>File:Example.jpg|20px|middle]]
 +
text text <nowiki>[[</nowiki>File:Example.jpg|20px|bottom]]
 +
text text <nowiki>[[</nowiki>File:Example.jpg|20px|text-bottom]]
  
−
However, you could look out for double redirects and eliminate them, by changing them to be 1-step redirects instead. You are most likely to need to do this after a significant [[Help:Moving a page|page move]]. Use the "what links here" toolbox link to find double redirects to a particular page, or use [[Special:DoubleRedirects]] to find them throughout the whole wiki.
+
results in (the text is underlined to show the result more clearly)
  
−
== A redirect to a page in the category namespace ==
+
<u>text text [[File:Example.jpg|20px]]
−
To prevent a page that redirects to a category from appearing in the category, precede the word "Category" with a colon:  
+
text text [[File:Example.jpg|20px|baseline]]
−
<nowiki>#REDIRECT [[:Category:Glossary]]</nowiki>
+
text text [[File:Example.jpg|20px|sub]]
 +
text text [[File:Example.jpg|20px|super]]
 +
text text [[File:Example.jpg|20px|text-top]]
 +
text text [[File:Example.jpg|20px|middle]]
 +
text text [[File:Example.jpg|20px|bottom]]
 +
text 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.
  
−
[[Category:Help|Redirects]]
+
* 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!!Reduced!! Enlarged
 +
{{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.  See [[Template:-]] for additional explanation.
 +
 
 +
== 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>
 +
 
 +
===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.
 +
* <code>heights={heights}px</code>: sets the (max) heights of the images.
 +
* <code>perrow={integer}</code>: sets the number of images per row.
 +
 
 +
== 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}}:{{mediawiki:image_sample}}]]
 +
<nowiki>[[</nowiki>:{{ns:image}}:{{mediawiki:image_sample}}|Sunflowers]]
 +
 
 +
results in
 +
 
 +
[[:{{ns:image}}:{{mediawiki:image_sample}}]]
 +
[[:{{ns:image}}:{{mediawiki:image_sample}}|Sunflowers]]
 +
 
 +
=== 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}}:{{mediawiki:image_sample}}]]
 +
<nowiki>[[</nowiki>{{ns:media}}:{{mediawiki:image_sample}}|Sunflowers]]
 +
 
 +
results in
 +
 
 +
[[{{ns:media}}:{{mediawiki:image_sample}}]]
 +
[[{{ns:media}}:{{mediawiki:image_sample}}|Sunflowers]]
 +
 
 +
You can also use:&nbsp;
 +
 
 +
<nowiki>[[</nowiki>{{#special:Filepath}}/{{mediawiki:image_sample}}]]
 +
 
 +
which can be used to link to a potential file, even if it doesn't exist. You can also use:
 +
 
 +
<nowiki>{{</nowiki>FILEPATH:{{mediawiki:image_sample}}<nowiki>}}</nowiki>
 +
 
 +
which generates an external URL to the file inline: {{FILEPATH:{{mediawiki:image_sample}}}}
 +
 
 +
== Requisites ==
 +
Before using images in your page, the system administrator of your wiki must have {{mediawiki|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 {{mediawiki|Manual:Image Administration#Foreign Repositories|foreign repositories}}, such as the [http://commons.wikimedia.org/wiki/Main_Page Wikimedia Commons].
 +
 
 +
== 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>
 +
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:
 +
<pre>http://url.for/some/image.png</pre>
 +
 
 +
{{Languages}}
 +
[[Category:Help|Images]]

Latest revision as of 21:37, 20 August 2009

PD
 Important note: When you edit this page, you agree to release your contribution into the public domain. If you don't want this or can't do this because of license restrictions, please don't edit. This page is one of the Public Domain Help Pages, which can be freely copied into fresh wiki installations and/or distributed with MediaWiki software; see Help:Contents for an overview of all pages. See Project:PD help/Copying for instructions.
PD

This page explains the image syntax when editing the wiki. You or another user must usually upload an image before you can use it 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 (1.14+)
    • link= : Will display an image without link, e.g. [[File:Name.jpg|20px|link=Help:Images]] → Name.jpg.
    • 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 (1.14+)
  • Special cases:
    • page=1: Displays the specified page when showing a djvu 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.

Format

The following table shows the effect of all available formats.

Description You type You get

Help:Images/frame Help:Images/frame Help:Images/frame Help:Images/frame Help:Images/frame Help:Images/frame Help:Images/frame Help:Images/frame Help:Images/frame

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

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

Alignment

Note that when using frame or thumb, the default alignment will be right.

Description You type You get

Help:Images/frame Help:Images/frame Help:Images/frame Help:Images/frame Help:Images/frame

Vertical alignment

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

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

text text Example.jpg text text Example.jpg text text Example.jpg text text Example.jpg text text Example.jpg text text Example.jpg text text Example.jpg text text Example.jpg

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 bordered, the size can be both reduced and enlarged.
  • An image with frame always ignores the size specification.
  • The size of an image with thumb and frameless 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 section above.

Format Reduced Enlarged

Help:Images/size Help:Images/size Help:Images/size Help:Images/size Help:Images/size

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, == My Header ==) 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 <br style="clear: both" /> before the text that should start after the image. See Template:- for additional explanation.

Gallery of images

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

<gallery>
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: 

<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>

is formatted as:

Parameters

The gallery tag itself takes several additional parameters: 

<gallery {parameters}>
{images}
</gallery>
  • caption={caption}: sets a caption on the gallery.
  • widths={width}px: sets the widths of the images.
  • heights={heights}px: sets the (max) heights of the images.
  • perrow={integer}: sets the number of images per row.

Links

Link to description page

If you put a colon (:) before File:, the image will not be embedded and the link will lead to the description page of the file. 

[[:File:Example.jpg]]
[[:File:Example.jpg|Sunflowers]]

results in

File:Example.jpg Sunflowers

Link directly to file

You can use the pseudo-namespace “Media” to link directly to a file, bypassing the description page. 

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

results in

Media:Example.jpg Sunflowers

You can also use:  

[[Special:FilePath/Example.jpg]]

which can be used to link to a potential file, even if it doesn't exist. You can also use: 

{{FILEPATH:Example.jpg}}

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

Requisites

Before using images in your page, the system administrator of your wiki must have enabled file uploads and a user has to upload the file. System administrators may also set the wiki to accept files from foreign repositories, such as the Wikimedia Commons.

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. 

[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 Manual:$wgAllowExternalImages), you can also embed external images. To do that, simply insert the image's url: 

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

Template

Syntax

{{Languages|PageName}}
  • PageName (optional) - the name of the page to display language links for. If omitted then the English version of the current page is used. This parameter can normally be omitted, as it is only required if you want to link to a page other than the one you place the template on, which is very uncommon. If this parameter is used on a sub-page make sure you supply the root name, not the full page name (e.g. on MediaWiki/fr you would need to use {{Languages|MediaWiki}} and not {{Languages|MediaWiki/fr}}).

Usage

The template should only be placed on pages that exist in more than one language, and it should be placed in the same location on each translation of the page.

The English version of a page is always the main version, with all other languages as sub-pages, named using the appropriate language code (see below).

For example, on the Main Page you would include the text {{Languages}}, both on Main Page itself, and on each of its language sub-pages. The template automatically creates links to any language sub-pages that exist, e.g. Main Page/ja<tt>, <tt>Main Page/fr, and ignores non-existant languages.

See Project:Language policy for further details about translating pages.

Supported languages

This shows you the name of each language's sub-page (using Main Page as an example). Other languages may be added easily as necessary. Please use the appropriate prefix, as used on Wikipedia when adding a new language. Please do not add languages for which no pages exist yet, as this will increase the time needed to include the template without adding any benefit (languages are only displayed to the user when the relevant page exists).

The link on the language names goes to the Wikipedia in that language. If no Wikipedia in your language exists, do not add pages in that language to MediaWiki.org! This wiki is not the place for language advocacy - please go through the correct channels, and once your language has a Wikipedia then please return to add content here.

Page Name Language
Main Page English

Example

Here is how the language bar looks on the MediaWiki page: Template loop detected: Template:Languages

Retrieved from "http://www.scrabbleplayers.org/wiki/index.php?title=Help:Images&oldid=3077"