1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
********
Examples
********
Template examples
=================
.. highlight:: html+django
All of the examples assume that you first load the ``thumbnail`` template tag in
your template::
{% load thumbnail %}
Simple::
{% thumbnail item.image "100x100" crop="center" as im %}
<img src="{{ im.url }}" width="{{ im.width }}" height="{{ im.height }}">
{% endthumbnail %}
Crop using margin filter, x, y aliases::
{% thumbnail item.image "100x700" as im %}
<img style="margin:{{ im|margin:"100x700" }}" src="{{ im.url }}" width="{{ im.x }}" height="{{ im.y }}">
{% endthumbnail %}
Using external images and advanced cropping::
{% thumbnail "http://www.aino.se/media/i/logo.png" "40x40" crop="80% top" as im %}
<img src="{{ im.url }}">
{% endthumbnail %}
Using the empty feature, the empty section is rendered when the source is
resolved to an empty value or an invalid image source, you can think of it as
rendering when the thumbnail becomes undefined::
{% thumbnail item.image my_size_string crop="left" as im %}
<img src="{{ im.url }}">
{% empty %}
<p>No image</p>
{% endthumbnail %}
Nesting tags and setting size (geometry) for width only::
{% thumbnail item.image "1000" as big %}
{% thumbnail item.image "50x50" crop="center" as small %}
<a href="{{ big.url}}" title="look ma!"><img src="{{ small.url }}"></a>
{% endthumbnail %}
{% endthumbnail %}
Setting geometry for height only::
{% thumbnail item.image "x300" as im %}
<img src="{{ im.url }}">
{% endthumbnail %}
Setting format and using the is_portrait filter::
{% if item.image|is_portrait %}
<div class="portrait">
{% thumbnail item.image "100" crop="10px 10px" format="PNG" as im %}
<img src="{{ im.url }}">
{% endthumbnail %}
</div>
{% else %}
<div class="landscape">
{% thumbnail item.image "50" crop="bottom" format="PNG" as im %}
<img src="{{ im.url }}">
{% endthumbnail %}
</div>
<div>
<p>Undefined behaviour</p>
</div>
{% endif %}
Using HTML filter::
{{ text|html_thumbnails }}
Using markdown filter::
{{ text|markdown_thumbnails }}
.. highlight:: python
Model examples
==============
Using the ImageField that automatically deletes references to itself in the key
value store and its thumbnail references when deleted::
from django.db import models
from sorl.thumbnail import ImageField
class Item(models.Model):
image = ImageField(upload_to='whatever')
.. note:: You do not need to use the ``sorl.thumbnail.ImageField`` to use
``sorl.thumbnail``. The standard ``django.db.models.ImageField`` is fine
except that using the ``sorl.thumbnail.ImageField`` lets you plugin the
nice admin addition explained in the next section.
Another example on how to use ``sorl.thumbnail.ImageField`` in your existing
project with only small code changes::
# util/models.py
from django.db.models import *
from sorl.thumbnail import ImageField
# myapp/models.py
from util import models
class MyModel(models.Model):
logo = models.ImageField(upload_to='/dev/null')
Admin examples
==============
Recommended usage using ``sorl.thumbnail.admin.AdminImageMixin`` (note that this requires use of ``sorl.thumbnail.ImageField`` in your models as explained above)::
# myapp/admin.py
from django.contrib import admin
from myapp.models import MyModel
from sorl.thumbnail.admin import AdminImageMixin
class MyModelAdmin(AdminImageMixin, admin.ModelAdmin):
pass
And the same thing For inlines::
# myapp/admin.py
from django.contrib import admin
from myapp.models import MyModel, MyInlineModel
from sorl.thumbnail.admin import AdminImageMixin
class MyInlineModelAdmin(AdminImageMixin, admin.TabularInline):
model = MyInlineModel
class MyModelAdmin(admin.ModelAdmin):
inlines = [MyInlineModelAdmin]
Easy to plugin solution example with little code to change::
# util/admin.py
from django.contrib.admin import *
from sorl.thumbnail.admin import AdminImageMixin
class ModelAdmin(AdminImageMixin, ModelAdmin):
pass
class TabularInline(AdminImageMixin, TabularInline):
pass
class StackedInline(AdminImageMixin, StackedInline):
pass
# myapp/admin.py
from util import admin
from myapp.models import MyModel
class MyModelAdmin(admin.ModelAdmin):
pass
Low level API examples
======================
How to get make a thumbnail in your python code::
from sorl.thumbnail import get_thumbnail
im = get_thumbnail(my_file, '100x100', crop='center', quality=99)
How to delete a file, its thumbnails as well as references in the Key Value
Store::
from sorl.thumbnail import delete
delete(my_file)
|
