Difference between revisions of "Template:CSS image crop/doc"

From blackwiki
Jump to navigation Jump to search
imported>Edokter
(For security reasons, we should not link to,or transclude user scripts.)
imported>Codehydro
(clarify purpose of Link/magnify-link; note about using Annotated image)
Line 8: Line 8:
 
<pre>
 
<pre>
 
{{CSS image crop
 
{{CSS image crop
|Image        = The Name of the image
+
|Image        = The Name of the image file, or may accept {{Annotated image}}.
 
|bSize        = The Base Image size (the image we are cropping on)
 
|bSize        = The Base Image size (the image we are cropping on)
 
|cWidth        = Crop Image Width in pixels
 
|cWidth        = Crop Image Width in pixels
Line 18: Line 18:
 
                 When description is blank, location on left (as is default for non-thumbs)
 
                 When description is blank, location on left (as is default for non-thumbs)
 
|Description  = Description (will render out using thumbnail class)
 
|Description  = Description (will render out using thumbnail class)
|Link          = The page linked to by the image (should usually be omitted)
+
|Link          = Name of an article to be linked by clicking on the image (omit unless there is a good reason to link to an article instead of the image).
 +
|magnify-link  = The image to be linked by the magnify icon (Use if the Image parameter is set to {{Annotated image}} or the Link parameter leads to something other than the image).
 
|Alt          = The alt text for the image
 
|Alt          = The alt text for the image
 
}}
 
}}
Line 68: Line 69:
 
* {{tl|Annotated image}}
 
* {{tl|Annotated image}}
 
** [[Template:Annotated image/doc/Samples#Cropping an image|with empty "annotations" parameter]]
 
** [[Template:Annotated image/doc/Samples#Cropping an image|with empty "annotations" parameter]]
 +
** {{t|IrinotecanPathway WP229}} (as used in article [[Multidrug resistance-associated protein 2]]), an example of how CSS Image Crop can combine with Annotated Image.
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |

Revision as of 16:39, 15 December 2014

{{CSS image crop}} creates a crop of an image inline for previewing the look and feel of a page. If the edit is committed these crops should be replaced with server side cropped images to avoid sending extra image data to people.

Note: There was a previous glitch for which some people had to use "tleft" "tright" etc as a workaround because "left" and "right" did not work. As a result, to avoid having to fix all those pages that used the workaround, the template has been designed to function properly regardless of whether tright or right is used. See template talk for details.

Usage

{{CSS image crop
|Image         = The Name of the image file, or may accept {{Annotated image}}.
|bSize         = The Base Image size (the image we are cropping on)
|cWidth        = Crop Image Width in pixels
|cHeight       = Crop image Height in pixels
|oTop          = Offset Top in pixels
|oLeft         = Offset Left in pixels
|Location      = 'right', 'left', 'center' or 'none'. Determines placement of the image on the page
                 Defaults to 'right' when description is provided (as is default for thumb images)
                 When description is blank, location on left (as is default for non-thumbs)
|Description   = Description (will render out using thumbnail class)
|Link          = Name of an article to be linked by clicking on the image (omit unless there is a good reason to link to an article instead of the image).
|magnify-link  = The image to be linked by the magnify icon (Use if the Image parameter is set to {{Annotated image}} or the Link parameter leads to something other than the image).
|Alt           = The alt text for the image
}}

Examples

Dew image with center formatting:

A drop of dew on grass (focus on the drop)
A drop of dew on grass (focus on the drop)
{{CSS image crop
|Image = Dew on grass Luc Viatour.jpg
|bSize = 400
|cWidth = 100
|cHeight = 100
|oTop = 180
|oLeft = 60
|Location = center
|Description = A drop of dew on grass (focus on the drop)
}}

You may also omit the Location and Description parameters to get:

Dew on grass Luc Viatour.jpg
{{CSS image crop
|Image = Dew on grass Luc Viatour.jpg
|bSize = 400
|cWidth = 100
|cHeight = 100
|oTop = 180
|oLeft = 60
}}

See also