Websites
/
lektor-website
mirror of https://github.com/lektor/lektor-website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added documentation for cropping

This commit is contained in:
Armin Ronacher 2016-03-10 12:27:44 +01:00
parent 46194503c6
commit c2850b17ba
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
content/docs/api/db/record/thumbnail/contents.lr
View File

@ -4,7 +4,7 @@ summary: Creates a thumbnail for an image.
--- ---
type: method type: method
--- ---
signature: width, height=None signature: width, height=None, crop=False
--- ---
body: body:
@ -12,6 +12,11 @@ This method is available on attachments that are images and can be used to
automatically generate a thumbnail. The return value is a thumbnail proxy automatically generate a thumbnail. The return value is a thumbnail proxy
that can be either use directly or with the `|url` filter. that can be either use directly or with the `|url` filter.
If cropping is not enabled the thumbnail is scaled down to fit into the
given reactangle of width and height. If height is not specified it will
match the width and the height is set accordingly. If cropping is enabled
it's cropped around the edges to fit into the center.
It provides the following attributes: It provides the following attributes:
* `width`: the thumbnail width in pixels. * `width`: the thumbnail width in pixels.
@ -19,6 +24,9 @@ It provides the following attributes:
* `url_path` the URL path of the thumbnail. This is absolute and needs to * `url_path` the URL path of the thumbnail. This is absolute and needs to
be made relative with the `|url` filter. be made relative with the `|url` filter.
!!! Starting with Lektor 2.0 you can also pass `crop=True` to crop the image
to the exact dimensions provided instead of scaling it uncropped.
## Example ## Example
```html+jinja ```html+jinja