forked from eea/eea.depiction
/
README.txt
122 lines (86 loc) · 3.26 KB
/
README.txt
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
=============
EEA Depiction
=============
`EEA Depiction`_ (formerly valentine.imagescales) is a generic system for
creating thumbnails/image representations for content types,
both those provided by Plone, and custom ones. To make it work for a content
type, three adapters need to be provided:
1. ImageView that retrieves an image in the desired scale.
2. ImageTag that returns the HTML tag for the image
3. ImageLink that returns the HTML link to the image.
.. contents::
Installation
============
zc.buildout
-----------
If you are using `zc.buildout`_ and the `plone.recipe.zope2instance`_
recipe to manage your project, you can do this:
* Update your buildout.cfg file:
* Add ``eea.depiction`` to the list of eggs to install
* Tell the `plone.recipe.zope2instance`_ recipe to install a ZCML slug
::
[instance]
...
eggs =
...
eea.depiction
zcml =
...
eea.depiction-overrides
eea.depiction
* Re-run buildout, e.g. with::
$ ./bin/buildout
You can skip the ZCML slug if you are going to explicitly include the package
from another package's configure.zcml file.
How to specify fallback preview images
======================================
eea.depiction 0.3 introduces the concept of fallback images when the regular
image traversal fails. The logic works like this:
1. Look for an image returned by the contexts 'imgview' adapter
2. If the imgview crashes, isn't found or can not locate/generate an image,
we continue by checking if there's an image specified for any of the
contexts interfaces.
3. If there's no fallback image, we look for an image for the context
portal type, e.g. article, news-item, document. This should be placed
in the 'portal_depiction' utility (Site Setup > Depiction Library)
4. Uses the generic content type image, i.e. portal_depiction/generic
Thus:
1. To map a fallback image to a portal type, place it in this folder and name
it after the portal type.
2. To map a fallback image to an interface just add a named-utility for
IDepictionVocabulary (see eea.depiction.vocabularies)
Dependencies
============
`EEA Depiction`_ has the following dependencies:
- Plone 4+
- Pillow
This package also supports p4a.video. Thus the following dependencies are optional:
- p4a.video
::
[instance]
...
eggs =
...
eea.depiction [full]
Source code
===========
Latest source code (Plone 4 compatible):
- http://github.com/eea/eea.depiction
- http://github.com/collective/eea.depiction
Copyright and license
=====================
The Initial Owner of the Original Code is European Environment Agency (EEA).
All Rights Reserved.
The eea.depiction (the Original Code) is free software;
you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation;
either version 2 of the License, or (at your option) any later
version.
More details under docs/License.txt
Funding and project management
==============================
EEA_ - European Environment Agency (EU)
.. _EEA: http://www.eea.europa.eu/
.. _`EEA Depiction`: http://eea.github.com/docs/eea.depiction
.. _`plone.recipe.zope2instance`: http://pypi.python.org/pypi/plone.recipe.zope2instance
.. _`zc.buildout`: http://pypi.python.org/pypi/zc.buildout