View source for Template:Panorama/doc

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{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 ===
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Panorama
|image   = Example.jpg
|height  = 
|width   = 
|alt     = 
|caption = 
|dir     = 
|align   =
}}
</syntaxhighlight>

=== Commented invocation ===

<syntaxhighlight lang="wikitext" style="overflow:auto;">{{Panorama
|image   = File:Example.jpg <!-- Must start with "File:" -->
|height  = 300 <!-- Height of image. In pixels, no units. Use Template:Wide_image to set the width instead -->
|width   = <!-- Limit the width of Frame enclosing the image. Include units e.g. 9px or 9%. Default is based on width of web browser -->
|alt     = <!-- Alternate text for visually impaired readers. -->
|caption = <!-- Caption/text to render below the image -->
|dir     = <!-- Can be: ltr (default) or rtl. Should scroll bar start at the very left (ltr = left-to-right) or very right (rtl)?  -->
|align   = <!-- Frame alignment. Can be: left (default), right, center, or none. -->
}}
</syntaxhighlight>

=== Simple example ===
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Panorama
|image   = 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
}}
</syntaxhighlight>

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

The caption can be centered by replacing {{para|caption|Text}} with <code><nowiki>|caption={{center|Text}}</nowiki></code>. In the example above, replacing {{para|caption|}} with 
<code><nowiki>|caption = {{center|Panorama of Ushuaia from 2005-02-06}}</nowiki></code> 
produces:

{{Panorama
|image   = 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 = {{center|Panorama of Ushuaia from 2005-02-06}}
}}

=== Right-to-left scrolling ===
Same as the example, but with {{para|dir|rtl}}.
{{Panorama
|image   = 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|Panorama link}}
* {{tl|PanoViewer}} - for interactive 360 degree photospheres
* {{tl|Scalable image}}
* {{tl|Tall image}} – for images too large in the other dimension
* {{tl|Wide image}} – alternative template for panoramas

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Image formatting and function templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>