Metadata-Version: 1.0
Name: raptus.article.teaser
Version: 2.0b11
Summary: Provides support for a teaser image.
Home-page: https://github.com/Raptus/raptus.article.teaser
Author: Raptus AG
Author-email: dev@raptus.com
License: GPL
Description: Introduction
        ============
        
        raptus.article.teaser provides support for adding a teaser image on article.
        
        The following features for raptus.article are provided by this package:
        
        Fields
        ------
            * Provides an image field for the articles.
        
        Components
        ----------
            * raptus.article.teaser.full
            * raptus.article.teaser.right
            * raptus.article.teaser.left
        
        Dependencies
        ------------
            * collective.flowplayer
            * Products.ContentTypeValidator
            * raptus.article.core
            * plone.app.imaging
        
        Installation
        ============
        
        To install raptus.article.teaser into your Plone instance, locate the file
        buildout.cfg in the root of your Plone instance directory on the file system,
        and open it in a text editor.
        
        Add the actual raptus.article.teaser add-on to the "eggs" section of
        buildout.cfg. Look for the section that looks like this::
        
            eggs =
                Plone
        
        This section might have additional lines if you have other add-ons already
        installed. Just add the raptus.article.teaser on a separate line, like this::
        
            eggs =
                Plone
                raptus.article.teaser
        
        Note that you have to run buildout like this::
        
            $ bin/buildout
        
        Then go to the "Add-ons" control panel in Plone as an administrator, and
        install or reinstall the "raptus.article.default" product.
        
        Note that if you do not use the raptus.article.default package you have to
        include the zcml of raptus.article.teaser either by adding it
        to the zcml list in your buildout or by including it in another package's
        configure.zcml.
        
        Plone 3 compatibility
        ---------------------
        
        This packages requires plone.app.imaging which requires two pins in buildout
        when using Plone 3, which there are::
        
            Products.Archetypes = 1.5.16
            plone.scale = 1.2
        
        Migration
        =========
        
        Blob-storage
        ------------
        
        call this view on myplone/@@blob-article-teaser-migration and run the migration.
        all media have a separate view at myplone/@@blob-article-media-migration.
        
        Usage
        =====
        
        Components
        ----------
        Navigate to the "Components" tab of your article and select one of the teaser image
        components and press "save and view". Note that at the article requires an image to
        be set in the edit form for the components to display.
        
        Copyright and credits
        =====================
        
        raptus.article is copyrighted by `Raptus AG <http://raptus.com>`_ and licensed under the GPL. 
        See LICENSE.txt for details.
        
        Developer Manual
        ================
        
        Note: You find a developer manual for raptus.article at 
        `raptus.article.core <http://pypi.python.org/pypi/raptus.article.core>`_.
        Please have look there if you need more information.
        
        Code overview
        =============
        
        Components
        ----------
        
        plone.abovecontentbody
        ``````````````````````
        - raptus.article.teaser.full
        - raptus.article.teaser.right
        - raptus.article.teaser.left
        
        Interfaces
        ----------
        
        file: interfaces.py
        ```````````````````
        - ITeaser - (Handler for teaser thumbing and captioning)
            - getTeaserURL - method (Returns the url to the teaser image in the specific size.
              The sizes are taken from the raptus_article properties sheet and are formed by the following name schema:
              teaser_<size>_(height|width)
            - getTeaser - method (Returns the html tag of the teaser image in the specific size
              The sizes are taken from the raptus_article properties sheet and are formed by the following name schema:
              teaser_<size>_(height|width)
            - getSize - method (Returns the width and height registered for the specific size)
            - getCaption - method (Returns the caption for the image)
        
        Changelog
        =========
        
        2.0b11 (2013-07-22)
        -------------------
        
        * Use image scales defined in plone.app.imaging if it's available
          and hard-coded ones if it's not. [fRiSi]
        * Make teaser images croppable using plone.app.imagecropping if
          it's installed. [fRiSi]
        
        2.0b10 (2013-07-01)
        -------------------
        
        * No longer link to images if the displayed image is larger than the one linked to
        
        2.0b9 (2012-01-23)
        ------------------
        
        * moved plone 4.1 compatibility fix into raptus.article.core to have it applied to
          the whole raptus.article suit
        * plone 4.1 compatibility by importing cmfcore permissions [fRiSi]
        
        2.0b8 (2011-02-22)
        ------------------
        
        * add blob storage migration @@blob-article-teaser-migration
        
        2.0b7 (2010-12-07)
        ------------------
        
        * Fixed French translations
        
        2.0b6 (2010-11-10)
        ------------------
        
        * Added French translations
        
        2.0b5 (2010-10-24)
        ------------------
        
        * Set zip_safe flag to False
        
        2.0b4 (2010-10-21)
        ------------------
        
        * Updated readme and manual
        
        2.0b3 (2010-10-20)
        ------------------
        
        * First public release
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
