-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathreadme.txt
325 lines (254 loc) · 13.6 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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
=== PiwigoPress ===
Contributors: norbusan, vpiwigo
Tags: galleries, pictures, randomize, shortcode, gallery, integration, photos, drag, drop, widget, media, piwigo
Requires at least: 2.8.4
Tested up to: 4.9.4
Stable tag: 2.33
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
From any open API Piwigo gallery, swiftly include your photos in
Posts/Pages and/or add randomized thumbnails and menus in your sidebar.
== Description ==
On the one hand, PiwigoPress is a WordPress **Sidebar Widget** that links
your blog to some public pictures of a Piwigo gallery. Thus, a Piwigo
gallery with several public pictures in it is a prerequisite to make it
working. But even if you don't have one yet, you can nonetheless give this
plugin a try by using the Official Piwigo [demonstration gallery][] before
setting up your own gallery.
PiwigoPress generates several highly valuable links in sidebars of your
WordPress blog, all of them being optional: a thumbnail linking to
the corresponding picture page, menus directing to all albums defined
as public in the gallery, several additional links to most recent, most
viewed, most commented pictures, and more.
On the other hand, by using **a shortcode** [PiwigoPress ...] you can add
any public picture of a Piwigo gallery. Here again you should try even
though you don't have yet your Piwigo Gallery. Have a look with
[PiwigoPress id=72 url='http://piwigo.org/demo'] in a post or page.
Above all, PiwigoPress provides a shortcode **generator**. Each time you
add some pictures to your gallery you will be able to add a post related
to your last uploaded photos. So, your friends and family are going to
like your photos and Search Engines are going reference your gallery with
the refbacks provided by PiwigoPress.
When you've finished testing and want to create you own gallery, go to the
Piwigo [download page][], where you'll find all the links you might need.
Try "NetInstall" first. If it fails, switch to the "Package" download and
follow the full installation procedure. When ready, if you are a bit lost,
just try Photos add page sheets (Web form, Applications, FTP + Synchronization)
in your Piwigo gallery administration page.
Development of PiwigoPress is open to contributions, please use the
[github page][] for patches, bug reports, and issues.
[demonstration gallery]: http://piwigo.org/demo/ "The demonstration gallery"
[download page]: http://piwigo.org/basics/downloads "Piwigo download page"
[github page]: https://github.com/norbusan/piwigopress
== Installation ==
How to install manually PiwigoPress and get it working ? (automatic
installation is working perfectly).
1. Upload `PiwigoPress` complete folder to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Access to Widgets, draw PiwigoPress to the sidebar you want or create/update a post/page and click on the PP icon above the editor area.
4. Don't forget that any gallery URL is the folder address (ending with a slash ("/") where is ws.php is available.
5. The selected gallery Webservices have to be opened, and some public pictures have to be available (and unlocked).
Explanation of Plugin Widget data fields.
* Title: To use in the sidebar
* Local directory (if local): Piwigo installation directory (on the same website)
* (or) External gallery URL: URL to the gallery (if not local)
* Square, Thumbnail, XXS - tiny,... : see you Piwigo configuration [Photo sizes] admin page
* Orientation criteria : Any, portrait, landscape
* Link type: Where to open photos on clicks
* Sort order: select photos according to these criteria - by default descending (most recent for dates)
* Ascending order: if one want ascending order
* Number of pictures (0=none): Number of thumbnails to get
Optional parameters
* Album id (0=all): Pictures from a specific Piwigo album or from all
* Since X months (0=all): Age of posted picture
* Pre and post-code: raw html code that is added just before the images
* CSS DIV class: For your blog design
* CSS IMG class: For your blog design
* Album menu: Includes all links related to Piwigo albums
All below selectable option are special Piwigo links to include:
* Most visited
* Best rated
* Most commented (need a plugin in the client gallery)
* Random
* Recent pics
* Calendar
* Keywords
* Comments
Explanation of Plugin Shortcode attributes.
* id: (required) Photo Numeric identifier. It's also possible to specify several ids for one shortcode, e.g.: id='2,5-7,4'
* url: (mandadory for first usage in a post or to change to another) domaine or domaine/piwigo-folder
* size: (default size='la') 2 letters as sq(Square), (th)Thumbnail, (2s)XXS - tiny, (xs)XS - extra small, (sm)S - small,
(me)M - medium, (la)L - large, (xl)XL - extra large,(xx)XXL - huge : see you Piwigo configuration [Photo sizes] admin page
* class : (optional) additional CSS class selectors at DIV tag level (e.g. class="img-drop-cap img-shadow left")
* style: (optional) any additional CSS rules at DIV tag level (e.g. style="background-color: rgba(16, 64, 192, 0.05);")
* name: (0,1,auto) (0 by default) add the photo name in a blockquote from name field: 0 disables, 1 enables, 'auto' tries to show only names that do not look like auto-generated names (group of character followed by group of digits with optional picture extension coinciding with file name)
* desc: (0,1) (0 by default) add the photo description in a blockquote from description field
in the Edit photo [Properties] admin page if there is a filled description there
* lnktype: (string, default lnktype='picture') 'none' : no link, 'picture' : link to picture.php, 'album' : link to index.php/category, 'albumpicture' : link to picture.php within the album
* opntype: (string, default opntype='_blank') '_blank': open link in new window or tab, '_self': open link in same window/tab
"style" is not used by the Shortcode generator
== Frequently Asked Questions ==
= Widget (only): How can I get any thumbnails ? =
* Just have the URL without the /index.php? on the end.
* Just have recent pictures in the gallery.
* Change Since X months (0=all) from 12 to 0
* Set "Number of pictures (0=none)" to 1 or 2
* If it doesn't work, see the provided screenshots...
= How can I get other sizes ? I only have thumbs and squares. =
* In your gallery admin pages, find Configuration
and there select: Options > Photo sizes > Multiple size > show details
= How can I get squared thumbnails ? =
* maybe you should try to upgrade your gallery to Piwigo 2.4.x or above.
* See screenshots
= Widget (Only): With Link type Album which album would be selected ? =
If Album = 0 the link will remain to the picture page.
Otherwise, if Number of pictures > 0 the first picture will link the Album page, next pictures will refer to their picture page.
= Shortcode (Only): With Link type Album which album would be selected ? =
Picture is going to have a link to its most recent Album page (Upcoming releases should cover other cases).
= Shortcode generator (only): Why did I get a warning message ? =
* Message is "No available public picture or Piwigo release < 2.4.x" (Won't be translated)
* Disconnect you from the gallery and try to access to any Albums, maybe all pictures are locked or private
* Second possible cause: Old piwigo release. Only recent releases (2.4 and above) provide several picture sizes.
* Backward compatibility below Piwigo 2.4 is limited to Widget sidebar functions
= How do I arrange images horizontally? =
Since images are generated in the following way:
`````
<div id="..." class="PiwigoPress_photoblog">
<div class="PWGP_shortcode <something>">
...img...
</div>
</div>
`````
horizontal alignment can easily be achieved by adding the following code
to either custom css or child theme css:
`````
.PiwigoPress_photoblog {
display:inline-block;
}
.PWGP_shortcode {
display:inline-block;
}
`````
== Screenshots ==
1. Widget parameters for the demo gallery
2. Expected result in your sidebar
3. Widget parameters for your gallery (on the same domain)
4. Piwigo admin Photo sizes (from a Gallery website)
5. PiwigoPress shortcode samples
6. PiwigoPress shortcode generator above Post/Page editor usable with both Visual/HTML editor.
7. Buttons, Drag and Drop zones for a total intuitive interface.
8. Generation and insertion of the shortcodes are done at caret (insert cursor) position.
9. Expected result on your page or post of your Wordpress blog.
== Copyright/License ==
PiwigoPress WordPress Plugin
Copyright 2009-2012 VDigital
Copyright 2014-2024 Norbert Preining
Contributions by
Rüdiger Schulz 2015 (copyright transfered)
Anton Lavrov 2015
Anton Lavrov's contribution are under GPLv2+:
On Wed, 15 Jul 2015, Anton Lavrov wrote:
> Hi Norbert,
>
> I hereby confirm that my contributions are under GPLv2 or higher.
>
> Please let me know if this is not exactly the wording you need.
PiwigoPress is distributed under the terms of the GNU GPL version 2+
This program 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.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
== Changelog ==
= 2.33 =
* fix widget initialization for newer PHP versions
= 2.32 =
= 2.31 =
* relax requirement what image sizes galleries have to provide (Issue 21)
* allow selecting the order of photos for the widget (Issue 20)
= 2.30 =
* multiple image ids can be used in the shortcode (by Anton Lavrov)
* support for displaying the photo name (title) (by Anton Lavrov)
* shortcode generator - support name setting
* fix 'albumpicture' setting not being preserved
= 2.29 =
* security related improvements by Rüdiger Schulz, big thanks!
= 2.28 =
* use "album" instead of "category" in the user interface, as this is what Piwigo calls it (Issue 14)
* allow loading of albums from remote installations (Issue 13, 5)
= 2.27 =
* widget configuration now allows adding html code just before and after the included photos, but before the divs. This requires the 'unfiltered_html' permission for the user editing the widget.
= 2.26 =
* new parameter for widget and shortcode: opntype: '_blank' (open in new window/tab) or '_self' (open in same) (Issue 10)
* set alt parameter of images to 'name' (plus 'comment', if available) if the piwigo image (Issue 8)
* make widget configuration background white instead of transparent for readability
= 2.25 =
* fix some peculiarities with the album list download
* update compatibility to 4.1
= 2.24 =
* new maintainership
* fix compatibility with piwigo 1.6 and wordpress 4.0
* allow url to be "/foo/bar" like on local server, preserving http(s)
* fix compatibility with tinyMCE v4 (WordPress 1.9)
* support //host/path and use either http or https
* link tagets to photo are now within the first album of the photo
* permalinks are used for albums as far as possible
* support pulling from a specific album instead of only from all photos
= 2.23 =
* WordPress 3.5.1 support
* Bug: WordPress corrupted RSS feeds ( http://wordpress.org/support/topic/rss-feed-100?replies=4 )
* Support of Piwigo 2.4.x and 2.5.x (and probably above)
= 2.22 =
* **New shortcode parameter** lnktype = 'picture', 'none', or 'album' (most recent album id) : indicates the link type of the shortcoded picture
* Small bugs (functional defects) within Shortcode generator have been corrected
* Shortcode generator generates lnktype parameter
* **New widget parameter** Link type (Differ from lnktype here above) "album" link the first picture to the selected album id
* **New Caption widget parameter** to have the caption directly with the displayed and selected pictures.
* Sidebar widget has been totally rewritten
= 2.21 =
* Minor issues solved in drag & drop.
* jQuery code reviewed
* WordPress 3.4.2 support
If you don't have your own up-to-date Piwigo gallery, just try it with Piwigo demo URL: http://piwigo.org/demo/
= 2.20 =
* Edit post/page shortcode generator using Drag-n-drop (a useful tool for your photoblog).
If you don't have your own up-to-date Piwigo gallery, just try it with Piwigo demo URL: http://piwigo.org/demo/
= 2.10 =
* I18n version (Hugarian)
* Widget: Largest sizes added (from user request)
* WordPress shortcode for post/page: e.g. [PiwigoPress id=72 url='http://piwigo.org/demo/']
= 2.00 =
* Support of WordPress from 2.8.0 to 3.4.1 (and probably above)
* Support of Piwigo 2.4.x (and probably above)
* Support of Piwigo 2.0.x - 2.3.x assumed
* cURL access support (3rd way to solve webservice call issues)
* CSS DIV class: img-shadow and/or img-show-desc are now provided
* Orientation filtering
= 1.04 =
* Alternate pwg_get_contents (file\_get\_contents, fsockopen, ...)
* cURL is coming
= 1.03 =
* Project rename: Directory name changed for WordPress constraints
* Language issue solved
* Pre-version for WordPress publication
= 1.02 =
* Project rename: Public Piwigo WordPress Widget becomes PiwigoPress
* I18n version (Italian)
= 1.01 =
* I18n version (French, Spanish,...)
* Link bug with some theme... Solved.
= 1.0 =
* First version.
== Upgrade Notice ==
= 2.21 =
Performances
= 2.20 =
Swiftly transform your blog in a photoblog.
= 2.00 =
Previous PiwigoPress releases didn't support the most Piwigo recent releases (if you upgrade your Piwigo Gallery to 2.4.x or above, PiwigoPress 1.04 and older releases will fail).