silverstripe-gallery 

silverstripe-gallery Git Source Tree

Root/README.md

1Silverstripe Image Gallery
2==========================
3
4A new page type (_GalleryPage_) that provides everything needed to
5manage a photo gallery.
6
7You can do bulk uploads and reorder the images by dragging and dropping
8their thumbnails in a dedicated tab (_Gallery_) inside the CMS. The same
9image can be shared among multiple galleries. This module adds also some
10field to the _Settings_ tab. This will allow to customize some aspect of
11the gallery on a per page basis, e.g. the height of the thumbnail strip,
12the height of the image slide and a flag to show or hide the captions.
13
14On the developer side of things, you can write your own templates and
15support the JavaScript library of your choice. Out of the box this
16project uses [Fotorama](http://fotorama.io/) and you can embed the
17gallery block in your pages by including `ContentGallery.ss`, e.g.:
18
19 <%-- This is a typical Page.ss --%>
20 <h1>$Title</h1>
21 <div class="gallery">
22 <% include ContentGallery.ss %>
23 </div>
24 <div class="content">
25 $Content
26 </div>
27
28It is also available a page template (`GalleryPage.ss`) that provides
29a [silverstrap](http://dev.entidi.com/p/silverstrap/) ready page
30template.
31
32Author
33------
34
35Although the project originally started as a fork of
36[silverstripe-gallery](https://github.com/i-lateral/silverstripe-gallery)
37by [i-lateral](http://www.i-lateral.com/), the actual code has been
38rewrote almost from scratch by [ntd](http://www.entidi.com/) and, apart
39the name, practically everything else has changed.
40
41The project [home page](http://silverstripe.entidi.com/) is shared by
42other [SilverStripe](http://www.silverstripe.org/) modules and themes.
43
44To check out the code, report issues or propose enanchements, go to the
45[dedicated tracker](http://dev.entidi.com/p/silverstripe-gallery).
46Alternatively, you can do the same things by leveraging the official
47[github repository](https://github.com/ntd/silverstripe-gallery).
48
49Installation
50------------
51
52The feature of reordering with drag and drop is provided by the
53[sortablefile](https://github.com/bummzack/sortablefile) module that
54*must* be installed before.
55
56To install silverstripe-gallery you should proceed as usual: drop the
57directory in your SilverStripe root and do a `/dev/build/`. You will
58gain the new `GalleryPage` type in the CMS.

Archive Download this file