tagcloud:tagcloud-property

Full name:

de.smartics.tagcloud:tagcloud-maven-plugin:0.1.3:tagcloud-property

Description:

Provides a tag cloud snippet as a property to be included in a page of a Maven site. Since the fragment is XHTML it may be included in other HTML pages as well.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Binds by default to the lifecycle phase: pre-site.

Optional Parameters

Name Type Since Description
basedir String 1.0 The base directory to scan files.
encoding String 1.0 Specifies the encoding to be used to read the source files.
excludes String[] 1.0 The filter for files to exclude to be passed to the tag collection..
includes String[] 1.0 The filter for files to include to be passed to the tag collection.
logLevel String 1.0 Specifies the log level used for this plugin.

Allowed values are SEVERE, WARNING, INFO and FINEST.
maxTagsToDisplay int - The maximum number of tags to display.
Default value is: 0.
maxWeight double - The maximum weight for the font.
Default value is: 36.0.
minWeight double - The minimum weight for the font.
Default value is: 0.0.
propertyName String 1.0 The name of the property used to store the generated XHTML fragment.
Default value is: tagcloud.
skip boolean 1.0 A simple flag to skip the generation of the XML file. If set on the command line use -Dtagcloud.skip.
Default value is: false.
useJavaReservedWordsFilter boolean 1.0 The filter removes Java reserved words from the tag cloud.
Default value is: true.
useUsualWordsFilter boolean 1.0 The filter removes usual Java words from the tag cloud.
Default value is: false.
wordsToFilter String[] 1.0 The list of words to be removed from the tag cloud. This allows an individual configuration.

Parameter Details

basedir:

The base directory to scan files.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${project.build.sourceDirectory}

encoding:

Specifies the encoding to be used to read the source files.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${project.build.sourceEncoding}

excludes:

The filter for files to exclude to be passed to the tag collection..
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No

includes:

The filter for files to include to be passed to the tag collection.
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No

logLevel:

Specifies the log level used for this plugin.

Allowed values are SEVERE, WARNING, INFO and FINEST.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${tagcloud.logLevel}

maxTagsToDisplay:

The maximum number of tags to display.
  • Type: int
  • Required: No
  • Default: 0

maxWeight:

The maximum weight for the font.
  • Type: double
  • Required: No
  • Default: 36.0

minWeight:

The minimum weight for the font.
  • Type: double
  • Required: No
  • Default: 0.0

propertyName:

The name of the property used to store the generated XHTML fragment.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: tagcloud

skip:

A simple flag to skip the generation of the XML file. If set on the command line use -Dtagcloud.skip.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${tagcloud.skip}
  • Default: false

useJavaReservedWordsFilter:

The filter removes Java reserved words from the tag cloud.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: true

useUsualWordsFilter:

The filter removes usual Java words from the tag cloud.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

wordsToFilter:

The list of words to be removed from the tag cloud. This allows an individual configuration.
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No