... \\
{toc}
h2. What is Gallery?
Gallery is a dynamic Gallery Extra for MODx Revolution. It allows you to quickly and easily put up galleries of images, sort them, tag them, and display them in a myriad of ways in the front-end of your site.
A tutorial has been made for Gallery by the community, and can be downloaded here: [^Tutorial - Gallery Component with Galleriffic.pdf]
h2. Requirements
* MODx Revolution 2.0.0-rc-2 or later
* PHP5 or later
h2. History and Info
Gallery was written by Shaun McCormick (splittingred) as a dynamic Gallery component, and first released on February 5th, 2010.
You can view the [roadmap here|Gallery.Roadmap].
h3. Download
It can be downloaded from within the MODx Revolution manager via [revolution20:Package Management], or from the MODx Extras Repository, available here: [http://modx.com/extras/package/gallery]
h3. Development and Bug Reporting
Gallery is stored and developed in GitHub, and can be found here: [https://github.com/splittingred/Gallery]
h2. Usage
The Gallery snippets can be called using the [tags|revolution20:Tag Syntax]:
{code}
[[Gallery? &album=`My Album`]]
[[GalleryAlbums? &limit=`10`]]
{code}
h3. Snippets
Gallery comes packaged with 3 snippets - one called "Gallery", which displays a gallery from either an Album, a Tag, or both; a snippet called "GalleryAlbums", which displays a list of Albums; and a snippet called "GalleryItem", which displays a single Gallery Item.
- [Gallery|Gallery.Gallery]
- [GalleryAlbums|Gallery.GalleryAlbums]
- [GalleryItem|Gallery.GalleryItem]
h3. System Settings
You can change the place where you store your Gallery images by changing the following settings:
| gallery.files_path | The absolute path of a folder to store images in. |
| gallery.files_url | The web-accessible URL that you can reach gallery.files_path from. |
As of version 1.3.0 you can also enable and control a TinyMCE integration for Gallery item descriptions. These settings are included:
|| key\\ || description\\ ||
| gallery.use_richtext\\ | Set to yes (true) to enable the TinyMCE integration. Note that you will need to have the TinyMCE Extra installed in order for this to work.\\ |
| gallery.tiny.width\\ | Width of the text editor in either pixels or a percentage.\\ |
| gallery.tiny.height\\ | Height of the text editor in either pixels or a percentage. |
| gallery.tiny.buttons1/2/3/4/5\\ | Buttons to display on the different rows (1 through 5). When empty this will inherit from the main TinyMCE settings.\\ |
| gallery.tiny.custom_plugins\\ | A comma separated list of plugins to load. When empty this will inherit from the main TInyMCE settings.\\ |
| gallery.tiny.theme_advanced_blockformats\\ | Block formats to use in the drop down box. Inherits from main TinyMCE settings when empty.\\ |
| gallery.tiny.theme_advanced_css_selectors\\ | CSS Selectors to choose from. Inherits from main TinyMCE settings when empty.\\ |
h3. Using the Custom TV
Gallery comes packaged with a custom TV input and output type for managing Gallery images in the backend. You can crop, resize, rotate, and more with it. Please see the following article for more usage:
* [Setting Up the GalleryItem TV|Gallery.Setting Up the GalleryItem TV]
h3. Gallery Plugins
Gallery allows you to display your galleries either straight as thumbnail images in the front-end, or using jQuery plugins. You can pass a plugin name through the Gallery snippet. Currently, the only available plugin is for [Galleriffic|Gallery.Plugins.Galleriffic].
h3. Gallery manager page
Gallery ships with a custom manager page (can be found in the Components top menu) where you can manage your albums. You can create new ones, and use the name you give it in the Gallery snippet to retrieve that specific album. After you have created an album you can right click and update it to manage the photos associated with it.
|
E-mail