Metadata-Version: 1.1
Name: pelican-albums
Version: 0.6.0
Summary: Automatic photo album generation and thumbnailing for Pelican.
Home-page: https://github.com/iksteen/pelican-albums/
Author: Ingmar Steen
Author-email: iksteen@gmail.com
License: UNKNOWN
Download-URL: https://github.com/iksteen/pelican-albums/tarball/v0.6.0
Description: Pelican-Albums
        ==============
        
        Pelican-Albums is a plugin for Pelican that helps you to easily manage your
        photo albums (or galleries).
        
        Features
        --------
        
        - Easily reference an image in your album path using {image}album/image.jpg.
        - Automatically create a thumbnail for an image in your album path using
          ``{thumbnail}album/image.jpg`` or ``{thumbnail:NxN@Q}album/image.jpg``.
        - Automatically create album pages by adding a page to an album directory.
        
        Installation
        ------------
        
        To install pelican-albums to your pelican installation use::
        
            $ pip install pelican-albums
        
        Then, add 'pelican_albums' to the plugin list in your publishconf.py::
        
            PLUGINS = ['pelican_albums']
        
        Settings
        --------
        
        Pelican-albums provides a couple of settings:
        
        - ``ALBUM_PATH`` (*images*): What directory inside ``content`` contains your
          albums.
        - ``THUMBNAIL_OUTPUT_PATH`` (*images/thumbnails*): What directory inside
          the ``output`` directory will be used to store thumbnails.
        - ``THUMBNAIL_OUTPUT_FORMAT`` (*JPEG*): As what format the thumbnails should
          be created (*JPEG* or *PNG*).
        - ``THUMBNAIL_DEFAULT_SIZE`` (*192x192*): What the default size of a
          thumbnail should be.
        - ``THUMBNAIL_DEFAULT_QUALITY`` (*80*): What the default quality of a
          JPEG thumbnail should be.
        - ``ALBUM_SAVE_AS`` (*albums/{slug}.html*): Where to store album indexes.
        - ``ALBUM_URL`` (*albums/{slug}.html*):  The URL scheme to reference an album.
        
        Albums
        ------
        
        To create a new album, just create a new directory in the ``ALBUM_PATH`` (the
        default is *content/images*) and place the images inside it. Please note that
        pelican-albums does not offer facilities to rotate or resize the images for
        you (except for creating thumbnails) at this moment.
        
        Thumbnails
        ----------
        
        Pelican-albums will automatically generate the requested thumbnails at the
        requested sizes. It will check the ``mtime`` of the original file to that
        of the thumbnail to check if the thumbnail should be refreshed.
        
        You can specify the size and quality of a thumbnail on different places:
        
        - Inside the {thumbnail} tag: {thumbnail:128x128@80}album/image.jpg
        - In the metadata of the content: Thumbnail-Size: 128x128@80
        - As a parameter to the ``album.thumbnail(spec=None)`` in your templates.
        - In the global pelican settings.
        
        A thumbnail size specifier can have a number of different forms:
        
        - *WIDTHxHEIGHT* -- Crop and resize an image until a thumbnail of these
          exact dimensions is the result (f.e. 192x192).
        - *DIMENSION* -- Shorthand for *DIMENSIONxDIMENSION* (f.e. 192).
        - *WIDTHx* -- Create a thumbnail with the given width but keep the original
          aspect ratio so the height might vary (f.e. 192x).
        - *xHEIGHT* -- Create a thumbnail with the given height but keep the original
          aspect ratio so the width might vary (f.e. x192).
        
        You can optionally add an *@nn* suffix to the size to indicate the thumbnail
        quality that should be used (f.e. 192@80 for a 192x192 thumbnail at 80%
        quality). This specifies the JPEG file quality and does not apply to PNG
        thumbnails.
        
        Album pages
        -----------
        
        By creating a page inside an album folder, a page will be generated using the
        ``album.html`` template. Both the ``album`` and the ``page`` will be available
        inside the template. The ``page`` object works exactly as the regular pelican
        page objects.
        
        The ``album`` object has several properties:
        
        - ``images`` -- The images contained in this album.
        - ``albums`` -- A list of sub-albums (if any).
        - ``pages`` -- The album pages for this album (you can create multiple pages
          for each album if you want).
        
        The ``image`` objects returned by ``album.images`` have the following
        properties:
        
        - ``album`` -- The album this image belongs to.
        - ``filename`` -- The filename of this image.
        - ``url`` -- The URL of this image relative to the site URL.
        - ``thumbnail(spec=None)`` -- A method that returns the URL of a thumbnail of
          the given (or default) size and quality relative to the site URL.
        
        album.html
        ----------
        
        An example template for album pages (save this as *album.html* inside your
        templates directory)::
        
            {% extends "base.html" %}
            {% block title %}{{ page.title }}{%endblock%}
            {% block content %}
            <article class="page">
                <header>
                    <div class="title">
                        {{ page.title }}
                    </div>
                </header>
            
                <div class="entry-content">
                    {{ page.content }}
                </div>
            
                <div class="album">
                    {% for image in album.images %}
                        <a href="{{ SITEURL }}/{{ image.url }}">
                            <img src="{{ SITEURL }}/{{ image.thumbnail(page.metadata.get('thumbnail-size')) }}"
                                 title="{{ image.filename }}" />
                        </a>
                    {% endfor %}
                </div>
            </article>
            {% endblock %}
        
        Release history
        ###############
        
        0.6.0 (2015-04-28)
        ==================
        
        * Allow using PNG files as thumbnails instead of JPEG.
        * Allow specifying the thumbnail quality.
        * Increase default quality to 80%.
        
        0.5.1 (2015-04-13)
        ==================
        
        * Automatically exclude the album path from the article and page generators.
        * Documentation improvements.
        
        0.5.0 (2015-04-12)
        ==================
        
        * Initial release.
        
Platform: UNKNOWN
Classifier: Environment :: Plugins
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
