Changes for page Tag Cloud
Last modified by Tobias Wintrich on 2025/06/04 09:20
From version 2.1
edited by Tobias Wintrich
on 2022/09/15 15:18
on 2022/09/15 15:18
Change comment:
Migrated property [defaultCategories] from class [XWiki.WikiMacroClass]
To version 4.1
edited by Tobias Wintrich
on 2023/03/20 11:07
on 2023/03/20 11:07
Change comment:
Install extension [org.xwiki.platform:xwiki-platform-tag-ui/15.1]
Summary
-
Objects (1 modified, 1 added, 0 removed)
Details
- XWiki.WikiMacroClass[0]
-
- Cached
-
... ... @@ -1,0 +1,1 @@ 1 +No - Asynchronous rendering
-
... ... @@ -1,0 +1,1 @@ 1 +No - Macro code
-
... ... @@ -3,6 +3,7 @@ 3 3 ## tagCloudSpace - the space to display the tag cloud for. If blank, display cloud for the whole wiki. Default is blank. 4 4 #set ($tagCloudSpace = $xcontext.macro.params.get('space')) 5 5 #set ($tagCloudSpaces = $xcontext.macro.params.get('spaces')) 6 +#set ($limit = $xcontext.macro.params.get('limit')) 6 6 ## 7 7 ## Configurable popularity levels. You must enter an even number of levels. Default: 6. 8 8 #set ($popularityLevels = ["notPopular", "notVeryPopular", "somewhatPopular", "popular", "veryPopular", "ultraPopular"]) ... ... @@ -26,22 +26,35 @@ 26 26 ## Get tag count map. Key: tag, value: number of occurrences. 27 27 #set ($tagCount = $xwiki.tag.getTagCount("$!tagCloudSpace")) 28 28 #end 30 +## Organize tags as a list of {name, count} object so that it is easier to handle (sorting, limiting, ...) 31 +#set ($tagCountList = []) 32 +#foreach ($tagName in $tagCount.keySet()) 33 + #set ($discard = $tagCountList.add({ 34 + "name": $tagName, 35 + "count": $tagCount[$tagName] 36 + })) 37 +#end 38 +## If a limit is set, only keep n most occurring tags 39 +## If tags have the same occurrence, limit them in alphabetical order 40 +#set ($tagCountListSorted = $collectiontool.sort($tagCountList, ['count:desc', 'name'])) 41 +#if ("$!limit" != '') 42 + #set ($tagCountListSorted = $tagCountListSorted.subList(0, $limit)) 43 +#end 29 29 ## 30 30 ## Only build popularity map if at least one tag exists 31 -#if ($tagCount.size() > 0) 46 +#if ($tagCountListSorted.size() > 0) 32 32 ## 33 33 ## Store the minimum and maximum number of occurrences. 34 - #set ($sortedTagCounts = $collectiontool.sort($tagCount.values())) 35 - #set ($maxIndex = $sortedTagCounts.size() - 1) 36 - #set ($minCount = $sortedTagCounts[0]) 37 - #set ($maxCount = $sortedTagCounts[$maxIndex]) 49 + #set ($maxIndex = $tagCountListSorted.size() - 1) 50 + #set ($maxCount = $tagCountListSorted[0].count) 51 + #set ($minCount = $tagCountListSorted[$maxIndex].count) 38 38 ## 39 39 ## Calculate the total number of tags in the wiki. 40 40 #set ($totalTagNumber = 0) 41 - #foreach ($currentTag Countin $sortedTagCounts)42 - #set ($totalTagNumber = $totalTagNumber + $currentTag Count)55 + #foreach ($currentTag in $tagCountListSorted) 56 + #set ($totalTagNumber = $totalTagNumber + $currentTag.count) 43 43 #end 44 - #set ($countAverage = $mathtool.div($totalTagNumber, $tagCount.size())) 58 + #set ($countAverage = $mathtool.div($totalTagNumber, $tagCountListSorted.size())) 45 45 ## 46 46 ## Build popularity map using the difference between minimum / maximum tag occurrences counts, and the average tag occurences count. 47 47 #set ($firstHalfIntervalSize = $mathtool.div($mathtool.sub($countAverage, $minCount), $levelsHalf)) ... ... @@ -68,17 +68,17 @@ 68 68 ## 69 69 ## Display tag cloud. 70 70 {{html}} 71 -#if ($tagCount.size() > 0) 85 +#if ($tagCountListSorted.size() > 0) 72 72 <ol class="tagCloud"> 73 - #foreach ($tagEntry in $tagCount .entrySet())87 + #foreach ($tagEntry in $collectiontool.sort($tagCountListSorted, 'name')) 74 74 #foreach ($popularityEntry in $popularityMap.entrySet()) 75 - #if ($popularityEntry.Key >= $tagEntry. Value)89 + #if ($popularityEntry.Key >= $tagEntry.count) 76 76 #set ($liClass = $popularityEntry.Value) 77 77 #break 78 78 #end 79 79 #end 80 80 <li class="$liClass"> 81 - <a class="tag" href="$xwiki.getURL('Main.Tags', 'view', "do=viewTag&tag=$escapetool.url($tagEntry. Key)")" title="$services.localization.render('xe.tag.tooltip', [$tagEntry.Value])">$escapetool.xml($tagEntry.Key)</a>95 + <a class="tag" href="$xwiki.getURL('Main.Tags', 'view', "do=viewTag&tag=$escapetool.url($tagEntry.name)")" title="$services.localization.render('xe.tag.tooltip', [$tagEntry.count])">$escapetool.xml($tagEntry.name)</a> 82 82 </li> 83 83 #end 84 84 </ol> - Default categories
-
... ... @@ -1,0 +1,1 @@ 1 +Content - Default category
-
... ... @@ -1,1 +1,0 @@ 1 -Content
- XWiki.WikiMacroParameterClass[2]
-
- Parameter description
-
... ... @@ -1,0 +1,1 @@ 1 +Max count of tags to be displayed in the cloud - Parameter mandatory
-
... ... @@ -1,0 +1,1 @@ 1 +No - Parameter name
-
... ... @@ -1,0 +1,1 @@ 1 +limit - Parameter type
-
... ... @@ -1,0 +1,1 @@ 1 +java.lang.Integer