Skip to content
This repository has been archived by the owner on Aug 25, 2023. It is now read-only.
hairballopolis edited this page Sep 13, 2010 · 38 revisions

Gallery Install instructions

This is a forked repository pilu’s radiant-gallery. And now is the officially maintained version of the radiant gallery.

Features

  • Multiple nested galleries
  • Multiple upload
  • Import from ftp
  • Images/Files sorting by drag-n-drop
  • Automatic thumbnail generation for images after upload
  • Preview in lightwindow for images

Installation

After the Radiant installation you must install the attachment_fu plugin:

 cd /path/to/radiant
 git clone git://github.com/technoweenie/attachment_fu.git vendor/plugins/attachment_fu

Then install the Gallery extension:

 git clone git://github.com/hairballopolis/radiant-gallery.git vendor/extensions/gallery
cd vendor/extensions/gallery
git checkout 0.8.1 or the latest stable version in line with the current radiant version

Now you can run the install task:

rake RAILS_ENV=production radiant:extensions:gallery:install

Configuration

The installation task creates a file called gallery.yml under /path/to/radiant/config/extensions/gallery/.
Inside that file there are some variables you can edit:

  • path_prefix: The galleries folder path.
  • processor: The processor used to create thumbnails (rmagick | image_science | mini_magick).
  • default_thumbnails: a list of thumbnails that will be generated after each upload.
  • max_size: size in kilobytes for the maximum allowed size of image to be processed and added.
  • storage: The type of storage to use (:file_system | :db_file | :s3 | :cloud_files) ], the default is :file_system
path_prefix: public/galleries
processor: rmagick  
max_size: 3000 #file max size in kilobytes  
storage: file_system # default 
gallery_based: no
default_thumbnails:
  admin_thumb: 300x300   # do not remove
  admin_preview: 500x500 # do not remove
  small: 150x
  large: 450x    

storage can be updated by also config/environment.rb

config.after_initialize do
    ...
    Radiant::Config["gallery.storage"] = "file_system"
end                                         

Documentation

Your first gallery

After the installation you will be able to see the ‘Galleries’ tab in the Radiant administration panel.
Click on it and start creating galleries and uploading images.
Now create a new page, choose one of the layouts created during the gallery extension installation, and set ‘Gallery’ as page type.
Publish the new page and go to its url.

Displaying images from a specific gallery

<r:gallery id="GALLERY_ID">
  <ul>
    <r:gallery:items:each by="position" sort="asc">
      <li><r:gallery:item:path /></li>
    </r:gallery:items:each>
  </ul>
</r:gallery>

Displaying all galleries

<ul>
  <r:galleries:each level="all|top|bottom|current">
    <li><r:gallery:name /></li>
  </r:galleries:each>
</ul>

The value of the level attribute could be:

  • all (default): displays all galleries
  • top: displays galleries without a parent
  • bottom: displays galleries without children
  • current: displays children of the current gallery. If the current gallery is not set, it displays all the top galleries.

Displaying all images

<ul>
  <r:gallery:items:each by="created_at" sort="desc" scope="all">
    <li><r:gallery:item:thumb width="100" height="100" prefix="small" geometry="c50x50"/></li>
  </r:gallery:items:each>
</ul>

The value of the scope attribute could be:

  • gallery (default): displays images of the current gallery
  • all: displays all uploaded images

The current Gallery

Create a gallery tree like the following:

 - Languages
       | - Ruby
       | - Python
       | - Java

Now create a Gallery page (with gallery as page type) called gallery. Go to its url (http://localhost:3000/gallery).
In that page the current gallery is not set, but if you go to ‘/gallery/languages’, the current gallery is Languages,
under ‘/gallery/languages/ruby’ the current gallery is Ruby and so on.

Otherwise you can set the current gallery using the gallery tag:

Thumbnails generation

Thumbnails are generated on the fly with the gallery:item:thumb tag. Inside a page you can write:

The first time you will open that page, the system will generate a thumbnail for the first image of the gallery with id GALLERY_ID.
The signature of that thumbnail will be: ‘small_200x100’.
The next time the system will not generate the thumbnail if that image already has a thumbnail with that signature.
If you want to generate that thumbnail just after the upload of the image, add that signature inside the gallery.yml configuration file:

default_thumbnails: admin_thumb: 300×300 # do not remove admin_preview: 500×500 # do not remove small: 200×100 # this is the signature you use in the page. square: c90x90 # specific sized images with a center crop

Credits

Icons by http://www.famfamfam.com/

Clone this wiki locally