Template:Superimpose/doc: Difference between revisions
Jump to navigation
Jump to search
(usage (copied from talk)) |
No edit summary |
||
| (46 intermediate revisions by 28 users not shown) | |||
| Line 1: | Line 1: | ||
'''{{tl|Superimpose}}''' is a utility template which superimposes one image on top another. The position of the superimposed image is relative to the top left corner of the underlying image. It is often used to display a location mark on a map image, but it can be used with any two images. | |||
==Usage== | ==Usage== | ||
===Example=== | ===Example=== | ||
< | {| style="width: 100%; margin-top: 1em" | ||
{{Superimpose| base = US_Locator_Blank.svg | |<pre style="margin-top: 0"> | ||
{{Superimpose | |||
| base = US_Locator_Blank.svg | |||
| base_width = 288px | | base_width = 288px | ||
| base_alt = Located in north central Colorado, which is just west of the center of the U.S. | |||
| base_caption = United States Locator Map | | base_caption = United States Locator Map | ||
| float = | | float = Red pog.svg | ||
| float_width = 10px | | float_width = 10px | ||
| x = 95 | |||
| x = | | y = 80 | ||
| y = | }}</pre> | ||
}} | |- | ||
</ | |<div style="float: left;"> | ||
{{Superimpose | |||
| base = US_Locator_Blank.svg | |||
<div style=" | |||
{{Superimpose| base = US_Locator_Blank.svg | |||
| base_width = 288px | | base_width = 288px | ||
| base_alt = Located in north central Colorado, which in turn is just west of the center of the U.S. | |||
| base_caption = United States Locator Map | | base_caption = United States Locator Map | ||
| float = | | float = Red pog.svg | ||
| float_width = 10px | | float_width = 10px | ||
| x = 95 | |||
| x = | | y = 80 | ||
| y = | }}</div> | ||
}} | |} | ||
{{clear}} | |||
</div> | |||
=== Using the Template === | === Using the Template === | ||
| Line 39: | Line 36: | ||
To get started, you can simply copy this blank definition into your page, and fill in the data. | To get started, you can simply copy this blank definition into your page, and fill in the data. | ||
<pre> | <pre style="width: 15em;"> | ||
{{Superimpose| base = | {{Superimpose | ||
| base = | |||
| base_width = | |||
| base_alt = | |||
| base_caption = | |||
| float = | |||
| float_width = | |||
| x = | |||
| y = | |||
}} | |||
</pre> | |||
The following blank definition includes all the parameters, including those less-commonly used. | |||
<pre style="width: 15em;"> | |||
{{Superimpose | |||
| base = | |||
| base_width = | | base_width = | ||
| base_alt = | |||
| base_caption = | | base_caption = | ||
| base_link = | |||
| float = | | float = | ||
| float_alt = | |||
| float_width = | | float_width = | ||
| float_caption = | | float_caption = | ||
| float_link = | |||
| x = | | x = | ||
| y = | | y = | ||
| Line 53: | Line 70: | ||
=== Parameter Definitions === | === Parameter Definitions === | ||
* '''base:''' File name of the base ( | * '''base:''' File name of the base (underlying) image. | ||
* '''base_width:''' Width to display the base image, '' | * '''base_width:''' Width to display the base image, in [[w:pixel|pixel]]s. | ||
* '''base_caption:''' Text to show when | * '''base_alt:''' [[w:Alt text|Alt text]] for the image, for visually users; see [[WP:ALT]]. This should describe the composite image. | ||
* '''float:''' File name of the | * '''base_caption:''' Text to show when the mouse courser hovers over the base image; ignored if '''base_link''' is specified to be empty. | ||
* '''float_width:''' Width to display the | * '''base_link:''' Name of page that the user will be sent to if they click on the base image. The special value "<code>file:</code>", stands for the file page for the base image. If empty, nothing happens if the user clicks on the base image. The default is "<code>file:</code>". | ||
* '''float_caption:''' | * '''float:''' File name of the superimposed image. | ||
* '''x:''' distance to offset the | * '''float_width:''' Width to display the superimposed image, in pixels. | ||
* '''y:''' distance to offset the top image from the top edge of the base image, | * '''float_alt:''' Alt text for the superimposed image. This is needed only if '''float_link''' is nonempty. Normally the alt text for the base image describes the combination of the two images, and this parameter is not needed. | ||
* '''float_caption:''' Text to show when the mouse courser hovers over the superimposed image; ignored if '''float_link''' is missing or empty | |||
* '''float_link:''' Name of page that the user will be sent to if they click on the superimposed image. This acts like '''base_link''', except it is for the top image, and it defaults to empty. | |||
* '''x:''' distance to offset the left edge of the superimposed image from the left edge of the base image, in pixels or any other [http://w3schools.com/cssref/css_units.asp CSS units]. | |||
* '''y:''' distance to offset the top edge of the superimposed image from the top edge of the base image, in pixels or any other CSS units. | |||
<includeonly> | <includeonly> | ||
[[Category:Formatting templates]] | |||
[[Category: | |||
</includeonly> | </includeonly> | ||
Latest revision as of 10:46, 13 June 2013
{{Superimpose}} is a utility template which superimposes one image on top another. The position of the superimposed image is relative to the top left corner of the underlying image. It is often used to display a location mark on a map image, but it can be used with any two images.
Usage
Example
{{Superimpose
| base = US_Locator_Blank.svg
| base_width = 288px
| base_alt = Located in north central Colorado, which is just west of the center of the U.S.
| base_caption = United States Locator Map
| float = Red pog.svg
| float_width = 10px
| x = 95
| y = 80
}}
|
  |
Using the Template
To get started, you can simply copy this blank definition into your page, and fill in the data.
{{Superimpose
| base =
| base_width =
| base_alt =
| base_caption =
| float =
| float_width =
| x =
| y =
}}
The following blank definition includes all the parameters, including those less-commonly used.
{{Superimpose
| base =
| base_width =
| base_alt =
| base_caption =
| base_link =
| float =
| float_alt =
| float_width =
| float_caption =
| float_link =
| x =
| y =
}}
Parameter Definitions
- base: File name of the base (underlying) image.
- base_width: Width to display the base image, in pixels.
- base_alt: Alt text for the image, for visually users; see WP:ALT. This should describe the composite image.
- base_caption: Text to show when the mouse courser hovers over the base image; ignored if base_link is specified to be empty.
- base_link: Name of page that the user will be sent to if they click on the base image. The special value "
file:", stands for the file page for the base image. If empty, nothing happens if the user clicks on the base image. The default is "file:". - float: File name of the superimposed image.
- float_width: Width to display the superimposed image, in pixels.
- float_alt: Alt text for the superimposed image. This is needed only if float_link is nonempty. Normally the alt text for the base image describes the combination of the two images, and this parameter is not needed.
- float_caption: Text to show when the mouse courser hovers over the superimposed image; ignored if float_link is missing or empty
- float_link: Name of page that the user will be sent to if they click on the superimposed image. This acts like base_link, except it is for the top image, and it defaults to empty.
- x: distance to offset the left edge of the superimposed image from the left edge of the base image, in pixels or any other CSS units.
- y: distance to offset the top edge of the superimposed image from the top edge of the base image, in pixels or any other CSS units.