dossier:document

Full name:

org.charvolant:dossier-maven-plugin:0.1.0:document

Description:

Goal which generates documentation for a collection of ontologies.

Both HTML documentation, SVG diagrams and style sheets are generated into a directory.

Attributes:

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

Required Parameters

Name Type Since Description
ontologies FileSet - Location of the ontologies.
User property is: ontologies.

Optional Parameters

Name Type Since Description
outputDirectory File - The directory into which generated files are placed.
Default value is: ${project.build.directory}/site/dossier.
User property is: outputDirectory.
preferencesFile File - Location of the display preferences to use.

If not set then the preferences defaults to the internal standard


User property is: preferences.

Parameter Details

ontologies:

Location of the ontologies.
  • Type: org.apache.maven.shared.model.fileset.FileSet
  • Required: Yes
  • User Property: ontologies

outputDirectory:

The directory into which generated files are placed.
  • Type: java.io.File
  • Required: No
  • User Property: outputDirectory
  • Default: ${project.build.directory}/site/dossier

preferencesFile:

Location of the display preferences to use.

If not set then the preferences defaults to the internal standard

  • Type: java.io.File
  • Required: No
  • User Property: preferences