collective.vaporisation 1.1.3

Plone portlet for vaporisation tagcloud

Contents

• Introduction

• Usage

• ToDo and tricks of usage

• Credits

• Authors

• Changelog

  • 1.1.3 (2010-11-11)

  • 1.1.2 (2010-10-27)

  • 1.1.1 (2010-10-12)

  • 1.1.0 (2010-10-05)

  • 1.0.0 (2010-10-01)

  • 0.0.3-alfa (2010-03-12)

  • 0.0.2 (Unreleased)

  • 0.0.1 (Unreleased)

Introduction

collective.vaporisation it’s a product that 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 akeyword. This hyperlinks makes a Plone search that show the list of contents marked with the keyword selected.

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.

• 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 tricks of usage

• If we’re using more than one tag cloud portlet we 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.

Credits

Developed with the support of Rete Civica Mo-Net - Comune di Modena; Rete Civica Mo-Net - Comune di Modena supports the PloneGov initiative.

Authors

This product was developed by RedTurtle Technology team.

Original idea and code came from Souheil Shelfouh, that made vaporisation product

Changelog

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]

0.0.3-alfa (2010-03-12)

• aded feature: type white list [mircoangelini]

• added italian translation [mircoangelini]

• modified the generation of URLs for the search task [mircoangelini]

• modified the search to permit at the search of find all the object that come from keyword present in more than one index. Now we use a method that perform a multiple search in the catalog. [mircoangelini]

• added to URL of the search the parameter “portlet” to identify the cloud portlet we are using. This is necessary when we have two portlet with the same keyword shown and we need to render only the used portlet. [mircoangelini]

0.0.2 (Unreleased)

• added into portlet’s schema fields white_list (filter for the list of keywords), index_to_use (list of fields used to populate the cloud), mode_to_use (selector for some additional adapters) [mircoangelini]

• modified some function to the behavior of the whole system. Are now show the keywords of the fields selected in the relative list. [mircoangelini]

• modified the updating system of cloud. It’s now used ram.cache with a number of minutes customizable by user. [mircoangelini]

0.0.1 (Unreleased)

• First version: merging vaporisation and contextual.vaporisation [mircoangelini]