uctool:use-cases

Full name:

net.sf.uctool:uctool-maven-plugin:3.0.0:use-cases

Description:

Generate use case documentation.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Binds by default to the lifecycle phase: generate-resources.

Required Parameters

Name Type Since Description
attachmentsDirectory File - The directory holding sub-directories with the attachment files.
Default value is: ${project.basedir}/src/main/attachments/.
mergedFile File - Location of file to hold merged XML use case source files.
Default value is: ${project.build.outputDirectory}/net/sf/uctool/merged.xml.
outputDirectory File - The output directory. The HTML use case documentation is generated there.
Default value is: ${project.build.directory}/site/ucs/.
useCasesDirectory File - The directory holding the use case XML source files.
Default value is: ${project.basedir}/src/main/ucs/.
useCasesInclude String - Which files from the use cases directory tree should be included in the generation.

Specifies a file-set of source files in the comma- or space-separated list of patterns of files.


Default value is: **/*.xml.

Optional Parameters

Name Type Since Description
bundleLanguage String - Set language to load the resource bundle with fixed texts translations. When not specified, the default locale language is used.
sourceEncoding String - Read the source files (XSL templates and XML transformation sources) using this encoding.
Default value is: ${project.build.sourceEncoding}.
useCasesDescription String - Set project description to display on the start HTML page.
Default value is: ${project.description}.
useCasesName String - Set name to display on the start HTML page.
Default value is: ${project.name}.
useCasesVersion String - Set version to display on the start HTML page.
Default value is: ${project.version}.

Parameter Details

attachmentsDirectory:

The directory holding sub-directories with the attachment files.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.basedir}/src/main/attachments/

bundleLanguage:

Set language to load the resource bundle with fixed texts translations. When not specified, the default locale language is used.
  • Type: java.lang.String
  • Required: No

mergedFile:

Location of file to hold merged XML use case source files.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.outputDirectory}/net/sf/uctool/merged.xml

outputDirectory:

The output directory. The HTML use case documentation is generated there.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/site/ucs/

sourceEncoding:

Read the source files (XSL templates and XML transformation sources) using this encoding.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.sourceEncoding}

useCasesDescription:

Set project description to display on the start HTML page.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.description}

useCasesDirectory:

The directory holding the use case XML source files.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.basedir}/src/main/ucs/

useCasesInclude:

Which files from the use cases directory tree should be included in the generation.

Specifies a file-set of source files in the comma- or space-separated list of patterns of files.

  • Type: java.lang.String
  • Required: Yes
  • Default: **/*.xml

useCasesName:

Set name to display on the start HTML page.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.name}

useCasesVersion:

Set version to display on the start HTML page.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.version}