modules/galleria/README.txt

// $Id: README.txt,v 1.1 2008/12/03 14:50:54 marktheunissen Exp $

Galleria
---------------------

This module allows users to create image galleries using the
Galleria jQuery plugin, found on the site:

http://devkick.com/lab/galleria/

It is an administrator's module, and the target audience is site builders who
want to provide a beautiful jQuery image gallery for their clients. There is
no reason why the functionality cannot be opened to end users, but it's not
a direction that I will be supporting. It would require a lot more checks
to ensure the users were behaving themselves!

Status
---------------------

A release is coming soon! Just polishing the code for a client's site,
and thereafter I'll create one. Please don't deploy on production sites yet,
unless you know exactly what you're doing and can cope with any changes I'm
liable to make in the near future.

How it works
---------------------

Galleria relies on the core upload.module to attach images to a node. It then
removes all the default node display content and replaces it with a Galleria
gallery.

1.  Choose the node type that you want converted into Gallerias. All nodes of
    this type will be converted. You'd usually make a type called "galleria".
2.  On that node's "edit content type" page, you'll have an option
    "Enable Galleria" under the "Workflow settings".
3.  On the same page, enable file uploads (Attachments).
4.  Create a new Galleria node, and attach the images using the upload files
    function.
5.  View the node, and voila, you have a Galleria!

Thickbox support
---------------------

I am adding the functionality that will allow the entire Galleria to appear
inside a Thickbox (similar to Lightbox).

Customisation
---------------------

There is a preprocess hook and a template file for all your customisation needs.
You can style the galleria by overriding the CSS.

Similar modules
---------------------

BornFree (http://drupal.org/project/bornfree) also implements the Galleria
plugin. The reasons I chose to go my own way:

- BornFree uses blocks to display images / gallerias.
- BornFree relies on image and image_attach to get these images from nodes.
- Galleria uses the core Upload module to attach a bunch of images to a node.
- Galleria uses Drupal theme layer properly (i.e. preprocess function and
  a template file). BornFree does not.
1	// $Id: README.txt,v 1.1 2008/12/03 14:50:54 marktheunissen Exp $
2
3	Galleria
4	---------------------
5
6	This module allows users to create image galleries using the
7	Galleria jQuery plugin, found on the site:
8
9	http://devkick.com/lab/galleria/
10
11	It is an administrator's module, and the target audience is site builders who
12	want to provide a beautiful jQuery image gallery for their clients. There is
13	no reason why the functionality cannot be opened to end users, but it's not
14	a direction that I will be supporting. It would require a lot more checks
15	to ensure the users were behaving themselves!
16
17	Status
18	---------------------
19
20	A release is coming soon! Just polishing the code for a client's site,
21	and thereafter I'll create one. Please don't deploy on production sites yet,
22	unless you know exactly what you're doing and can cope with any changes I'm
23	liable to make in the near future.
24
25	How it works
26	---------------------
27
28	Galleria relies on the core upload.module to attach images to a node. It then
29	removes all the default node display content and replaces it with a Galleria
30	gallery.
31
32	1. Choose the node type that you want converted into Gallerias. All nodes of
33	this type will be converted. You'd usually make a type called "galleria".
34	2. On that node's "edit content type" page, you'll have an option
35	"Enable Galleria" under the "Workflow settings".
36	3. On the same page, enable file uploads (Attachments).
37	4. Create a new Galleria node, and attach the images using the upload files
38	function.
39	5. View the node, and voila, you have a Galleria!
40
41	Thickbox support
42	---------------------
43
44	I am adding the functionality that will allow the entire Galleria to appear
45	inside a Thickbox (similar to Lightbox).
46
47	Customisation
48	---------------------
49
50	There is a preprocess hook and a template file for all your customisation needs.
51	You can style the galleria by overriding the CSS.
52
53	Similar modules
54	---------------------
55
56	BornFree (http://drupal.org/project/bornfree) also implements the Galleria
57	plugin. The reasons I chose to go my own way:
58
59	- BornFree uses blocks to display images / gallerias.
60	- BornFree relies on image and image_attach to get these images from nodes.
61	- Galleria uses the core Upload module to attach a bunch of images to a node.
62	- Galleria uses Drupal theme layer properly (i.e. preprocess function and
63	a template file). BornFree does not.