Update README.txt
[project/views_gallery.git] / README.txt
1 Views Gallery Module
2 --------------------
3
4 NOTE! This module has been reworked to take advantage of the Features
5 module and it is now a feature.
6
7 Views Gallery pulls together the techniques Jeff Eaton outlined in 
8 http://www.lullabot.com/articles/photo-galleries-views-attach to automatically
9 create a simple gallery where each gallery is a node with an embedded view of
10 images that were assigned to that gallery.
11
12 The feature creates the content types, sets up the imagecache presets, creates
13 the default gallery view that is embedded into the gallery nodes by Views
14 Attach, adds custom back/next pagers, and adds css to make it all look nice.
15
16 This technique also works well to create individual image galleries for Organic
17 Groups, since the gallery and image content types can be configured as group
18 nodes. Views Gallery OG, included in this package, provides a setup page to
19 make it easy to automatically create a gallery for every group and adds group
20 context to the forms wherever possible so the right groups and group galleries
21 are pre-selected when you create gallery images.
22
23 The following modules provide the nuts and bolts for this to work.
24 It is a long list of modules, but there is little or nothing you need to do
25 except make sure the latest versions of all these modules are available when
26 you install Views Gallery and everything will be installed and configured for
27 you. Plus, most of them are modules you will probably use elsewhere.
28
29 * Features (http://drupal.org/project/features)
30 * Strongarm (http://drupal.org/project/strongarm)
31 * CTools (http://drupal.org/project/ctools)
32 * CCK (http://drupal.org/project/cck)
33 * Views (http://drupal.org/project/views)
34 * Views Attach (http://drupal.org/project/views_attach)
35 * Nodereference URL (http://drupal.org/project/nodereference_url)
36 * Filefield (http://drupal.org/project/filefield)
37 * Imagefield (http://drupal.org/project/imagefield)
38 * ImageAPI (http://drupal.org/project/imageapi)
39 * Imagecache (http://drupal.org/project/imagecache)
40 * Token (http://drupal.org/project/token)
41 * Custom Pagers (http://drupal.org/project/custom_pagers)
42
43 If the Lightbox2 (http://drupal.org/project/lightbox2) module is enabled, a
44 'View Slideshow' link will be added to the gallery view, which will bring up a
45 lightshow of the gallery images.
46
47 If the Views Slideshow module (http://drupal.org/project/views_slideshow,
48 version 6.2) is enabled, a Views Slideshow block is added to the default view.
49
50 This module has been sponsored by Buzzr (http://buzzr.com/).
51
52
53 Installation
54 ------------
55
56 Chekc the module's requirements, download the 'views_gallery' module and enable
57 it. Then go to the Features page and turn the feature on. If you have Context
58 and Spaces installed, you can set the feature up to appear only in selected
59 contexts or spaces.
60
61 You should not have to do anything else, it will create the content types and
62 views and an initial gallery node for you and configure everything else that
63 needs to be done.
64
65 The following content types will be created by the module:
66 * gallery
67 * gallery_image
68
69 The following views will be created by the module:
70 * gallery
71 * gallery_list
72
73 The following initial gallery node will be created by the module:
74 * gallery
75
76
77 Upgrading instructions
78 ----------------------
79
80 This module implements the techniques show in Jeff's screencast but has
81 implemented numerous tweaks and adjustments to fix bugs or add new
82 features. If you have created content types and views from that
83 screencast they WILL NOT WORK in this module because of subsequent changes.
84 Delete them and start over, this module will create the right types
85 and views.
86
87 To upgrade from the 6.1 to the 6.2 version of this code, please do the following:
88
89 1) Make sure the gallery content type has a machine name of 'gallery' and the
90 image content type has a machine name of 'gallery_image'. These are the 
91 defaults unless you changed them. If you changed them, you can go to the
92 content types page and edit the content type to change the name.
93 Features requires that we have a single, known, content type name.
94
95 2) Back up your database. The Backup Migrate module (http://drupal.org/project/backup_migrate)
96 provides an easy way to backup and restore the database.
97
98 3) If you made any changes to the field settings or display options,
99 you will have to re-apply your changes. If you are not sure, you can
100 enable the Content Copy module and export the Gallery and Gallery Image
101 content types and fields so you have a reference of how they were configured.
102
103 4) Replace the old Views Gallery code with the new code. Be sure to completely
104 empty the old folder so none of the old files remain.
105
106 5) Go to the modules page and enable Features, CTools, Strongarm, and Views Gallery.
107
108 6) Go to the content types page and find the Gallery and Gallery Image
109 content types. Go to the Manage Fields and Display Fields screens
110 and check that the fields still have the right settings. They will if
111 you never changed any of those values, otherwise you will need to
112 change them to match what you had before. You can use the export
113 of the older code as a help to see what you had set up before.
114
115 7) Clear the caches and confirm that everything is working as desired.
116
117 More documentation
118 ------------------
119
120 To understand what you can accomplish with Node-based galleries with CCK and
121 Views, you can have a look at Jeff Eatons screencast at Lullabot:
122
123 http://www.lullabot.com/articles/photo-galleries-views-attach
124
125 This screencast has been partially transcribed as an (incomplete) Howto:
126
127 http://drupal.org/node/599672
128
129 The screencast and the Howto will give you a basic understand what's going
130 on under the hood if you install the 'views_gallery' module.
131
132
133 Troubleshooting
134 ---------------
135
136 If the module behaves unexpectd, please check first the Drupal status report
137 at Admin -> Reports -> Status (./admin/reports/status).
138
139
140 Author and Copyright
141 --------------------
142
143 Author: Karen Stevenson <http://drupal.org/user/45874>
144
145 For further copyright information please see the included LICENSE.txt.