-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.txt
151 lines (100 loc) · 5.14 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
=== PPV NextGEN Addons ===
Contributors: lheisey
Tags: justified gallery, album, template, lightbox, nextgen
Requires at least: 5.5.4
Tested up to: 6.3
Stable tag: 4.3
Requires PHP: 5.6
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
A WordPress plugin that adds templates and a lightbox for the NextGEN Gallery plugin.
== Description ==
Adds two compact album templates, a justified gallery template, and a modified version of simplelightbox. The added functionality is only used for the NextGEN Gallery plugin so it needs to be installed and activated.
== Included Functions ==
* compact album width template where number of albums displayed in row is determined by container width
* compact album query template where number of albums displayed in row is determined by media queries
* justified gallery template which displays gallery images in a justified layout
* simplelightbox modified to have dark background for lightbox image
* justified gallery CSS and JS only loaded on specified pages
== Plugin Installation ==
1. Upload ppv-ngg.zip to plugins via WordPress admin panel or upload unzipped folder to the `/wp-content/plugins/` folder.
2. Activate the plugin through the 'Plugins' menu in WordPress.
== Template Installation ==
The templates in ngg-templates either need to be moved or uploaded to specific directories. If the directories are not present they need to be created.
The 2 album templates need to be placed as:
`wp-content/ngg/modules/photocrati-nextgen_basic_compact_album/templates/compactalbumwidth-view.php`
`wp-content/ngg/modules/photocrati-nextgen_basic_compact_album/templates/compactalbumquery-view.php`
The gallery template needs to be placed as:
`wp-content/ngg/modules/photocrati-nextgen_basic_thumbnails/templates/justifiedgallery-view.php`
== Template Setup ==
In the WordPress admin
For the album templates:
`NextGEN Gallery > Gallery Settings > Basic Compact Album > Select View`
In the dropdown select either `custom/compactalbumwidth-view.php` or `compactalbumquery-view.php`
For the gallery template:
`NextGEN Gallery > Gallery Settings > Basic Thumbnails > Select View`
In the dropdown select `custom/justifiedgallery-view.php`
If needed edit class-ppv-ngg-public.php with pages to load justified gallery CSS and JS
== Lightbox Setup ==
In the WordPress admin
`NextGEN Gallery > Other Options > Lightbox Effects > What lightbox would you like to use?`
In the dropdown select `Custom`
Also copy and paste `class="simplelightbox" rel="%GALLERY_NAME%"` into the Code box.
== Frequently Asked Questions ==
= What is a justified layout? =
For an image gallery the justified layout fits differently sized images in rows of the same height by resizing rather than cropping. It is particularly useful for galleries that have images of different sizes as well as both portrait and landscape oriented images.
= Which readme file do I make changes in? =
Make changes to the README.txt file. The README.md file is generated by gulp so should never be edited.
= Where is the plugin version updated? =
In the ppv-ngg.php file after the comment block that starts with `Currently plugin version` and also in the header comments.
== Credits ==
* WordPress Plugin Boilerplate https://github.com/DevinVinson/WordPress-Plugin-Boilerplate was used as the starting point for this plugin.
* WPGulp https://github.com/ahmadawais/WPGulp was used as the starting point for the gulp workflow.
* JustifiedGallery https://github.com/miromannino/Justified-Gallery
* SimpleLightbox https://github.com/andreknieriem/simplelightbox
== Changelog ==
= 1.2.5 =
* Updated simplelightbox version to 2.14.2
* Updated NOTES.md file
* Updated readme tested up to WordPress version 6.3 and Requires at least to 5.5.4
* Updated gulp plugin dependencies
= 1.2.4 =
* Updated and fixed simplelightbox version to 2.10.4
* Added NOTES.md file
* Updated readme tested up to WordPress version 6.1
* Updated gulp plugin dependencies
= 1.2.3 =
* Updated readme tested up to WordPress version 6.0
* Updated gulp plugin dependencies
* Updated simplelightbox version from 2.10.2 to 2.10.3
= 1.2.2 =
* Removed gulp completion notifications
* Added log message to gulp package task
= 1.2.1 =
* Updated node-sass to version 7.0.1
* Updated justifiedgallery-view.php to remove PHP warnings for some NGG Gallery shortcodes
* Updated readme tested up to WordPress version 5.9
* Update simplelightbox version from 2.8.0 to 2.10.2
= 1.2.0 =
* Updated gulp-sass to version 5
= 1.1.3 =
* Update gulp plugin dependencies
* Update simplelightbox version from 2.7.2 to 2.8.0
= 1.1.2 =
* Create separate files for initialization of SimpleLightbox and JustifiedGallery JS
* Do not enqueue now unused ppv-ngg-main.js
* Updated readme tested up to WordPress version 5.8
= 1.1.1 =
* Update gulp plugin dependencies
* Update simplelightbox version from 2.7.0 to 2.7.2
= 1.1.0 =
* Only load Justified Gallery CSS and JS on specified pages
* Reverse order of changelog in readme
= 1.0.2 =
* Change to not copy ppv-ngg.zip to plugin directory
* Change to use minified JS and CSS
= 1.0.1 =
* Add readme.txt to markdown conversion
* Add gallery title to justified gallery template
= 1.0 =
* Initial release.