Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 145 lines (103 sloc) 4.212 kb
321a71b @avoinea Refs #5497 - Rename eea.imagescales to eea.depiction
avoinea authored
1 =============
2 EEA Depiction
3 =============
aca06a7 @avoinea Refs #9582 - Add build status icons for eea.depiction
avoinea authored
4 .. image:: http://ci.eionet.europa.eu/job/eea.depiction-www/badge/icon
5 :target: http://ci.eionet.europa.eu/job/eea.depiction-www/lastBuild
6 .. image:: http://ci.eionet.europa.eu/job/eea.depiction-plone4/badge/icon
7 :target: http://ci.eionet.europa.eu/job/eea.depiction-plone4/lastBuild
8
9 Introduction
10 ============
321a71b @avoinea Refs #5497 - Rename eea.imagescales to eea.depiction
avoinea authored
11 `EEA Depiction`_ (formerly valentine.imagescales) is a generic system for
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
12 creating thumbnails/image representations for content types,
aca06a7 @avoinea Refs #9582 - Add build status icons for eea.depiction
avoinea authored
13 both those provided by Plone, and custom ones.
9bec750 @ichim-david Fixes #5601; added readme information about dexterity not working with t...
ichim-david authored
14
aca06a7 @avoinea Refs #9582 - Add build status icons for eea.depiction
avoinea authored
15 At the moment this system is implemented and tested only on Archetypes
9bec750 @ichim-david Fixes #5601; added readme information about dexterity not working with t...
ichim-david authored
16 content types, however this system could be adapted in a later version
17 to work also for dexterity content types.
18
19 To make it work for a content type, three adapters need to be provided:
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
20
21 1. ImageView that retrieves an image in the desired scale.
22 2. ImageTag that returns the HTML tag for the image
23 3. ImageLink that returns the HTML link to the image.
24
25
4df2b22 @ichim-david Refs #5601; added upgrade steps and documentation for the overrides we d...
ichim-david authored
26 Upgrade notes
27 =============
28
aca06a7 @avoinea Refs #9582 - Add build status icons for eea.depiction
avoinea authored
29 As of **eea.depiction 5.2** we customize the following resources in order to
4df2b22 @ichim-david Refs #5601; added upgrade steps and documentation for the overrides we d...
ichim-david authored
30 display any items in thumbnail listings:
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
31
aca06a7 @avoinea Refs #9582 - Add build status icons for eea.depiction
avoinea authored
32 1. **atctListAlbum.py** - which is responsible for displaying items in
4df2b22 @ichim-david Refs #5601; added upgrade steps and documentation for the overrides we d...
ichim-david authored
33 *atct_album_view.pt*
aca06a7 @avoinea Refs #9582 - Add build status icons for eea.depiction
avoinea authored
34 2. **thumbnail_view.pt** - which is the browser template responsible for
4df2b22 @ichim-david Refs #5601; added upgrade steps and documentation for the overrides we d...
ichim-david authored
35 thumbnail listing for the *plone.app.collection* package
36
37 .. contents::
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
38
39 Installation
40 ============
41
42 zc.buildout
43 -----------
44 If you are using `zc.buildout`_ and the `plone.recipe.zope2instance`_
45 recipe to manage your project, you can do this:
46
47 * Update your buildout.cfg file:
48
321a71b @avoinea Refs #5497 - Rename eea.imagescales to eea.depiction
avoinea authored
49 * Add ``eea.depiction`` to the list of eggs to install
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
50 * Tell the `plone.recipe.zope2instance`_ recipe to install a ZCML slug
51
52 ::
53
54 [instance]
55 ...
56 eggs =
57 ...
321a71b @avoinea Refs #5497 - Rename eea.imagescales to eea.depiction
avoinea authored
58 eea.depiction
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
59
60 zcml =
61 ...
b08f54e @avoinea Refs #5497 - Update eea.depiction README.txt
avoinea authored
62 eea.depiction-overrides
321a71b @avoinea Refs #5497 - Rename eea.imagescales to eea.depiction
avoinea authored
63 eea.depiction
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
64
65 * Re-run buildout, e.g. with::
66
67 $ ./bin/buildout
68
69 You can skip the ZCML slug if you are going to explicitly include the package
70 from another package's configure.zcml file.
71
72
57f930f @avoinea Refs #5497 - Refactoring hardcoded fallback interfaces vocabulary
avoinea authored
73 How to specify fallback preview images
74 ======================================
75 eea.depiction 0.3 introduces the concept of fallback images when the regular
76 image traversal fails. The logic works like this:
77
78 1. Look for an image returned by the contexts 'imgview' adapter
79 2. If the imgview crashes, isn't found or can not locate/generate an image,
80 we continue by checking if there's an image specified for any of the
81 contexts interfaces.
82 3. If there's no fallback image, we look for an image for the context
83 portal type, e.g. article, news-item, document. This should be placed
84 in the 'portal_depiction' utility (Site Setup > Depiction Library)
85 4. Uses the generic content type image, i.e. portal_depiction/generic
86
87 Thus:
88
89 1. To map a fallback image to a portal type, place it in this folder and name
90 it after the portal type.
91 2. To map a fallback image to an interface just add a named-utility for
92 IDepictionVocabulary (see eea.depiction.vocabularies)
93
94
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
95 Dependencies
77d4840 move from valentine repository
svincic authored
96 ============
97
321a71b @avoinea Refs #5497 - Rename eea.imagescales to eea.depiction
avoinea authored
98 `EEA Depiction`_ has the following dependencies:
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
99 - Plone 4+
b08f54e @avoinea Refs #5497 - Update eea.depiction README.txt
avoinea authored
100 - Pillow
4e78ace @avoinea Refs #5497 - Made p4a.video dependency optional.
avoinea authored
101
102 This package also supports p4a.video. Thus the following dependencies are optional:
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
103 - p4a.video
104
b08f54e @avoinea Refs #5497 - Update eea.depiction README.txt
avoinea authored
105 ::
106
107 [instance]
108 ...
109 eggs =
110 ...
111 eea.depiction [full]
112
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
113
114 Source code
115 ===========
116
117 Latest source code (Plone 4 compatible):
321a71b @avoinea Refs #5497 - Rename eea.imagescales to eea.depiction
avoinea authored
118 - http://github.com/eea/eea.depiction
119 - http://github.com/collective/eea.depiction
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
120
121
122 Copyright and license
123 =====================
124 The Initial Owner of the Original Code is European Environment Agency (EEA).
125 All Rights Reserved.
126
631a7cd @demarant Update README.txt
demarant authored
127 The eea.depiction (the Original Code) is free software;
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
128 you can redistribute it and/or modify it under the terms of the GNU
129 General Public License as published by the Free Software Foundation;
130 either version 2 of the License, or (at your option) any later
131 version.
132
133 More details under docs/License.txt
134
135
631a7cd @demarant Update README.txt
demarant authored
136 Funding and project management
137 ==============================
77d4840 move from valentine repository
svincic authored
138
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
139 EEA_ - European Environment Agency (EU)
77d4840 move from valentine repository
svincic authored
140
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
141 .. _EEA: http://www.eea.europa.eu/
321a71b @avoinea Refs #5497 - Rename eea.imagescales to eea.depiction
avoinea authored
142 .. _`EEA Depiction`: http://eea.github.com/docs/eea.depiction
0912fb9 @avoinea - Update docs and cleanup patches.
avoinea authored
143 .. _`plone.recipe.zope2instance`: http://pypi.python.org/pypi/plone.recipe.zope2instance
144 .. _`zc.buildout`: http://pypi.python.org/pypi/zc.buildout
Something went wrong with that request. Please try again.