sc.photogallery 1.0b3
A Photo Gallery content type with a slideshow view.
Keywords: plone photo gallery content type dexterity

*************
Photo Gallery
*************

.. contents:: Table of Contents

Life, the Universe, and Everything
==================================

A Photo Gallery content type with a slideshow view.

Mostly Harmless
===============

.. image:: http://img.shields.io/pypi/v/sc.photogallery.svg
    :target: https://pypi.python.org/pypi/sc.photogallery

.. image:: https://img.shields.io/travis/collective/sc.photogallery/master.svg
    :target: http://travis-ci.org/collective/sc.photogallery

.. image:: https://img.shields.io/coveralls/collective/sc.photogallery/master.svg
    :target: https://coveralls.io/r/collective/sc.photogallery

These are some sites using ``sc.photogallery``:

* `Portal Brasil 2016 <http://www.brasil2016.gov.br/>`_ (BR)

Got an idea? Found a bug? Let us know by `opening a support ticket`_.

.. _`opening a support ticket`: https://github.com/collective/sc.photogallery/issues

Known issues
------------

* `ZIP functionality doesn't seem to support Dexterity based images <https://github.com/collective/sc.photogallery/issues/37>`_.

See the `complete list of bugs on GitHub <hhttps://github.com/collective/sc.photogallery/labels/bug>`_.

Don't Panic
===========

Installation
------------

To enable this package in a buildout-based installation:

#. Edit your buildout.cfg and add add the following to it::

    [buildout]
    ...
    eggs =
        sc.photogallery

After updating the configuration you need to run ''bin/buildout'', which will
take care of updating your system.

Go to the 'Site Setup' page in a Plone site and click on the 'Add-ons' link.

Check the box next to ``Photo Gallery`` and click the 'Activate' button.

.. Note::
    You may have to empty your browser cache and save your resource registries
    in order to see the effects of the product installation.

Usage
-----

Original images in a Photo Gallery can be easily downloaded by enabling the display of an explicit link.
To use this feature, go to the Photo Gallery control panel configlet and select 'Enable download?'.

If `ftw.zipexport`_ is installed, you will also be able to download all images on a ZIP file.

.. _`ftw.zipexport`: https://pypi.python.org/pypi/ftw.zipexport

Internals
---------

``Photo Gallery`` uses Cycle2 slideshow plugin for jQuery and it can load its resources from the Plone JS registry if they are present there.

If you're using ``Photo Gallery`` with other packages that use Cycle2 also (like `collective.nitf`_ or `covertile.cycle2`_),
it is highly recommended that you register those resources to load them once and avoid conflicts.

You can use a ``jsregistry.xml`` file that includes the following:

.. code-block:: xml

    <javascript id="++resource++collective.js.cycle2/jquery.cycle2.min.js"
        cacheable="True" compression="none" cookable="True" enabled="True" />
    <javascript id="++resource++collective.js.cycle2/jquery.cycle2.carousel.min.js"
        cacheable="True" compression="none" cookable="True" enabled="True" />
    <javascript id="++resource++collective.js.cycle2/jquery.cycle2.swipe.min.js"
        cacheable="True" compression="none" cookable="True" enabled="True" />

.. _`collective.nitf`: https://pypi.python.org/pypi/collective.nitf
.. _`covertile.cycle2`: https://pypi.python.org/pypi/covertile.cycle2

Not Entirely Unlike
===================

`collective.plonetruegallery`_
    A gallery/slideshow product for Plone that can aggregate from Picasa and Flickr or use Plone images.

.. _`collective.plonetruegallery`: https://pypi.python.org/pypi/collective.plonetruegallery

Share and Enjoy
===============

`sc.photogallery` would not have been possible without the contribution of the following people:

- André Nogueira
- Héctor Velarde
- Rodrigo Ferreira de Souza
- `Cycle2 slideshow plugin for jQuery`_
- Font Awesome (`icon`_)
- Wolfgang Beyer (`Mandelbrot image set`_ used in tests)

Development sponsored by Simples Consultoria.

.. _`Cycle2 slideshow plugin for jQuery`: http://jquery.malsup.com/cycle2/
.. _`icon`: http://fontawesome.io/icon/picture-o/
.. _`Mandelbrot image set`: https://commons.wikimedia.org/wiki/File:Mandel_zoom_00_mandelbrot_set.jpg

Changelog
=========

There's a frood who really knows where his towel is.

1.0b3 (2018-01-30)
------------------

- Fix brown bag release.
  [hvelarde]


1.0b2 (2018-01-29)
------------------

- Remove indirect dependency on five.grok.
  [hvelarde]

- Add compatibility with Python 3.
  [hvelarde]

- Fix human readable file sizes (fixes `#23 <https://github.com/collective/sc.photogallery/issues/23>`_).
  [hvelarde]

- Process static resources using webpack.
  [rodfersou]

- Fix registration of Photo Gallery views.
  [hvelarde]

- Use HTML entities in Unicode Normalization Form C to avoid warnings when validating.
  [hvelarde]


1.0b1 (2016-03-15)
------------------

- Remove hard dependency on plone.app.referenceablebehavior as Archetypes is no longer the default framework in Plone 5.
  Under Plone < 5.0 you should now explicitly add it to the `eggs` part of your buildout configuration to avoid issues while upgrading.
  [hvelarde]

- Avoid photo distorting when landscape format is used.
  [rodfersou]

- The Photo Gallery content type now includes a new `allow_download` field to restrict the downloading of images on an item (closes `#24`_).
  [hvelarde]

- Add Brazilian Portuguese and Spanish translations.
  [hvelarde]

- Make control panel configlet accesible to Site Administrator role (closes `#20`_).
  [hvelarde]

- Add download functionality to Photo Gallery;
  if enabled, users will be able to easily download original images by using an explicit link.
  If ``ftw.zipexport`` is installed, they will be also able to download a ZIP file containing all images (closes `#14`_).
  [rodfersou, hvelarde]

- Implement lead image to be used in folder and collection views (closes `#17`_).
  [hvelarde]

- Load Cycle2 resources from the JS registry if available (closes `#10`_).
  [hvelarde]

- Add Photo Gallery tile for collective.cover.
  [rodfersou, hvelarde]

- Remove dependency on five.grok (closes `#7`_).
  [hvelarde]

- Update template with carousel pager and more layout control (closes `#4`_).
  [rodfersou, agnogueira]

- Drop support for Plone 4.2.
  [hvelarde]

- A Photo Gallery can now be set as the default page view on a container (closes `#1`_).
  [hvelarde]


1.0a1 (2014-08-04)
------------------

- Initial release.

.. _`#1`: https://github.com/collective/sc.photogallery/issues/1
.. _`#4`: https://github.com/collective/sc.photogallery/issues/4
.. _`#7`: https://github.com/collective/sc.photogallery/issues/7
.. _`#10`: https://github.com/collective/sc.photogallery/issues/10
.. _`#14`: https://github.com/collective/sc.photogallery/issues/14
.. _`#17`: https://github.com/collective/sc.photogallery/issues/17
.. _`#20`: https://github.com/collective/sc.photogallery/issues/20
.. _`#24`: https://github.com/collective/sc.photogallery/issues/24