.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "HTML::TagCloud 3pm"
.TH HTML::TagCloud 3pm "2022-10-13" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
HTML::TagCloud \- Generate An HTML Tag Cloud
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\& # A cloud with tags that link to other web pages.
\& my $cloud = HTML::TagCloud\->new;
\& $cloud\->add($tag1, $url1, $count1);
\& $cloud\->add($tag2, $url2, $count2);
\& $cloud\->add($tag3, $url3, $count3);
\& my $html = $cloud\->html_and_css(50);
\&
\& # A cloud with tags that do not link to other web pages.
\& my $cloud = HTML::TagCloud\->new;
\& $cloud\->add_static($tag1, $count1);
\& $cloud\->add_static($tag2, $count2);
\& $cloud\->add_static($tag3, $count3);
\& my $html = $cloud\->html_and_css(50);
\&
\& # A cloud that is comprised of tags in multiple categories.
\& my $cloud = HTML::TagCloud\->new;
\& $cloud\->add($tag1, $url1, $count1, $category1);
\& $cloud\->add($tag2, $url2, $count2, $category2);
\& $cloud\->add($tag3, $url3, $count3, $category3);
\& my $html = $cloud\->html_and_css(50);
\&
\& # The same cloud without tags that link to other web pages.
\& my $cloud = HTML::TagCloud\->new;
\& $cloud\->add_static($tag1, $count1, $category1);
\& $cloud\->add_static($tag2, $count2, $category2);
\& $cloud\->add_static($tag3, $count3, $category3);
\& my $html = $cloud\->html_and_css(50);
\&
\& # Obtaining uncategorized HTML for a categorized tag cloud.
\& my $html = $cloud\->html_without_categories();
\&
\& # Explicitly requesting categorized HTML.
\& my $html = $cloud\->html_with_categories();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The HTML::TagCloud module enables you to generate \*(L"tag clouds\*(R" in
\&\s-1HTML.\s0 Tag clouds serve as a textual way to visualize terms and topics
that are used most frequently. The tags are sorted alphabetically and a
larger font is used to indicate more frequent term usage.
.PP
Example sites with tag clouds: ,
and
.
.PP
This module provides a simple interface to generating a CSS-based \s-1HTML\s0
tag cloud. You simply pass in a set of tags, their \s-1URL\s0 and their count.
This module outputs stylesheet-based \s-1HTML.\s0 You may use the included \s-1CSS\s0
or use your own.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.SS "new"
.IX Subsection "new"
The constructor takes a few optional arguments:
.PP
.Vb 1
\& my $cloud = HTML::TagCloud\->new(levels=>10);
.Ve
.PP
if not provided, levels defaults to 24
.PP
.Vb 1
\& my $cloud = HTML::TagCloud\->new(distinguish_adjacent_tags=>1);
.Ve
.PP
If distinguish_adjacent_tags is true HTML::TagCloud will use different \s-1CSS\s0
classes for adjacent tags in order to be able to make it easier to
distinguish adjacent multi-word tags. If not specified, this parameter
defaults to a false value.
.PP
.Vb 1
\& my $cloud = HTML::TagCloud\->new(categories=>\e@categories);
.Ve
.PP
If categories are provided then tags are grouped in separate divisions by
category when the \s-1HTML\s0 fragment is generated.
.SH "METHODS"
.IX Header "METHODS"
.SS "add"
.IX Subsection "add"
This module adds a tag into the cloud. You pass in the tag name, its \s-1URL\s0
and its count:
.PP
.Vb 3
\& $cloud\->add($tag1, $url1, $count1);
\& $cloud\->add($tag2, $url2, $count2);
\& $cloud\->add($tag3, $url3, $count3);
.Ve
.SS "add_static"
.IX Subsection "add_static"
This module adds a tag that does not link to another web page into the
cloud. You pass in the tag name and its count:
.PP
.Vb 2
\& $cloud\->add_static($tag1, $count1);
\& $cloud\->add_static($tag2, $count2);
.Ve
.SS "tags($limit)"
.IX Subsection "tags($limit)"
Returns a list of hashrefs representing each tag in the cloud, sorted by
alphabet. Each tag has the following keys: name, count, url and level.
.SS "css"
.IX Subsection "css"
This returns the \s-1CSS\s0 that will format the \s-1HTML\s0 returned by the \fBhtml()\fR
method with tags which have a high count as larger:
.PP
.Vb 1
\& my $css = $cloud\->css;
.Ve
.SS "html($limit)"
.IX Subsection "html($limit)"
This returns the tag cloud as \s-1HTML\s0 without the embedded \s-1CSS\s0 (you should
use both \fBcss()\fR and \fBhtml()\fR or simply the \fBhtml_and_css()\fR method). If any
categories were specified when items were being placed in the cloud then
the tags will be organized into divisions by category name. If a limit
is provided, only the top \f(CW$limit\fR tags are in the cloud, otherwise all the
tags are in the cloud:
.PP
.Vb 1
\& my $html = $cloud\->html(200);
.Ve
.SS "html_with_categories($limit)"
.IX Subsection "html_with_categories($limit)"
This returns the tag cloud as \s-1HTML\s0 without the embedded \s-1CSS.\s0 The tags will
be arranged into divisions by category. If a limit is provided, only the top
\&\f(CW$limit\fR tags are in the cloud. Otherwise, all tags are in the cloud.
.SS "html_without_categories($limit)"
.IX Subsection "html_without_categories($limit)"
This returns the tag cloud as \s-1HTML\s0 without the embedded \s-1CSS.\s0 The tags will
not be grouped by category if this method is used to generate the \s-1HTML.\s0
.SS "html_and_css($limit)"
.IX Subsection "html_and_css($limit)"
This returns the tag cloud as \s-1HTML\s0 with embedded \s-1CSS.\s0 If a limit is
provided, only the top \f(CW$limit\fR tags are in the cloud, otherwise all the
tags are in the cloud:
.PP
.Vb 1
\& my $html_and_css = $cloud\->html_and_css(50);
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Leon Brocard, \f(CW\*(C`\*(C'\fR.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2005\-6, Leon Brocard
.PP
This module is free software; you can redistribute it or modify it
under the same terms as Perl itself.