Tags:
,
view all tags
---+!! <nop>%TOPIC% <!-- Contributions to this plugin are appreciated. Please update the plugin page at http://twiki.org/cgi-bin/view/Plugins/TagCloudPlugin or provide feedback at http://twiki.org/cgi-bin/view/Plugins/TagCloudPluginDev. If you are a TWiki contributor please update the plugin in the SVN repository. --> <div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;"> %TOC{title="Page contents"}% </div> %SHORTDESCRIPTION% %STARTINCLUDE% ---++ Description This plugin helps rendering tag clouds. From Wikipedia:Tag_cloud <div style="margin:20px;font-style:italic"> A Tag Cloud is a text-based depiction of tags across a body of content to show frequency of tag usage and enable topic browsing. In general, the more commonly used tags are displayed with a larger font or stronger emphasis. Each term in the tag cloud is a link to the collection of items that have that tag. </div> Tag clouds give a very quick overview of the distribution of terms within a document base. This can be used to support navigation or just to display the characteristics of the given data. Tag clouds are quite common in blog archives where you can click on a tag in the cloud and list all postings that are tagged that way. Tag clouds can be generated on any list of terms that don't need to be "tags" in the more stricter sense, though the name of the figure is still "tag cloud". ---++ How tag clouds are computed Computing the tag cloud is done by counting the occurrences of the terms in the input data. First, the input data has to be tokenized and normalized to match each word in the input to a term by 1 splitting up the data, removing special characters, 1 mapping different terms on one term, like handling synonyms (e.g. twikiapps=<nop>TWikiApplication) (optional) 1 filtering unwanted words; there's a predefined list of (english) stop words that can applied 1 mapping plural to singular word forms (done rudimentarily for english only) Once all terms have been counted they are mapped into a fixed set of _buckets_. For example given 102 different terms have been counted and ordered by frequency, they are mapped into a set of -- let's say -- 30 buckets that are containing those terms. Each term is assigned a _weight_, that is the ID of the bucket it has been sorted in. In general the tag cloud renders the more frequent terms bolder and/or more colorful than the less frequent. See [[#Example][the exmaple below]]. But you are free to configure any variation of the appearance of a tag depending on its frequency. ---++ Syntax Rules *Syntax*: <verbatim> %TAGCLOUD{(terms=)"<term-list>" ... }% </verbatim> renders a tag cloud given a list of terms from which the term frequencies are extracted. There are a couple of options that influence the way the list of terms is tokenized and processed, as well as the appearance of the resulting tag cloud. Parameters: * =terms=: input data, a list of terms; a term can have the form =term:weight= whereas the occurrence of this term is counted with the given weight * =split=: regular expression used to split up the input data (default: =[/,\.?\s]+=) * =stopwords=: switch on/off filtering common (English) stop words (default: off) * =filter=: regular expression of characters to be filtered out; possible values are 'on': to remove a predefined set of special chars, 'off' don't filter at all or an arbitrary string of characters to be replaced with a single space; default value is 'off' * =exclude=: regular expression of terms to exclude from the tag cloud (default: undefined) * =include=: regular expression of terms that should be included (default: undefined) * =buckets=: number of buckets which to sort terms into (default: 10) * =sort=: sort terms in the tag cloud alphabetically or by weight (alpha, count or weight) (default: alpha) * =group=: format string to distinguish groups within the sortion; if the tag cloud is sorted alphabetically terms are groupd according their first letter; terms sorted by weight are grouped by their weight collected in tenner chunks. That is terms with a weight 1-10 are put in group "10", terms with a weight 11-20 are in "20" and so on; the current group displayed by replacing the pseudo variable =$group= in it; example: group="<b>$group</b>" (default: <empty>) * =reverse=: reverse the sorting (on or off) (default: off) * =min=: minimum times a term must occur to be included in the tag cloud * =offset=: integer value that is added to the weight number of a term (default: 10) * =lowercase=: switch on/off converting terms to lowercase (default: off) * =plural=: switch on/off counting plurals, if set to off plural terms are matched to their singular form (caution: very rudimentary and assuming the input data is all English, use stopwords="on" to get good results) * =map=: list of terms to be normalized as synonyms; the format of this is: "from1=to1,from2=to2,..." Each occurrence of =from1= will be mapped to =to1= etc, and counted as such * =header=: format string to precede the output * =format=: format string for each tag in the tag cloud * =sep(arator)=: format string to be put between each tag in the cloud * =footer=: format string appended to the output * =warn=: switch on/off warning if no term was found (default: on) * =limit=: number of terms to display, defaults to 0 - meaning display all Format strings (=terms=, =header=, =format=, =sep= and =footer=) might contain the following pseudo variables: * =$index=: the number of the tag in the (sorted) tag cloud * =$term=: the term itself * =$weight=: the term weight (that is: bucket + offset) * =$count=: the number the term has been counted * =$fadeRGB(startRed,startGreen,startBlue,endRed,endGreen,endBlue)= color of the term given its current weight in a color gradient defined by the given 6 integer values; returns a string =rgb(red,green,blue)= that can be used in a css color property * =$percnt=: expands to =%= * =$dollar=: expands to =$= * =$n=: expands to a linefeed * =$nop=: is removed from the format string * =$group=: grouping format string, see above %STOPINCLUDE% ---++ Example Cloud for the above text: *You type*: <verbatim> %TAGCLOUD{"$percntINCLUDE{\"%WEB%.%TOPIC%\"}$percnt" header="<div style=\"text-align:center; padding:15px;line-height:180%\">" format="<span style=\"font-size:$weightpx;line-height:90%\"><a style=\"color:$fadeRGB(104,144,184,0,102,255);text-decoration:none\" title=\"$count\">$term</a></span>" footer="</div>" buckets="40" offset="12" lowercase="on" stopwords="on" plural="off" min="2" map="bucket=pail" }% </verbatim> <div style="%IF{"context TagCloudPluginEnabled" then="display:none"}%"> *You get* (faked): <img src="%ATTACHURLPATH%/TagCloud.jpg" alt="TagCloud" width="567" height="205" /> </div> <div style="%IF{"context TagCloudPluginEnabled" else="display:none"}%"> *You get* (if installed): %TAGCLOUD{"$percntINCLUDE{\"%WEB%.%TOPIC%\"}$percnt" header="<div style=\"padding:15px;text-align:center;line-height:180%\">" format="<span style=\"font-size:$weightpx;line-height:90%\"><a style=\"color:$fadeRGB(104,144,184,0,102,255);text-decoration:none\" title=\"$count\">$term</a></span>" footer="</div>" buckets="40" offset="12" lowercase="on" stopwords="on" plural="off" min="2" map="bucket=pail" }% </div> ---++ Plugin Operations/Installation Instructions __Note:__ You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server. * Download the ZIP file from the Plugin Home (see below) * Unzip it in your twiki installation directory. Content: | *File:* | *Description:* | | ==data/TWiki/TagCloudPlugin.txt== | | | ==lib/TWiki/Plugins/TagCloudPlugin/Core.pm== | | | ==lib/TWiki/Plugins/TagCloudPlugin.pm== | | | ==pub/TWiki/TagCloudPlugin/TagCloud.jpg== | | * Run the [[%SCRIPTURL{configure}%][configure]] script to enable the plugin ---++ Plugin Info <!-- * Set SHORTDESCRIPTION = Renders a tag cloud given a list of terms --> | Plugin Author: | TWiki:Main.MichaelDaum | | Copyright: | © 2006-2008 Michael Daum http://michaeldaumconsulting.com; %BR% © 2006-2010 TWiki:TWiki.TWikiContributor | | License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) | | Plugin Version: | 19266 (2010-07-26) | | Change History: | <!-- specify latest version first --> | | 2010-07-25: | TWikibug:Item6530 - doc fixes, changing TWIKIWEB to SYSTEMWEB | | 03 Jan 2008: | added limit parameter; added sorting according to term frequency (count) | | 13 Sep 2007: | don't remove numericals from terms | | 05 Jun 2007: | better default values, e.g. filter is off by default now; fixed expansion of standard escapes | | 31 Aug 2006: | added filter parameter to customize special chars to be excluded; added NO_PREFS_IN_TOPIC | | 10 Mar 2006: | added grouping | | 07 Mar 2006: | added escape chars to the term list parameter | | 03 Mar 2006: | added warn parameter; fixed use of uninitialised value; if tags are sorted by weight tags of the same weight get sorted alphabetically now; sorting by weight is desending by default now | | 01 Mar 2006: | added docu, added more pre-defined english stop words, added map and plural parameters, reworked order of tokenization. added fadeRGB format string variable | | 24 Feb 2006: | Initial version | | Perl Version: | 5.8 | | TWiki:Plugins/Benchmark: | %SYSTEMWEB%.GoodStyle nn%, %SYSTEMWEB%.FormattedSearch nn%, %TOPIC% nn% | | Plugin Home: | TWiki:Plugins/%TOPIC% | | Feedback: | TWiki:Plugins/%TOPIC%Dev |
Attachments
Attachments
Topic attachments
I
Attachment
Action
Size
Date
Who
Comment
jpg
TagCloud.jpg
manage
21.5 K
2010-07-26 - 07:39
TWikiAdminUser
Saved by install script
Edit
|
Attach
|
PDF
|
H
istory
:
r6
<
r5
<
r4
<
r3
<
r2
|
B
acklinks
|
V
iew topic
|
More topic actions...
Topic revision: r3 - 2011-10-24
-
TWikiAdminUser
Home
Site map
CEMon web
CREAM web
Cloud web
Cyclops web
DGAS web
EgeeJra1It web
Gows web
GridOversight web
IGIPortal web
IGIRelease web
MPI web
Main web
MarcheCloud web
MarcheCloudPilotaCNAF web
Middleware web
Operations web
Sandbox web
Security web
SiteAdminCorner web
TWiki web
Training web
UserSupport web
VOMS web
WMS web
WMSMonitor web
WeNMR web
TWiki Web
User registration
Users
Groups
Index
Search
Changes
Notifications
RSS Feed
Statistics
Preferences
View
Raw View
Print version
Find backlinks
History
More topic actions
Edit
Raw edit
Attach file or image
Edit topic preference settings
Set new parent
More topic actions
User Reference
ATasteOfTWiki
TextFormattingRules
TWikiVariables
FormattedSearch
QuerySearch
TWikiDocGraphics
TWikiSkinBrowser
InstalledPlugins
Admin Maintenance
Reference Manual
InterWikis
ManagingUsers
ManagingWebs
TWikiSiteTools
TWikiPreferences
WebPreferences
Categories
Admin Documentation
Admin Tools
Developer Doc
User Documentation
User Tools
Account
Log In
Edit
Attach
Copyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki?
Send feedback
Note:
Please contribute updates to this topic on TWiki.org at
TWiki:TWiki.TagCloudPlugin
.