Metadata-Version: 1.0
Name: collective.vaporisation
Version: 1.2.3
Summary: Plone portlet for vaporisation tagcloud
Home-page: http://plone.org/products/collective.vaporisation
Author: RedTurtle Technology
Author-email: sviluppoplone@redturtle.net
License: GPL
Description: .. contents::
        
        Introduction
        ============
        
        The collective.vaporisation addons for Plone give to the user a tag cloud portlet.
        
            A tag cloud (or weighted list in visual design) is a visual depiction of keywords used 
            into your site. Tags are usually single words and are normally listed alphabetically, 
            and the importance of a tag is shown with font size. Thus, it is possible to find a tag 
            alphabetically and by popularity. 
            The tags are hyperlinks that lead to a collection of contents that are associated with a keyword.
            This hyperlinks makes a Plone search that show the list of contents marked with the keyword selected.
        
            -- Definition of tag cloud `from Wikipedia`__ 
        
        __ http://en.wikipedia.org/wiki/Tag_cloud
        
        .. figure:: http://keul.it/images/plone/collective.porteltpage-1.2.1-01.png
           :alt: MoNet MultimediaMO tagcloud
        
           Big tagcloud used in a collective.portletpage area
        
        .. figure:: http://keul.it/images/plone/collective.porteltpage-1.2.1-02.png
           :alt: CCFE site tagcloud portlet
        
           With some CSS rules you can customize colors
        
        An advanced feature is the "*join navigation*" that allows user to make a search related and sequential.
        During the search the view of the portlet is different. One first part of it shows only the keywords 
        into the contents that are result of the search. A second one show the selected tags allowing user to 
        remove some of them from the search.
        
        Usage
        =====
        
        When you add this kind of portlet, named "Tagcloud portlet", you're in front of an 
        edit form with many fields.
        
        We see in detail what they do:
        
        `Name to display`
             The name of the tag cloud. For display purposes.
        `Number of different sizes`
             This number will determine the biggest size.
        `Number of keywords to display`
             This number indicate the max number of keywords shown. The value 0 (zero) show  all the keywords.
        `Cloud reload timeout`
             Time in minutes after which the cloud should be reloaded. This time isn't the only parameter that
             force the reload of cloud.
             Put this value to "0" for disabling caching (**don't do this on production**).
        `Start path`
             Only the objects under this directory will be taken in consideration. 
             If empty (default), the portlet will search in all the site.
        `Indexes to use`
             In this field you can select the indexes to use.
             We can use all the KeywordIndex defined into your site.
             The default one is "Subject" index of Plone.
        `Type of contents`
             We can filter the objects by type. 
             Only the objects of the selected types will be used to search the keywords.
        `Activate joint navigation`
             With this options active the portlet change his view to show only the related keywords.
             This will be seen during the functionality of search of contents with some keywords.
        `Use only the keywords of this list`
             A whitelist for a manual choise of the keywords to show.
             Remove from keywords list:
             A blacklist for remove some keywords from the shown.
        `Mode to use`
             Select a mode of use among those diponibile.
             Now we have only one mode of use. Other one can be implementated by external package
             through an adapter.
        `Sort keywords`
             If actived, the keywords will be sorted alphabetically.
        
        TODO and know issues
        ====================
        
        - If you're using more than one tag cloud portlet you have to remind to use different name. In this way, 
          the "join navigation" will be applied only to the portlet where the user clicks over a keyword.
        - The list of keywords used into the edit form doesn't change dinamically when the filters change
          To use the whitelist or the blacklist after a change to one of field used to filter the contents 
          (like "*Start path*", "*Indexes to use*" and "*Type of contents*") you need to save the portlet and 
          re-enter into edit.
          
          During the load of edit form the vocabularies will be recreated.
        
        Dependencies
        ============
        
        Tested on:
        
        * Plone 3.3
        * Plone 4.0
        * Plone 4.1
        
        Credits
        =======
        
        Developed with the support of:
        
        * `Rete Civica Mo-Net - Comune di Modena`__
          
          .. image:: http://www.comune.modena.it/grafica/logoComune/logoComunexweb.jpg 
             :alt: Comune di Modena - logo
          
        * `Camera di Commercio di Ferrara`__
        
          .. image:: http://www.fe.camcom.it/cciaa-logo.png/
             :alt: Comune di Modena - logo
        
        All of them supports the `PloneGov initiative`__.
        
        __ http://www.comune.modena.it/
        __ http://www.fe.camcom.it/
        __ http://www.plonegov.it/
        
        Authors
        =======
        
        This product was developed by RedTurtle Technology team.
        
        .. image:: http://www.redturtle.net/redturtle_banner.png
           :alt: RedTurtle Technology Site
           :target: http://www.redturtle.net/
        
        Original idea and code came from Souheil Shelfouh, that made `vaporisation`__ product
        
        __ http://plone.org/products/vaporisation
        
        
        
        
        Changelog
        =========
        
        1.2.3 (2011-07-27)
        ------------------
        
        - SEO friend: cloud SERP page now add a propert ``meta`` tag [keul]  
        - SEO friend: cloud link now use a proper ``rel`` value for stop
          search engines to try indexing cloud SERP pages [keul]
        - changed the default value for *join navigation* as it can be very
          expensive in some kind of sites. A simple search page is enough
          for most users [keul]
        - some XHTML Strict fixes in the SERP page [keul]
        
        1.2.2 (2011-06-30)
        ------------------
        
        - now the ``cloud_search`` view is registered only for the site root [keul]
          This was the same issue fixed in version 1.2, but a search engine have long memory
          and it could continue to kill the site cache [keul]
        - egg cleanup [keul]
        - fixed tests (even if they are only ZopeSkel defaults) [keul]
        - fixed egg dependency properly for Plone 4.1 [keul]
        
        1.2.1 (2011-03-18)
        ------------------
        
        - fixed compatibility problem of cloud search results and Plone 4 [nan010]
        
        1.2.0 (2011-02-24)
        ------------------
        
        - fix XHTML Strict bug when the current context has a non-prettified id [keul]
        - tagcloud id now is generated starting from the given title, not from the
          title of the current context (that was nonsense) [keul]
        - the search view is now called on the portlet context, not actual context.
          This was cache-killer [keul]
        
        1.1.3 (2010-11-11)
        ------------------
        
        - release version [mircoangelini]
        
        1.1.2 (2010-10-27)
        ------------------
        
        - fix unicode bug in computing of weights [mircoangelini]
        
        1.1.1 (2010-10-12)
        ------------------
        
        - you can now put "0" in portlet cache (highly unefficient) [keul]
        - fixed the weight of the keywords; now doesn't counts the same object more than one 
          time even if the same keyword is used in more than one index
          [mircoangelini]
        - added to the cache key a new parameter: the id of user [mircoangelini]
        
        1.1.0 (2010-10-05)
        ------------------
        
        - added flag to sort keywords [micecchi]
        
        1.0.0 (2010-10-01)
        ------------------
        
        - moved on collective SVN [mircoangelini]
        
        
Keywords: plone plonegov vaporisation tag-cloud portlet
Platform: UNKNOWN
Classifier: Framework :: Plone
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
