-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathREADME.txt
194 lines (137 loc) · 6.75 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
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
183
184
185
186
187
188
189
190
191
192
193
194
*******************
sc.galleria.support
*******************
.. contents:: Table of Contents
Overview
--------
**sc.galleria.support** provides simple gallery integration for Plone.
Using in a Plone Site
----------------------
Step 1: Activate it
^^^^^^^^^^^^^^^^^^^^
Go to the 'Site Setup' page in the Plone interface and click on the
'Add/Remove Products' link.
Choose the product **sc.galleria.support** (check checkbox at its left side)
and click the 'Activate' button.
Step 2: Setting preferences
^^^^^^^^^^^^^^^^^^^^^^^^^^^
In 'Site setup' below on 'Add-on Configuration' click on 'Galleria' option. In
this section you can see several options wich are categorized in different
types. Each type is visualized in a tab. You have options for 'Default',
'Flickr Plugin', 'Picasa Plugin', 'FaceBook Plugin' and 'History Plugin'.
To know how to setup this preferences in a way to go better to your needs see
`Functionality`_ section.
Step 3: Seeing it in action
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Galleria will be rendered through a set of the display action in a container
content type. For example, if you have a folder named "My folder" and you are
standing there, click on "Display" (you need permissions for the edit bar) and
then in "Galleria". Of course, this will only have an effect if you have
images inside that folder. If you do, you will see the images render with the
Galleria plugin.
For the case that you want to fetch pictures located in flickr or picasa see
`Flickr, Picasa & Facebook Plugins`_. To activate Galleria in the Link just follow the
same procedure with the display action.
Functionality
--------------
The next explanations about different options must be applied in the control
panel of Galleria add-on. See `Step 2: Setting preferences`_.
Default options
^^^^^^^^^^^^^^^
In this section you have all the basic options to set how the layout of your
galleria will look like.
**Auto play:**
This will start playing the slideshow with 5 seconds interval.
**Show informations:**
Displays the caption.
**Gallery width:**
You can use this option to set a gallery width manually. Default is 500
px.
**Gallery height:**
You can use this option to set a gallery height manually. Default is 500
px.
**Image css position:**
Positions the main image inside the stage container. Works like the CSS
background-position property, f.ex ‘top right’ or ‘20% 100%’. You can use keywords, percents or pixels. The first
value is the horizontal position and the second is the vertical.
- Read more about positioning at http://www.w3.org/TR/REC-CSS1/#background-position
**Enable lightbox:**
This option acts as a helper for attaching a lightbox when the user clicks
on an image. If you have a link defined for the image, the link will take
precedence.
**Show counting:**
Displays the counter.
**Transitions:**
The transition that is used when displaying the images. There are
different transitions in Galleria.
Flavors are:
- *fade* - crossfade betweens images.
- *flash* - fades into background color between images.
- *pulse* - quickly removes the image into background color, then fades the next image.
- *slide* - slides the images depending on image position.
- *fadeslide* - fade between images and slide slightly at the same time.
**Transition Speed:**
The milliseconds used in the animation when applying the transition. The
higher number, the slower transition.
**Wait:**
Sets how long Galleria should wait when trying to extract measurements,
before throwing an error. Default is 5000
**Show image navigation:**
Displays the image navigation (next/prev arrows).
**Swipe:**
Enables a swipe movement for flicking through images on touch devices.
**Selector jQuery:**
Eg. '#content-core' or '#content' or '.galleria'. Do not change if you do
not know what I mean.
**Show Thumbnails:**
Sets the creation of thumbnails.
**Enable image crop:**
Defines how the main image will be cropped inside it’s container. This option
also is valid to fullscreen mode.
true means that all images will be scaled to fill the stage, centered and cropped.
false will scale down so the entire image fits.
**Sets Gallery in responsive mode:**
This option sets thew Gallery in responsive mode. That means that it will resize
the entire container if your CSS is dynamic. In other words, you can add media
queries or dynamic proportions in your CSS and the gallery will follow these proportions
as the window resizes.
**Enable debug mode:**
This option is for turning debug on/off. By default, Galleria displays
errors by printing them out in the gallery container and sometimes throw
exceptions. For deployment you can turn debug off to generate a more
generic error message if a fatal error is raised.
YouTube, Vimeo & DailyMotion supported
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To use this supports you have to create a 'Link' content type and in the 'url'
field set the movie url.
- **YouTube:** Sets options for the YouTube player.
- **Vimeo:** Sets options for the Vimeo player.
- **DailyMotion** Adds player options for the Daliymotion video player.
Flickr, Picasa & Facebook Plugins
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To use this plugins you have to create a 'Link' content type and in the 'url'
field set the galleria url that looks something like:
- **Flickr:** 'http://www.flickr.com/photos/user_id/sets/galleria_id/'
- **Picasa:** 'https://picasaweb.google.com/user_id/galleria_id'
- **FaceBook:** 'http://www.facebook.com/media/set/?set=a.album_id'
**Enable plugin:** activate this function.
**Maximum number of photos:** you can set the maximum of photos to show.
**Show description:** Fetch the description. The plugin fetches the title per
default.
History Plugin
^^^^^^^^^^^^^^
The Galleria History plugin is a simple extension to create Galleria add hash
tags for permalinks and back button functionality enabled. This is useful on
fullscreen views and other use cases. The plugin simply adds a #/[id] hash to
the URL and then applies the necessary code for all browsers to enable the
back button. It also makes permalinks possible by simply bookmarking f.ex
http://mygalleria.com/#/4 and the user will be shown the 5th image in the
gallery (index starts at 0).
Browser support includes Firefox 2+, IE6+, Ipad, Opera and Chrome.
You enable it with the **Enable history plugin** option.
Mostly Harmless
---------------
.. image:: https://secure.travis-ci.org/simplesconsultoria/sc.galleria.support.png
:target: http://travis-ci.org/simplesconsultoria/sc.galleria.support
Have an idea? Found a bug? Let us know by `opening a support ticket`_.
.. _`opening a support ticket`: https://github.com/simplesconsultoria/sc.galleria.support/issues