Template:Wide image/doc

Da CIW.

Template:Documentation subpage Template:TOCRight

This template allows you to easily include a panorama image. If the image is too wide, scrollbars will be added. If you do not want the image to use a thumbnail frame, you can use Template:Para.

Usage

{{Wide image|name|image width|caption|box width|alignment|alt=alt text}}

A caption option is optional, and an image frame will be used if a caption is supplied. If the caption contains an equal sign, use the parameter |3=caption in the place of |caption. If the caption supplied is exactly equal to image syntax such as thumb, the image's tooltip will no longer display the caption, but instead default to the name of the image.

The box width option is optional, and if given a value in pixels followed by "px", or a value in percent followed by "%", will set the width of the box to that amount. For example, 45% would use 45% of the text section width, (not a percentage of the image width).

The alignment option is also optional but requires box width to be defined. If given a value of right or left, the entire wide image will float to the right or left. If given a value of none the image will not float.

The alt text describes the image's visual appearance to visually disabled readers. Please see WP:ALT for details.

To change the scroll direction from left-to-right to right-to-left, use Template:Para.

To align the caption, use Template:Para.

To remove the outer border, use Template:Para.

Example

Without caption

{{wide image|Helsinki z00.jpg|1800px|
|alt=Panorama of city with mixture of five to ten story buildings}}

smaller

{{wide image|Helsinki z00.jpg|400px|
|alt=Panorama of city with mixture of five to ten story buildings}}

With caption

{{wide image|Helsinki z00.jpg|1800px|[[Helsinki]] panorama
|alt=Panorama of city with mixture of five to ten story buildings}}

Template:Clear

Right aligned

{{wide image|Helsinki z00.jpg|1800px|[[Helsinki]] panorama|45%|right
|alt=Panorama of city with mixture of five to ten story buildings}}
This text goes after the ''wide image'' template. [[Lorem ipsum]] dolor sit amet...

This text goes after the wide image template. Template:Lorem ipsum Template:Clear

Left aligned

{{wide image|Helsinki z00.jpg|1800px|[[Helsinki]] panorama|45%|left
|alt=Panorama of city with mixture of five to ten story buildings}}
This text goes after the ''wide image'' template. Lorem ipsum dolor sit amet...

This text goes after the wide image template. Template:Lorem ipsum Template:Clear

Center aligned 75% width

{{wide image|Helsinki z00.jpg|1800px|[[Helsinki]] panorama|75%|center
|alt=Panorama of city with mixture of five to ten story buildings}}
This text goes after the ''wide image'' template. Lorem ipsum dolor sit amet...

This text goes after the wide image template. Template:Lorem ipsum Template:Clear

No alignment

{{wide image|Helsinki z00.jpg|1800px|[[Helsinki]] panorama|45%|none
|alt=Panorama of city with mixture of five to ten story buildings}}
This text goes after the ''wide image'' template. Lorem ipsum dolor sit amet...

This text goes after the wide image template. Template:Lorem ipsum Template:Clear

Scroll right to left

{{wide image|Helsinki z00.jpg|1800px|[[Helsinki]] panorama
|alt=Panorama of city with mixture of five to ten story buildings
|dir=rtl}}

Template:Clear

TemplateData

Template:TemplateData header <templatedata>{ "description": "Allows you to easily include a panorama image. If the image is too wide, scrollbars will be added.", "params": {

"1": {
   "label": "Filename",
   "description": "Name of the file to display. Example: Helsinki z00.jpg",
   "type": "string",
   "required": true
 },
 "2": {
   "label": "Image width",
   "description": "Give the width in pixels (like: 1600px) that you want the included image to be",
   "type": "string",
   "required": true
 },
 "3": {
   "label": "Caption",
   "description": "A caption for the image that will be shown below image",
   "type": "string",
   "required": false
 },
 "4" : {
   "label": "Width of frame",
   "description": "Limit the width of the frame enclosing the picture. Example: \"400px\" or \"40%\"",
   "type": "string",
   "required": false
 },
 "5": {
   "label": "Frame alignment",
   "description": "Either of: left, right, center or none. When specified also requires you to set the \"Width of frame\" option",
   "default": "center",
   "type": "string",
   "required": false
 },
 "dir" : {
   "label": "Picture alignment",
   "description": "Use the value 'rtl' to make the right side of the image the initial visible portion inside the scroll frame",
   "default": "ltr",
   "type": "string",
   "required": false
 },
 "alt" : {
   "label": "Textual alternative",
   "description": "Describes the image's visual appearance to visually disabled readers. Please see WP:ALT for details",
   "type": "string",
   "required": false
 }

} }</templatedata>

See also

Template:Commons