LightBox (NotesFor.net) plugin for cpg1.6.x: Documentation

LightBox (NotesFor.net) plugin for cpg1.6.x

What's this?

This plugin will override the default popup that shows the fullsize picture and will show a LightBox instead. Options to set include adding image captions, a "nofollow" attribute, border sizes and slideshow timing.

It uses NFLightbox (see credits) which has been modified for Coppermine 1.5.x by Joe Carver. Snips from the Coppermine 1.4.x LightBox Slideshow have been used for some of the modifications. The plugin also depends on the jQuery library built into CPG 1.5.x and later

Install

This plugin is installed as any other plugin; there are no extra install steps, so besically you should do as suggested in the corresponding section of the documentation that comes with Coppermine.

Uninstall

Uninstall via plugin manager

Configuration

  1. Resize Images

    Resize the images to fit in the visitor's browser window.
    Default is Yes - resize. Note: The full-sized image is always sent to the browser. This just sets resize.
  2. Show a Download Link

    Show a link for visitors to download a copy of the full-size image. It will open the image in a new browser window.
    Options are OFF - Logged Users - On for all. Default is OFF - no download link.
  3. Show a LightBox Link in the Navbar

    Show a link for the LightBox in the Navigation menu above the image. Options are to add a new button (/images/icons/file_approval.png image) or use the cpg Slideshow button.
    Default is new button.

    To use a custom icon for themes that use [THEME_HAS_NAVBAR_GRAPHICS]:
    1) Create the icon in format .png or .gif
    2) Name the image lighbox.(.png or .gif) (ex. lightbox.png)
    3) Upload to /themes/custom_theme_directory/images/ folder
  4. Show slideshow timer bar

    Set visual slideshow timer bar. The plugin can show a counting timer for the slideshow. It can be CPU intensive and slow the pages for your visitors.
    Default is OFF - no timer bar.
  5. On exit return to

    Return on exit setting allows for the page to refresh with either the last or the first slide seen.
    Default is last slide.
  6. Show image captions below titles

    Show image captions - default is yes. Some users that have very long captions might want to use no/off. The captions will occupy screen space that the image can use.
  7. Adjust Top Margin Offset (pixels)

    Set an offset to move the image up in the display window. The result is a fixed margin above the image. This will help to adjust for large images with long titles or long captions The effect will work differently depending on the image and broswer window size. Set in pixels. Default is 38. TOO LARGE / SMALLL CAN PUSH THE IMAGE OFF THE PAGE. Set to 0 (zero) to remove the offset.
  8. Border width

    Set width of border in pixels. Default is 8.
  9. Number of files in album to list for Slideshow

    Set number of files in album to list for Slideshow. Will limit the number of links/files in piclist (slideshow list) on each displayimage page. Large albums and/or galleries might want to limit the value. For example: "Lastup" from the home page leads to all links in a gallery. The corresponding displayimage.php page then would have all of those links listed for the LightBox.
    0 = All files in an album
    Large albums and galleries might want to limit to 500 or less. USING 1 OR A VERY LARGE SETTING CAN CRASH A LARGE GALLERY.
    Default is 200.
  10. Button set

    Determine if the buttons should come from the theme or if you want to use the buttons that come with the plugin.
    Possible options are:
  11. Rounded corners

    Show/add rounded corners to image container. No corners will use less cpu for vistors and show smoother transitions.
  12. Hide resize

    Hide resize animation - use fading for image change.
  13. Automatic Start Slideshow

    Slideshow and timer will start when image or navbar button is clicked. Default is off / no.
  14. Slideshow timer

    Slideshow timer interval - (integer). Note: Animation and fade times are subtracted from the slideshow timer.
  15. Image swap time

    Container resize speed - (integer): specify the resize animation duration of container image. Set image swap time - set by millisecond. (1000 milliseconds = 1 second). Too fast will make image change unpleasant. Default is 820.
  16. Image fade in

    Fade in time for image into container - (integer).
  17. Container fade in/out

    Fade out/in duration when hide animation is set to yes - (integer).

Credits

Copyrights

This plugin is using the Lightbox script created by Helori Lamberty that can be used freely as long as the following copyright notice is being shipped with it:

Copyright (c) 2009, Helori LAMBERTY
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright owner or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.

Known Issues

To do