Template:Panorama/doc
This is a documentation subpage for Template:Panorama. It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
TemplateData
TemplateData for Panorama
<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 {{Panorama}}, as opposed to {{Wide image}}, is that the template allows you to specify a desired height of the panorama.
Blank invocation
{{Panorama |image = Example.jpg |height = |width = |alt = |caption = |dir = |align = }}
Commented invocation
{{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. --> }}
Simple example
{{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 }}
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.
Smaller
Same as the previous example, but with |height=80
.
The caption can be centered by replacing |caption=Text
with |caption={{center|Text}}
. In the example above, replacing |caption=
with
|caption = {{center|Panorama of Ushuaia from 2005-02-06}}
produces:
Right-to-left scrolling
Same as the example, but with |dir=rtl
.
Tracking category
See also
- {{Panorama link}}
- {{PanoViewer}} - for interactive 360 degree photospheres
- {{Scalable image}}
- {{Tall image}} – for images too large in the other dimension
- {{Wide image}} – alternative template for panoramas