Metadata-Version: 1.0
Name: vs.flexigridsearch
Version: 0.4.1
Summary: Plone  search results through flexigrid
Home-page: http://pypi.python.org/pypi/vs.flexigridsearch
Author: Andreas Jung
Author-email: info@zopyx.com
License: GPL
Description: vs.flexigridsearch
        ==================
        
        ``vs.flexigridsearch`` provides a drop-in replacement to the search.pt template
        of Plone 3/4.  The search results are presented as a sortable table using the
        jQuery ``flexigrid`` plugin.
        
        Installation
        ------------
        * add ``vs.flexigridsearch`` to the ``eggs`` option of your buildout configuration
          and re-run buildout
        * create a new Plone site using the related Plone3 or Plone 4 extension profile of 
          ``vs.flexigridsearch``
        * or import the related profile for an existing Plone site through ``portal_setup`` 
          (``Import`` tab) (there are dedicatd profiles for Plone 3 and Plone 4 since we
          need different flexigrid versions due to different jQuery versions in Plone 3 and 4).
        
        
        Usage
        -----
        * no special usage: perform a search and the result should be rendered using
          the flexgrid jQuery add-on.
        
        Configuration
        -------------
        * ``vs.flexigridsearch`` uses a property sheet under
          portal_properties/flexigridsearch_properties for its configuration:
        
          - ``portalTypesToSearch`` - a list of portal types to be searched 
            (a future version of the software will use the configuration of Plone)
        
          - ``sort_limit`` - maximum number of hits to be retrieved from portal_catalog.
            The parameter name is kind of misleading but the portal_catalog will
            really limit the number of returned rows
        
          - ``columns`` - defines the columns of the flexigrid table. In general 
            ``vs.flexigridsearch`` can support all searchable indexes of the portal_catalog:
        
            - getId (this should be always included if you want a clickable link to the content object)
            - Description
            - Title
            - created
            - Creator
            - start
            - end
            - effective
            - expires
            - location
            - Subject
            - getObjSize
            - review_state
            - portal_type
        
        Requirements
        ------------
        * tested with Plone 3.3.X, 4.0.X
        
        Translations
        ------------
        
        Due to the lack of a proper i18n framework in Plone we provide our own
        home-grown i18n translation functionality in
        ``skins/vs_flexigridsearch/vs_flexigridsearch_translations.js``.  Please add
        your translations directly here.
        
        Licence
        -------
        ``vs.flexigridsearch`` is published under the GNU Public Licence V 2 (GPL 2)
        
        Authors
        -------
        
        | Andreas Jung
        | info@zopyx.com
        | www.zopyx.com
        |
        | Veit Schiele
        | kontakt@veit-schiele.de
        | www.veit-schiele.de
        |
        
        Changelog
        =========
        
        0.4.1 (2011/05/24)
        ------------------
        - more robust parsing of configuration properties
        - updated documentation
        
        
        0.4.0 (2011/05/23)
        ------------------
        - i18n for templates and JS code (English, German)
        
        
        0.3.1 (2011/05/20)
        ------------------
        - fixed improper url usage
        
        0.3.0 (2011/05/20)
        ------------------
        - update documentation
        - directly replacing search.pt (no more custom_search.pt)
        
        0.2.2 (2011/05/19)
        ------------------
        - overwriting ``search`` method in order to act as 
          a drop-in replacement for the standard plone search
          results page
        
        0.2.1 (2011/05/16)
        ------------------
        - added getId to default columns
        
        0.2.0 (2011/05/12)
        ------------------
        - now compatible with Plone 3 and 4
        
        0.1.1 (2011/05/12)
        ------------------
        - added support for more standard indexes
        - documentation update
        
        0.1 (2011/05/11)
        ----------------
        
        - Initial release
        
Keywords: Plone jQuery flexigrid Search Zope Search
Platform: UNKNOWN
Classifier: Framework :: Plone
Classifier: Programming Language :: Python
