The help plugin generates and displays help for projects, plugins, dependency sets and XML catalogs.
| help | Generates a detailed HTML help report for the current project, a target, or an extension |
| collect | Collects the report data. Implements quokka.plugin.devreport:generate |
| propogate | Propogates the report data to the parent project for aggregation. Implements quokka.plugin.devreport:generate |
| aggregate-report | Generates an aggregated project help report for all child modules. Implements quokka.plugin.devreport:generate |
| report | Generates a detailed report about project paths, targets & properties. Implements quokka.plugin.devreport:generate |
| generate-help | Generates HTML help for the plugin, including it in the plugin's resources. Implements quokka.plugin.lifecycle:pre-compile |
| generate-summary | Generates a summary for plugins, linking to extracted help files |
Users of quokka will only be concerned with help and report related targets. Developers can use the generate-help and generate-summary targets to automatically generate the bulk of plugin documentation.
Generates a detailed HTML help report for the current project, a target, or an extension
Properties:
Default Properties
| id | ${@setifdef id} |
| resources.set.dir | ${q.project.resources[quokka/help]} |
| resources.set.includes | **/*.css, **/*.js |
| target | ${@setifdef target} |
| tempDir | ${q.project.targetDir}/help |
Collects the report data
Default Properties
| aggregate | true |
| propogate | true |
Propogates the report data to the parent project for aggregation
Generates an aggregated project help report for all child modules
If you are doing a multi-project build, you can produce aggregate project reports. For this to work, make sure all of the sub projects enable the collect target.
Default Properties
| aggResources.set.dir | ${q.project.resources[quokka/help]} |
| aggResources.set.includes | **/*.css |
| description | Detailed project dependency and target report (aggregate) |
| destDir | ${q.devreport.reportsRootDir}/help-aggregate |
| indexFile | ${prefix.destDir}/index.html |
| name | Project Report |
| resources.set.dir | ${q.project.resources[quokka/help]} |
Generates a detailed report about project paths, targets & properties
Default Properties
| description | Detailed project dependency and target report |
| destDir | ${q.devreport.reportsRootDir}/help |
| indexFile | ${prefix.destDir}/index.html |
| name | Project Report |
| resources.set.dir | ${q.project.resources[quokka/help]} |
| resources.set.includes | **/*.css, **/*.js |
Generates HTML help for the plugin, including it in the plugin's resources
If you are developing a plugin, dependency set or XML catalog, this target will merge together help you write with metadata about the artifact you are developing. To generate help, you need to supply and XHTML help file and use specific tags and ids. The following describes how the help is generated:
Default Properties
| helpFile | ${q.project.sourceDir}/main/docs/help.xhtml |
Generates a summary for plugins, linking to extracted help files
runtime : Runtime class path
quokka.core.metadata metadata 0.3
quokka.core.model model 0.3
quokka.plugin.devreport devreport 0.3
quokka.core.plugin-spi plugin-spi 0.3
quokka.core.util util 0.3
apache.ant ant 1.7.1
quokka.core.bootstrap-util bootstrap-util 0.3
quokka.core.plugin-spi plugin-spi 0.3
quokka.core.util util 0.3
quokka.plugin.lifecycle lifecycle 0.3
quokka.core.plugin-spi plugin-spi 0.3
apache.ant ant 1.7.1
quokka.core.bootstrap-util bootstrap-util 0.3
quokka.core.bootstrap-util bootstrap-util 0.3
quokka.core.repo-spi repo-spi 0.3
apache.ant ant 1.7.1
quokka.core.repo-resolver repo-resolver 0.3
quokka.core.version version 0.3