Difference between revisions of "Template:Superimpose/doc"

Latest revision as of 00:58, 18 July 2019

{{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 1

{{Superimpose | base = Clearcut minimap.jpg | base_width = 700px | base_alt = Minimap for Clearcut with the MWLL Logo in the bottom left. | base_caption = Clearcut Minimap with Logo | float = MWLL- logo180.png | float_width = 60px | x = 15 | y = 625 }} }}

Example 2

{{Superimpose | align = center | base = TC_DustBowl_minimap.jpg | width = 350px | base_link = TC_DustBowl_minimap.jpg | float = Loc Minimap overlay1.png | float_link = Minimap overlay1.png }}

Using the Template

To get started, you can simply copy this blank definition into your page, and fill in the data.

{{Superimpose
  | align = 
  | base = 
  | base_width = 
  | base_alt = 
  | base_caption = 
  | float = 
  | float_width = 
  | x = 
  | y = 
}}

{{Superimpose
  | align = 
  | width = 
  | base = 
  | float = 
  | float_caption =
}}

The following blank definition includes all the parameters, including those less-commonly used.

{{Superimpose
  | align = 
  | width = 
  | base = 
  | base_width = 
  | base_alt = 
  | base_caption = 
  | base_link = 
  | float = 
  | float_alt = 
  | float_width = 
  | float_caption = 
  | float_link = 
  | x = 
  | y = 
}}

Parameter Definitions

• align: left, right, center, or none
• base: File name of the base (underlying) image.
• base_width: Width to display the base image, in pixels. If not specified, then defaults to the width.
• 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. If not specified, then defaults to the width.
• 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.
• width: Default width for both the base and float. This is not required if base_width and float_width are both specified.
• 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.

Tracking category

• Category:Pages using superimpose with unknown parameters (0)

See also

• {{Annotated image}}, allows text notes to overlap image, allows cropping
• {{Superimpose2}}, supports more layer superimposition.
• {{Location map}}, places a mark on a map at the specified geographical coordinates.
• {{Location map+}}, places one or more marks on a map at the specified geographical coordinates.
• {{Location mark}}, places a mark on a map using relative coordinates.
• {{Location mark+}}, one or more marks on a map using relative coordinates.
• {{Site plan}}, related template which superimposes one image on another with different features
• {{Overlay}}, allows multiple annotations to be placed over an image with a legend