CONTENTS OF THIS FILE
---------------------

* Introduction
* Features
* Installation
* Usage
* Recommended Modules
* Obtaining Help

INTRODUCTION
------------

Current Maintainer: Manuel Garcia
Profile: http://drupal.org/user/213194
Contact: http://drupal.org/user/213194/contact
Module Project Page: http://drupal.org/project/galleryformatter
Issue Queue: http://drupal.org/project/issues/galleryformatter

Gallery formatter provides a formatter for image fields, which will turn any
image field into a jQuery Gallery.

FEATURES
--------

1. Two imagecache presets which will work out of the box beautifully.

2. The thumbnails run under an infinite carousel.

3. Degrades gracefully without JS enabled, the gallery still works.

4. Integrated out of the box with thickbox, colorbox (recommended as the
thickbox upgrade path), shadowbox and lightbox2 for the view full links.

5. Works with the swfupload, image_fupload, and imagefield_crop widgets.

6. A hook for modules to provide styles for the galleries.

7. Two options for styles, no style and a green arrows style. No style should be
used for developing your own styles.

8. Source svgs for the green arrows style, so you can use it as an example to
expand on, using inkscape for example.

9. Fully themeable through tpl file, overriding the template_preprocess, or just
CSS. You should know what you are doing if you do so.

INSTALLATION
------------

1. Download and extract the module to [yourdrupalroot]/sites/all/modules
(final structure will be [yourdrupalroot]/sites/all/modules/galleryformatter

USAGE
-----

1. Setup a content type to use for galleries, or choose an existing one where
you will make use of galleries.

2. "Manage Fields" Tab - setup an imagefield, or choose an existing image field.

a. [YOUR IMAGE FIELD NAME] FIELD SETTINGS
- "Enable Alt field"
- "Enable Title field" both checked
- Number of values: set to "unlimited"

3. "MANAGE DISPLAY" Tab - FORMAT: choose JQuery Gallery for your imagefield

a. Configure the settings for the gallery there.
- select slide imagecache preset (default: galleryformatter_slide)
- select thumbnail imagecache preset (default: galleryformatter_thumb)
- select style (No Style, Greenarrows; or your own or contributed style)
- select modal (see above FEATURES #4) or "Do not use modal"

b. Save the configuration

c. Save the Content Type

4. When you create nodes which have an above configured image field, and you
upload several images to that field, the galleryformatter will display them as a
jQuery gallery.

5. If you are unfamiliar with Drupal it may take some time and experimentation
to get the galleries performing how you want.

THEME OVERRIDE
--------------
Themers or developers can override the galleryformatter template by copying the file "themes/galleryformatter.tpl.php" to their theme directory, and renaming the file to "galleryformatter_formatter_galleryformatter_default.tpl.php"
See http://drupal.org/node/909422 for discussion of this issue.

RECOMMENDED MODULES
-------------------
1. Thickbox (deprecated)
2. Colorbox (recommended as the thickbox upgrade path)
3. Shadowbox
4. Lightbox2

OBTAINING HELP
--------------

Extensive help can be found in the issue queue. Many of the most common
questions and problems have already been addressed.
Help link: http://drupal.org/project/issues/galleryformatter