Updated .info and README.txt files in preparation for beta7 release.
[project/media_gallery.git] / README.txt
1 INSTALLATION
2 ------------
3
4 1. Download Media Gallery from http://drupal.org/project/media_gallery
5
6    Always use the latest official release. Unpack it in your contributed
7    modules directory (usually sites/all/modules).
8
9 2. Download other necessary projects.
10
11    In addition to Media Gallery itself, you'll need several other modules and
12    libraries on your site in order for your site's gallery functionality to
13    work as designed.
14
15    You should generally download the latest official release of each project.
16    However, this version of Media Gallery has been specifically tested with the
17    versions shown in parentheses below. If you do not use these exact versions,
18    it is likely that this release will not work correctly.
19
20    Required:
21
22    a. Media (latest 1.x release, tested with 7.x-1.0-rc2)
23       - Download from http://drupal.org/project/media and unpack it in your
24         contributed modules directory (usually sites/all/modules).
25    b. Multiform (7.x-1.0-beta2)
26       - Download from http://drupal.org/project/multiform and unpack it in your
27         contributed modules directory (usually sites/all/modules).
28    c. Chaos tool suite (latest release, tested with 7.x-1.0-beta1)
29       - Download from http://drupal.org/project/ctools and unpack it in your
30         contributed modules directory (usually sites/all/modules).
31    d. ColorBox jQuery plugin (latest release, tested with 1.3.17)
32       - Download from http://colorpowered.com/colorbox and unpack it in
33         sites/all/libraries (if the directory doesn't exist, create it first).
34
35    Recommended for the best experience:
36
37    e. Media Browser Plus (latest release, tested with 7.x-1.0-beta3)
38       - Download from http://drupal.org/project/media_browser_plus and unpack
39         it in your contributed modules directory (usually sites/all/modules).
40    f. Media YouTube (latest release, tested with 7.x-1.0-alpha5)
41       - Download from http://drupal.org/project/media_youtube and unpack it in
42         your contributed modules directory (usually sites/all/modules).
43    g. Plupload (latest release, tested with 7.x-1.0-beta3)
44       - First, download the module from http://drupal.org/project/plupload and
45         unpack it in your contributed modules directory (usually
46         sites/all/modules).
47       - Next, download the Plupload JavaScript library from
48         http://www.plupload.com (latest release, tested with 1.4.3.2) and
49         unpack it in sites/all/libraries (if the directory doesn't exist,
50         create it first). See the Plupload module's README.txt file for
51         up-to-date instructions.
52
53 3. Enable the modules.
54
55    a. Visit your site's Administration > Modules page.
56    b. Enable Media Gallery itself to get the basic gallery functionality
57       working. This will automatically enable all required modules.
58    c. Optionally enable Media Browser Plus to get a better experience browsing
59       and adding media to your galleries.
60    d. Optionally enable Media YouTube to allow you to add YouTube videos to
61       your galleries.
62    e. Optionally enable Plupload to allow you to quickly add large numbers of
63       images to your gallery at once, rather than having to upload them one at
64       a time.
65
66 GETTING STARTED
67 ---------------
68
69 There are a lot of fun things you can do with this module. Here are some
70 suggestions for getting started:
71
72 1. Go to Add content, and create a gallery.
73 2. The gallery will be empty by default, so use the "Add media" link to quickly
74    upload a few images from your computer. Now you have a completely functional
75    gallery, just like that!
76 3. Use the "Add media" link again, and switch to the "Web" tab. Find a YouTube
77    video you like, and paste its URL there. Now it will be in the gallery too.
78    (Note that the "Library" tab allows you to add existing media items from
79    your site - for example, images that were uploaded using other modules - to
80    the gallery as well.)
81 4. Back in the gallery, you can use drag-and-drop to rearrange the images and
82    videos to your liking.
83 5. Use the "Edit media" tab to quickly edit all your items at once (for
84    example, to give each item in the gallery a description, or to tag it).
85 6. Now click on one of the images in your gallery and watch it pop up in a
86    lightbox. Inside the lightbox, you can scroll through the gallery items
87    individually, or watch them play in a slideshow. Note that you can play your
88    video from inside the lightbox also.
89 7. Back in the gallery, you can use the "Edit gallery" tab to customize several
90    ways in which the gallery displays, and also make the gallery available as a
91    block (which you can then place on your site by going to Administration >
92    Structure > Blocks).
93 8. Your site's main menu should have a link called Galleries which was
94    automatically added when you turned on the module. This page displays a
95    collection of all the galleries you created. You can use drag-and-drop to
96    rearrange the galleries here also.
97 9. The "Edit all galleries" tab that's available from here also lets you
98    customize some additional aspects of how the Galleries page is displayed.
99
100 There's lots more to explore, so have fun!
101
102 CAVEATS
103 -------
104
105 This module is still in beta, and many of the modules it depends on are in beta
106 themselves, or even in alpha.
107
108 We therefore don't recommend using it on production sites, unless you're able
109 to tolerate bugs, maintain frequent database backups of your site, and keep
110 up-to-date on the module's development so that you can quickly apply any
111 patches if security issues are discovered. (As per Drupal's official policy at
112 http://drupal.org/security-advisory-policy, security issues discovered in a
113 module which has an alpha, beta, or other non-stable release will not result in
114 an advisory being issued and may be discussed publicly before a fix is
115 available.)
116
117 If you find bugs, please use the "Issues for Media Gallery" section at
118 http://drupal.org/project/media_gallery to search for existing bug reports
119 about the same issue, and if there isn't one, file a new bug report. Please
120 help us make this module better!  In addition to coding and reporting bugs, we
121 can use help managing the issue queue as well as writing documentation. If you
122 want to help but don't know how, feel free to file a support request in the
123 issue queue, and we'll get you started with some suggestions.