Skip to content

cmb69/foldergallery_xh

Repository files navigation

Foldergallery_XH

Foldergallery_XH facilitates the presentation of image galleries on a CMSimple_XH website. Contrary to most other existing gallery plugins, the galleries are created completely automatically from existing images in a given folder, so that the galleries do not have to be prepared in the back-end. That makes Foldergallery_XH especially suited for large amounts of images, and also for use with Extedit_XH.

Requirements

Foldergallery_XH is a plugin for CMSimple_XH. It requires CMSimple_XH ≥ 1.7.0, and PHP ≥ 7.1.0 with the gd and json extensions. The PHP exif extension is recommended.

Download

The lastest release is available for download on Github.

Installation

The installation is done as with many other CMSimple_XH plugins. See the CMSimple_XH Wiki for further details.

  1. Backup the data on your server.
  2. Unzip the distribution on your computer.
  3. Upload the whole folder foldergallery/ to your server into the plugins/ folder of CMSimple_XH.
  4. Set write permissions for the subfolders cache/, config/, css/ and languages/.
  5. Go to PluginsFoldergallery in the back-end to check if all requirements are fulfilled.

Settings

The configuration of the plugin is done as with many other CMSimple_XH plugins in the back-end of the Website. Select PluginsFoldergallery.

You can change the default settings of Foldergallery_XH under Config. Hints for the options will be displayed when hovering over the help icon with your mouse.

Localization is done under Language. You can translate the character strings to your own language if there is no appropriate language file available, or customize them according to your needs.

The look of Foldergallery_XH can be customized under Stylesheet.

Usage

Prepare the galleries by uploading images into the userfiles/images/ folder of CMSimple_XH, or a subfolder thereof, either via FTP or a filebrowser. The image captions shown by Foldergallery_XH are retrieved from the filename or, if available, the Exif ImageDescription tag stored in the image file.

To present all images in the image folder on a page, insert the following plugin call:

{{{foldergallery()}}}

To present only the images of a subfolder (and all subfolders of that folder), use something like the following (replace %SUBFOLDERNAME% with the actual name of the subfolder):

{{{foldergallery(%)'SUBFOLDERNAME%)'}}}

Limitations

Only a single gallery can be shown on each page.

Only JPEG images are supported; other image formats are ignored.

If the PHP exif extension is not enabled, thumbnails of images with Exif Orientation tags will not be displayed properly (they are rotated and or flipped).

Troubleshooting

Report bugs and ask for support either on Github or in the CMSimple_XH Forum.

License

Foldergallery_XH 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 3 of the License, or (at your option) any later version.

Foldergallery_XH is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantibility 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 Foldergallery_XH. If not, see https://www.gnu.org/licenses/.

Copyright © 2017 Christoph M. Becker

Slovak translation © 2017 Dr. Martin Sereday

Credits

This plugin is inspired by the Fast Gallery Drupal module.

Foldergallery_XH uses Colorbox by Jack Moore and PhotoSwipe by Dmitry Semenov. Thanks for releasing these great scripts under MIT license.

The plugin logo is designed by Everaldo Coelho. Many thanks for publishing this icon under GPL.

Many thanks to the community at the CMSimple_XH Forum for tips, suggestions and testing. Particularly, I like to thank frase and lck for testing and feedback on an early development preview. Also many thanks to bemerkenswelt who inspired the use of PhotoSwipe. And many thanks to frase for pointing me to the flex layout model.

And last but not least many thanks to Peter Harteg, the “father” of CMSimple, and all developers of CMSimple_XH without whom this amazing CMS would not exist.