/[drupal]/contributions/modules/fast_gallery/README.txt
ViewVC logotype

Diff of /contributions/modules/fast_gallery/README.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.3, Fri Oct 30 05:55:29 2009 UTC revision 1.4, Tue Nov 10 18:38:09 2009 UTC
# Line 1  Line 1 
1  // $Id: README.txt, 2008/11/13 ncy (nick)  /* $Id:  */
2    
3  --------------------------------------------------------------------------------  -- SUMMARY --
 IMPORTANT!!!  
4    
5  Please fully DISABLE and UNINSTALL any previous versions of Fast Gallery.  The Fast Gallery module is aimed at new Drupal user who just want a nice
6  Rescanning the gallery shouldn't take all that long.  This version uses a  Gallery without having to dig further into the Drupal modules and API. Further
7  slightly different database schema (from version 3.2-beta1 and under) and a  it comes in very handy for users who want to sync a webgallery based on
8  few different variables. Please make backup copies of any important files,  a file system.
 and try out the module first on a test site if you are able to.  It's  
 functional but not fully tested.  
9    
10  If you need to edit EXIF data in JPG files, I have been using and highly  Easy, Fast, Reliable.
 recommend EXIFManager (http://phgiraud.free.fr/exifmanager).  
11    
12  Also highly recommended is the GUI version of ExifTool  For a full description of the module, visit the project page:
13  (http://www.sno.phy.queensu.ca/~phil/exiftool/). There are more editable    http://drupal.org/project/fast_gallery
 fields in this program.  
14    
 Enjoy!  
   
 -nick  
 --------------------------------------------------------------------------------  
   
 FAST GALLERY MODULE  
 -------------------  
 Fast Gallery allows you to build galleries based on your file system with  
 folders and subfolders.  
   
 Original module by Raphael Schär - www.schaerwebdesign.ch.  
 Rewrite of 6.x code by Nicholas C. Yang - www.nyanginator.com.  
   
 This module is sponsored by Schär Webdesign.  
 Visit www.schaerwebdesign.ch or the Drupal-related blog www.rapsli.ch.  
   
   
 AUTHORS  
 -------  
  * rapsli (Raphael Schär)  
  * ncy (Nicholas C. Yang)  
   
   
 SUMMARY  
 -------  
   
 Overview  
   
 Fast Gallery is a simple, lightweight, and fast image gallery. Making albums is as easy as putting images or videos into folders and uploading them to the gallery directory. It is fast because it is not based on nodes and doesn't implement some of the more complex features of larger gallery systems.  
   
 Uses Thickbox or Lightbox as the Javascript image display interface. Lightbox slideshows are also supported. You may also turn off the Javascript display framework, in which case thumbnails are linked to the original image with no extra frills. Imagecache is supported as well, for improved thumbnail generation. If you do not have the Imagecache module installed, Fast Gallery will generate the thumbnails cache internally through PHP functions.  
 Features  
   
     * Build albums using folder hierarchy. Supports nested folders.  
     * Captions through JPG EXIF data. Customizable caption display.  
     * Selectable Javascript framework: Thickbox, Lightbox, or none.  
     * Supports Lightbox slideshows.  
     * Supports Lightbox videos (FLV, SWF, MOV, WMV, ASX). FLV requires external FLV player, like the JW FLV Player (http://www.jeroenwijering.com).  
     * Supports PDFs using Lightbox iframe. Requires Adobe Reader installed in your browser.  
     * Supports Imagecache thumbnail generation.  
     * Supports JPG, GIF, PNG, BMP. EXIF data requires JPG. BMP requires Imagecache and ImageMagick enabled in ImageAPI.  
     * Works with Clean URLs on or off.  
     * Paged output where you can specify number of images per page.  
     * Specify number of images per row.  
     * Set custom teaser length for captions and folder labels.  
     * Display folders with thumbnail images or as text links.  
     * Support for custom folder thumbnails and teaser text (as a mouseover popup).  
     * Display albums in folder hierarchy or as one large album.  
     * Specify custom title.  
     * Specify custom path alias.  
     * Breadcrumbs for folder navigation.  
     * Sorting options for images and folders.  
     * Update galleries with cron job.  
     * Includes a random image Block that you can add through the Blocks admin page.  
     * Support for special (national) characters.  
   
 Quickstart  
   
    1. Upload your images and videos in their folders to your webserver.  
    2. Type in the gallery path, title, and alias on the General settings page. The alias may not contain the characters: [space] \ * : ? < > | ".  
    3. Specify in the caption display dropdowns what you want to show as captions underneath images. There can be up to 3 fields.  
    4. Click Save Settings at the bottom of the page.  
    5. Click on Clear DB and then Rescan at the bottom of the page.  
    6. If you are using Imagecache, go to the Advanced settings page. Select the Imagecache preset for thumbnails and for full-size display. Use <none> if you don't want to use Imagecache to resize the image (in which case the Internal Cache would be used). If you want custom pre-made Imagecache presets, click on Install IC Presets and reload the Advanced settings page. You should now be able to select the new presets ("fast_gallery_thumb" and "fast_gallery_big") in the dropdowns. If you aren't using Imagecache, the default dimension of a thumbnail generated by the Internal Cache is 150x100px and can be changed on the Advanced settings page.  
    7. Make sure that the width of "#fast_gallery .single-image" in the fast_gallery.css file is equal to or slightly wider than your thumbnails.  
    8. Now go to the gallery, as set by the alias you used above. There should be a link in the Navigation menu. If you prefer not to have this in the Navigation menu, go to the Menus administration page and disable it there. If you folders are not displaying correctly, and you have special (national) characters in some of your paths, then go to the Advanced settings page and try toggling the setting for UTF-8 conversion of captions.  
    9. Make note of how many thumbnails fit across the page. Go back to the General settings page and type that number info "Number of images per row". Click Save Settings at the bottom.  
   10. If you have thumbnails for non-image files, upload them to the same folder as the associated files. Give them the same name as the original files but with the extension ".screenshot.jpg". They must be of type JPG. The EXIF data of this thumbnail is used for the caption. The full-size of the linked file is set to the dimensions of this JPG screenshot. All files without screenshots will be given a generic thumbnail from the images folder of fast_gallery module folder.  
   11. If you have a custom thumbnail for a folder, upload it to the folder with the name "folder.jpg". It has to be a JPG. The JPG's EXIF description is used for the folder's teaser text, which is shown when the user hovers on the folder link.  
   
 Everything else from this point on is customizing the gallery to your own likes and tastes. You can:  
   
     * Set number of images per page.  
     * Set teaser length of captions and folder labels.  
     * Set format of caption display with caption dropdowns.  
     * Toggle display of folder hierarchy.  
     * Toggle display of folder thumbnails.  
     * Choose a different Javascript framework (i.e. Thickbox, Lightbox).  
     * Set sorting options for images.  
     * Set sorting options for folders.  
     * Toggle updating of gallery with cron jobs.  
     * Display only the images on the current page in the "Next" and "Previous" links of the popup.  
   
 Notes  
   
     * Updating with cron is disabled by default. Manual updating is done by clicking on Rescan on the General settings page.  
     * You should set the "Number of images per row" to no more than the maximum number of thumbnails that will fit across the page in order to prevent images overlapping captions.  
     * Random sorting will not perform well on large databases as it uses ORDER BY RAND() in the SQL database call.  
     * Random sorting for albums that have multiple pages will differ on every page, so some images may repeat when you navigate through the pages.  
     * Teaser length is set by counting the number of words separated by a space. If a word is wider than the width of the thumb, it will overlap neighboring thumbs. You should either add spaces to the filename or change to a shorter filename.  
     * Nested folders will use the first image it finds as a thumbnail and for sorting purposes. If you do not like the thumbnail choice, override it by uploading your own thumbnail as a JPG named "folder.jpg" to the folder it should belong to.  
     * Filenames are treated with no regard to case, so don't give files in the same directory the same name with different letter cases.  
     * Uninstalling Fast Gallery will leave Imagecache presets intact.  
     * When sorting by Date Taken or File Created, files with no EXIF data (includes all non-JPG files) or blank EXIF data cannot be sorted and are thus appended to the end of albums sorted by path.  
     * If your gallery is not functioning as expected, try clearing your browser's cache and private data, clearing and rescanning the database, refreshing your browser, and/or uninstalling and reinstalling Fast Gallery. It is best to completely uninstall old versions before installing newer ones.  
15    To submit bug reports and feature suggestions, or to track changes:
16      http://drupal.org/project/issues/fast_gallery

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.4

  ViewVC Help
Powered by ViewVC 1.1.2