Table of Contents
Reports
The competition plugin supports two types of reports: the Full Catalog and the Slideshow. Which options appear on the screen depend upon which report type is selected.
Reports are created as PDF files and saved in a web-accessible directory under <site_url>/photocomp/reports/. By default this directory should be prevented from displaying a file list, either by including an empty index.html or by configuring the web server to disallow indexes.
If a report file already exists that was created using the same options as a newly-requested report, the report will not be recreated. If you wish to run the report again, check the “Force Run” checkbox.
Full Catalog
The Full Catalog report is a simple document showing images and information (title, creator, award, etc.) for all images within a specified time period.
Slideshow
The slideshow is a document with one image per page on a black background with the information shown on the right side. The image is scaled to fit in a square box to give portrait images the same screen space as landscape. Adobe Reader can be configured to display the images in a full-screen continuous slideshow.
Interstitial Slides
Slides can be included between classes and/or divisions to provide information about the class or division.
For Divisions, only image slides are supported and they must be have been uploaded with the division's definition. When a change in division is encountered, the interstitial slides will be inserted.
For Classes, either text or image slides can be created. If “text” is selected then the long description for the class is used; if “image” then the image that was uploaded with the class definition is used.
The number of slides selected will be included in the slideshow, one after the other. The purpose for this is to extend the time that the interstitial slide is displayed relative to the time each image is shown. For example, if you set your slideshow to display each image for 5 seconds, you could enter “3” for the number of slides to have the interstitial slide displayed for 15 seconds. The slide isn't actually shown for 15 seconds, but three slides are shown for 5 seconds each which gives the impression of a longer display. Therefore, do not enable any type of transition effect when using a slide count greater than one.
The Job Queue
Report creation can take a long time if there are many images included, which may result in your web session timing out before the report is done. If you encounter (or think you may encounter) this situation, you can check the “Use Job Queue” checkbox. This causes the report parameters to be submitted to a job queue for running later.
After the job is submitted, you will need to run the Job Runner manually from your server. The script is named “runjobs.php.dist” when it is installed and is located in the main plugin directory, e.g. private/plugins/photocomp. Rename this file to “runjobs.php” and edit it to reference the location of lib-common.php. A line such as this should be the first non-comment line in the file:
require_once '../../../public_html/lib-common.php';
You should then be able to run “php runjobs.php” to generate the report.
The job queue is part of the LGLib plugin and may also be invoked by visiting yoursite/lglib/cron.php. See the documentation for that plugin for details.
Options
| Option | Description |
|---|---|
| Report Type | Select “Full Catalog” or “Slideshow” |
| Competition Year | Enter a competition year, e.g. “2015”, or enter the starting and ending months for the desired time period.The Competition Year is the 4-digit calendar year in which your competition year ends, e.g. “2019” if your year runs from July, 2018 through June 2019. If no year is entered then the starting and ending dates are used. |
| Select Event | (Slideshow) Select the single competition to include in the slideshow. |
| Winners Only | (Both) Check this box to have only winning images included. |
| Slides between Divisions | (Slideshow) Check this box to include interstitial slides between divisions. Enter a number of consecutive, identical slides to include. See Slidehow for details. |
| Slides between Classes | (Slideshow) Select whether to include text, image, or no interstitial slides between classes, and enter the number of consecutive slides to include. See Slidehow for details. |
| Sorting Options | Select one or more options for sorting images. |
| Show Missing Images | Check this to have a placeholder image included in place of images missing from disk. |
| Force Run | Check this box to force a new report to be created even if an identical report already exists. |
| Use Job Queue | Check this box to submit the report information to a job queue. The job runner must then be run separately to generate the report. |
