Caleb Cooper: Created page with "{{Documentation subpage}} {{Commons Import}} {{Lua|Module:Wide image}} == TemplateData == {{TemplateData header}} <..."

2020-10-19T14:04:34Z

Created page with "{{Documentation subpage}} {{Commons Import}}  {{Lua|Module:Wide image}} == TemplateData == {{TemplateData header}} <..."

New page

{{Documentation subpage}}
{{Commons Import}}


{{Lua|Module:Wide image}}

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
"params": {
"image": {
"label": "Image",
"description": "Title for the image file to display. Must start with \"File:\".",
"example": "File:Ushuaia_panorama_from_seaside_big.jpg",
"type": "string",
"required": true
},
"width": {
"label": "Viewport width",
"description": "Limit the width of the scrollable viewport in which the image is displayed. Input is used as CSS width, as such it must include a unit (e.g. \"px\" or \"%\").",
"example": "400px",
"type": "string",
"default": "Automatic based on width of web browser window."
},
"dir": {
"label": "Viewport direction",
"description": "Set to \"rtl\" to start the viewport at the right-hand side of the image, with \"right-to-left\" scrolling.",
"example": "rtl",
"type": "string",
"default": "ltr - Left to right"
},
"height": {
"label": "Image height",
"description": "How tall to display the image, in pixels. Must be set without any unit or suffix.",
"example": "300",
"type": "number",
"required": true
},
"alt": {
"label": "Alternate text",
"description": "Alternate text to use instead of the image, for visually impaired readers. See the WP:ALT page for guidance.",
"type": "string"
},
"caption": {
"label": "Caption",
"description": "Caption to render below the image.",
"type": "content"
},
"align": {
"label": "Image alignment",
"description": "If supplied, how to position the image on the page.",
"example": "left",
"type": "string"
}
},
"description": "Insert a wide image with configurable height. For standard height, use template \"Wide image\" instead.",
"paramOrder": [
"image",
"height",
"width",
"alt",
"caption",
"dir",
"align"
],
"format": "block"
}
</templatedata>

== Examples ==
The main function of {{tl|Panorama}}, as opposed to {{tl|Wide image}}, is that the template allows you to specify a desired height of the panorama.

=== Blank invocation ===

<pre style="overflow:auto;">
{{Panorama
|image = File:Example.jpg
|height =
|width =
|alt =
|caption =
|dir =
|align =
}}
</pre>

=== Simple example ===

<pre style="overflow:auto;">
{{Panorama
|image = File:Ushuaia_panorama_from_seaside_big.jpg
|height = 230
|alt = A small city across a gray waterway under lowering gray clouds. A road leads to the city across a causeway. Mountains with snow and a low treeline form the backdrop. A few boats are in the water.
|caption = Panorama of Ushuaia from 2005-02-06
}}
</pre>

This displays ''[[:File:Ushuaia panorama from seaside big.jpg]]'', which is 7370×1010 pixels, as 1678×230, in a horizontally scrolling box, using the caption and alt text provided.

{{Panorama
|image = File:Ushuaia_panorama_from_seaside_big.jpg
|height = 230
|alt = A small city across a gray waterway under lowering gray clouds. A road leads to the city across a causeway. Mountains with snow and a low treeline form the backdrop. A few boats are in the water.
|caption = Panorama of Ushuaia from 2005-02-06
}}

=== Smaller ===
Same as the previous example, but with {{para|height|80}}.
{{Panorama
|image = File:Ushuaia_panorama_from_seaside_big.jpg
|height = 80
|alt = A small city across a gray waterway under lowering gray clouds. A road leads to the city across a causeway. Mountains with snow and a low treeline form the backdrop. A few boats are in the water.
|caption = Panorama of Ushuaia from 2005-02-06
}}

=== Right-to-left scrolling ===
Same as the example, but with {{para|dir|rtl}}.
{{Panorama
|image = File:Ushuaia_panorama_from_seaside_big.jpg
|height = 230
|dir = rtl
|alt = A small city across a gray waterway under lowering gray clouds. A road leads to the city across a causeway. Mountains with snow and a low treeline form the backdrop. A few boats are in the water.
|caption = Panorama of Ushuaia from 2005-02-06
}}

== Tracking category ==
* {{clc|Pages using panorama with unknown parameters}}

== See also ==
* {{tl|Wide image}} – alternative template for panoramas
* {{tl|Tall image}} – for images too large in the other dimension
* {{tl|Panorama 2}}

<includeonly>{{Sandbox other||

[[Category:Image templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>

Template:Panorama/doc - Revision history

Caleb Cooper: Created page with "{{Documentation subpage}} {{Commons Import}} {{Lua|Module:Wide image}} == TemplateData == {{TemplateData header}} <..."