Template:Superimpose/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(tweaked discription of location map templates)
(tweaked)
Line 73: Line 73:
=== Parameter Definitions ===
=== Parameter Definitions ===


* '''base:''' File name of the base (bottom) image
* '''base:''' File name of the base (underlying) image
* '''base_width:''' Width to display the base image, ''in pixels''
* '''base_width:''' Width to display the base image, ''in pixels''
* '''base_alt:''' [[Alt text]] for the image, for visually impaired readers; see ''[[Wikipedia:Alternative text for images]]''. This normally describes the combination of the two images.
* '''base_alt:''' [[Alt text]] for the image, for visually impaired readers; see [[WP:ALT]]. This should describe the combination of the two images.
* '''base_caption:''' Text to show when a user's mouse hovers over the base image; ignored if '''base_link''' is specified to be empty
* '''base_caption:''' Text to show when the mouse courser user hovers over the base image; ignored if '''base_link''' is specified to be empty
* '''base_link:''' Name of page that the user should 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>".
* '''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:'''  File name of the top image
* '''float:'''  File name of the image to be superimposed.
* '''float_width:'''  Width to display the top image, ''in pixels''
* '''float_width:'''  Width to display the superimposed image, ''in pixels''
* '''float_alt:''' Alt text for the top 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_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 a user's mouse hovers over the top image; ignored if '''float_link''' is missing or empty
* '''float_caption:''' Text to show when the mouse courser user hovers over the superimposed image; ignored if '''float_link''' is missing or empty
* '''float_link:''' Name of page that the user should be sent to if they click on the top image. This acts like '''base_link''', except it is for the top image, and it defaults to 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 top image from the left edge of the base image, ''in pixels or any other CSS-standard units''
* '''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-standard units''
* '''y:''' distance to offset the top image from the top edge of the base image, ''in pixels or any other CSS-standard 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-standard units''
 
=== A Note about the Locator Dot ===
 
I originally built this template thinking I could use an SVG file with transparency (mostly for the dot in locator maps). However, it seems Internet Explorer users can't handle transparent PNGs without a fix that Wikimedia's not yet delivering, so for now I recommend using the GIF version in the example above. When IE better supports PNGs, we can swap the better format back in.
&mdash;[[User:Papayoung|Papayoung]] [[User_talk:Papayoung|&#9775;]] 02:06, 26 October 2005 (UTC)


== See also ==
== See also ==
* {{tl|Annotated image}}, allows text notes to overlap image, allows cropping
* {{tl|Annotated image}}, allows text notes to overlap image, allows cropping
* {{tl|Superimpose2}}, supports more layer superimposition.
* {{tl|Superimpose2}}, supports more layer superimposition.
* {{tl|Location map}}, places a mark on a map at the specified geographical coordinates.
* {{tl|Location map}}, places one mark on a map at the specified geographical coordinates.
* {{tl|Location map+}}, places one or more marks on a map at the specified geographical coordinates.
* {{tl|Location map+}}, places one or more marks on a map at the specified geographical coordinates.
* {{tl|Lageplan}}, related template to Location map with specific features
* {{tl|Location mark}}, places one mark on a map using relative coordinates.
* {{tl|Location mark+}}, one or more marks on a map using relative coordinates.
* {{tl|Lageplan}}, related template which superimposes one image on another with different features
 
<includeonly>
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
<!-- ADD CATEGORIES BELOW THIS LINE -->

Revision as of 21:27, 12 August 2011


{{Superimpose/doc}} is a utility which superimposes one image over another, and positions it relative to the top left corner of the bottom image. Although the original idea was to place a dot on a locator map based on editable coordinates, it can be used to precisely overlay any two images for any reason.

Usage

Example

Located in north central Colorado, which in turn is just west of the center of the U.S.
{{Superimpose
  | base = US_Locator_Blank.svg
  | 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
  | float = Red Dot.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 impaired readers; see WP:ALT. This should describe the combination of the two images.
  • base_caption: Text to show when the mouse courser user 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 image to be superimposed.
  • 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 user 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-standard 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-standard units

See also

  • {{Annotated image}}, allows text notes to overlap image, allows cropping
  • {{Superimpose2}}, supports more layer superimposition.
  • {{Location map}}, places one 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 one mark on a map using relative coordinates.
  • {{Location mark+}}, one or more marks on a map using relative coordinates.
  • {{Lageplan}}, related template which superimposes one image on another with different features