Help Plugin (quokka.plugin.help:0.3, namespace=help)
The help plugin generates and displays help for projects, plugins, dependency sets and XML catalogs.
Main Targets
| help | Generates a detailed HTML help report for the current project, a target, or an extension |
Minor Targets
| 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.
help
Generates a detailed HTML help report for the current project, a target, or an extension
- alias: help
- prefix: q.help.help
Properties:
- launch Optional. If true, automatically launches the browser with the generated help.
- id Optional. If an id is specified (usually via -Did=<id>) then help for given id will be extracted and displayed
- target Optional. If a target is (usually via -Dtarget=<target>) then help for the plugin that introduced the given target will be extracted and displayed.
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 |
collect
Collects the report data
- prefix: q.help.collect
- Implements: quokka.plugin.devreport:generate
Default Properties
| aggregate | true |
| propogate | true |
propogate
Propogates the report data to the parent project for aggregation
- prefix: q.help.propogate
- enabled-by-default: false
- Implements: quokka.plugin.devreport:generate
aggregate-report
Generates an aggregated project help report for all child modules
- prefix: q.help.aggregateReport
- enabled-by-default: false
- Implements: quokka.plugin.devreport:generate
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]} |
report
Generates a detailed report about project paths, targets & properties
- alias: help-report
- depends: collect
- prefix: q.help.report
- Implements: quokka.plugin.devreport:generate
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 |
generate-help
Generates HTML help for the plugin, including it in the plugin's resources
- prefix: q.help.generateHelp
- enabled-by-default: false
- Implements: quokka.plugin.lifecycle:pre-compile
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:
- The title of the help is taken from the first h1 tag in the help file
- The id of the artifact is then added automatically
- The short description is taken from the first paragraph (p) element in the help file
- Any help file content with a div with an id of content-before is then added.
- Help for the artifact is automatically generated - the content varies depending
on the kind of artifact. If the artifact is a plugin, then the following additional
steps are performed.
- Any help file content with a div with an id of after-summary is then added.
- For each target, summary content is generated and then any help content with a div with an id that matches the target name is added.
- After all targets, plugin paths information is added.
- Finally, any help file content with a div with an id of content-after is then added.
Default Properties
| helpFile | ${q.project.sourceDir}/main/docs/help.xhtml |
generate-summary
Generates a summary for plugins, linking to extracted help files
- prefix: q.help.summary
- enabled-by-default: false
Plugin Paths
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