MAVEN CONFLUENCE PLUGIN - DOCUMENTATION
VERSION 3.3.0-beta3
 | auto generated page this page has been generated by plugin: org.bsc.maven:maven-confluence-reporting-plugin |
Index
- Index
- Description
- Plugin Goals
- confluence-reporting:plugin-confluence-summary
- confluence-reporting:confluence-summary
- Mojo Attributes
- Required Parameters
- Optional Parameters
- Parameter Details
- properties
- endPoint
- spaceKey
- parentPageTitle
- username
- password
- templateWiki
- children
- attachmentFolder
- childrenFolder
- removeSnapshots
- labels
- title
- wikiFilesExt
- serverId
- securityDispatcher
- siteDescriptor
- artifactMetadataSource
- collector
- factory
- mavenProjectBuilder
- i18n
- outputDirectory
- checkoutDirectoryName
- anonymousConnection
- developerConnection
- webAccessUrl
Description
plugin that document a project (using maven site style) and send result to a live confluence site http://www.atlassian.com/software/confluence/
Repository
From Release 3.0.1 this plugin is available from MAVEN CENTRAL REPO
If you want stay tune over modification, includes the following repository declaration in your POMplugin repository
Usage
Below examples of plugin declarations
Basic Declaration
Add labels
Inject custom properties within template
Change wiki files extension
 | Authentication Put yours confluence credential within settings.xml as server <server>
<id>my_confluence_server</id>
<username>my_user</username>
<password>my_password</password>
</server>
Take note that also maven ecryption is supported |
Use template variables
By default the plugin use an internal template to generate confluence page. You can customize the generated page creating a personal template into folder ${basedir}/src/site/confluence named template.wiki.
The template can include all valid confluence contents plus the following built-in variablesBuilt-In template variables
variable
description
example
${project.summary}
project summary
${project.scmManager}
scm information
${project.dependencies}
dependencies
${pageTitle}
title of page
maven-confluence-reporting-plugin-3.3.0-beta3
${artifactId}
artifactId
maven-confluence-reporting-plugin
${version}
version
3.3.0-beta3
| Tips & Tricks
|
Template example
{info:title=Useful Information}
This page has been generated by [maven-confluence-plugin|http://code.google.com/p/maven-confluence-plugin/]
{info}
{toc}
h1. Introduction
{panel}
project description
{panel}
h1. Usage
{panel}
How to use the project
{panel}
Plugin Goals
confluence-reporting:plugin-confluence-summary
Generate Plugin's documentation in confluence's wiki format
Mojo Attributes
- Requires a Maven 2.0 project to execute.
- Invokes the execution of the lifecycle phase <code>compile</code> prior to executing itself.
Required Parameters
Name |
Type |
Description |
|---|---|---|
spaceKey |
String |
Confluence target confluence's spaceKey |
outputDirectory |
String |
Report output directory. |
Optional Parameters
Name |
Type |
Description |
|---|---|---|
properties |
Map |
additional properties pass to template processor |
endPoint |
String |
Confluence end point url Default value is http://localhost:8080/rpc/xmlrpc |
parentPageTitle |
String |
Confluence target confluence's spaceKey Default value is Home |
username |
String |
Confluence username |
password |
String |
Confluence password |
templateWiki |
File |
Home page template source. Template name will be used also as template source for children Default value is ${basedir}/src/site/confluence/template.wiki |
children |
List |
Deprecated. child pages - <child><name/><source/></child> |
attachmentFolder |
File |
attachment folder Default value is ${basedir}/src/site/confluence/attachments |
childrenFolder |
File |
children folder Default value is ${basedir}/src/site/confluence/children |
removeSnapshots |
boolean |
During publish of documentation related to a new release, if it's true, the pages related to SNAPSHOT will be removed Default value is false |
labels |
List |
Labels to add |
title |
String |
Confluence Page Title - since 3.1.3 |
wikiFilesExt |
String |
Children files extension - since 3.2.1 Default value is .wiki |
serverId |
String |
Server's <code>id</code> in <code>settings.xml</code> to look up username and password |
securityDispatcher |
SecDispatcher |
Issue 39 MNG-4384 @since 1.5 @component role="hidden.org.sonatype.plexus.components.sec.dispatcher.SecDispatcher" @required |
mojoScanner |
MojoScanner |
Mojo scanner tools. |
encoding |
String |
The file encoding of the source files. Default value is ${project.build.sourceEncoding} |
Parameter Details
properties
additional properties pass to template processor
Type |
java.util.Map |
Required |
No |
endPoint
Confluence end point url
Type |
java.lang.String |
Required |
No |
Expression |
${confluence.endPoint} |
Default |
http://localhost:8080/rpc/xmlrpc |
spaceKey
Confluence target confluence's spaceKey
Type |
java.lang.String |
Required |
Yes |
Expression |
${confluence.spaceKey} |
parentPageTitle
Confluence target confluence's spaceKey
Type |
java.lang.String |
Required |
No |
Expression |
${confluence.parentPage} |
Default |
Home |
username
Confluence username
Type |
java.lang.String |
Required |
No |
Expression |
${confluence.userName} |
password
Confluence password
Type |
java.lang.String |
Required |
No |
Expression |
${confluence.password} |
templateWiki
Home page template source. Template name will be used also as template source for children
Type |
java.io.File |
Required |
No |
Default |
${basedir}/src/site/confluence/template.wiki |
children
child pages - <child><name/><source/></child>
Deprecated |
use children folder instead |
Type |
java.util.List |
Required |
No |
attachmentFolder
attachment folder
Type |
java.io.File |
Required |
No |
Default |
${basedir}/src/site/confluence/attachments |
childrenFolder
children folder
Type |
java.io.File |
Required |
No |
Default |
${basedir}/src/site/confluence/children |
removeSnapshots
During publish of documentation related to a new release, if it's true, the pages related to SNAPSHOT will be removed
Type |
boolean |
Required |
No |
Expression |
${confluence.removeSnapshots} |
Default |
false |
labels
Labels to add
Type |
java.util.List |
Required |
No |
title
Confluence Page Title - since 3.1.3
Type |
java.lang.String |
Required |
No |
Expression |
${project.build.finalName} |
wikiFilesExt
Children files extension - since 3.2.1
Type |
java.lang.String |
Required |
No |
Expression |
${wikiFilesExt} |
Default |
.wiki |
serverId
Server's <code>id</code> in <code>settings.xml</code> to look up username and password
Type |
java.lang.String |
Required |
No |
Expression |
${confluence.serverId} |
securityDispatcher
Issue 39
MNG-4384
@since 1.5
@component role="hidden.org.sonatype.plexus.components.sec.dispatcher.SecDispatcher"
@required
Type |
org.sonatype.plexus.components.sec.dispatcher.SecDispatcher |
Required |
No |
outputDirectory
Report output directory.
Type |
java.lang.String |
Required |
Yes |
Expression |
${project.build.directory}/generated-site/confluence |
mojoScanner
Mojo scanner tools.
Type |
org.apache.maven.tools.plugin.scanner.MojoScanner |
Required |
No |
encoding
The file encoding of the source files.
Type |
java.lang.String |
Required |
No |
Expression |
${encoding} |
Default |
${project.build.sourceEncoding} |
confluence-reporting:confluence-summary
Generate Project's documentation in confluence's wiki format
Mojo Attributes
- Requires a Maven 2.0 project to execute.
- Automatically executes within the lifecycle phase: <code>site</code>
Required Parameters
Name |
Type |
Description |
|---|---|---|
spaceKey |
String |
Confluence target confluence's spaceKey |
checkoutDirectoryName |
String |
The directory name to checkout right after the scm url |
Optional Parameters
Name |
Type |
Description |
|---|---|---|
properties |
Map |
additional properties pass to template processor |
endPoint |
String |
Confluence end point url Default value is http://localhost:8080/rpc/xmlrpc |
parentPageTitle |
String |
Confluence target confluence's spaceKey Default value is Home |
username |
String |
Confluence username |
password |
String |
Confluence password |
templateWiki |
File |
Home page template source. Template name will be used also as template source for children Default value is ${basedir}/src/site/confluence/template.wiki |
children |
List |
Deprecated. child pages - <child><name/><source/></child> |
attachmentFolder |
File |
attachment folder Default value is ${basedir}/src/site/confluence/attachments |
childrenFolder |
File |
children folder Default value is ${basedir}/src/site/confluence/children |
removeSnapshots |
boolean |
During publish of documentation related to a new release, if it's true, the pages related to SNAPSHOT will be removed Default value is false |
labels |
List |
Labels to add |
title |
String |
Confluence Page Title - since 3.1.3 |
wikiFilesExt |
String |
Children files extension - since 3.2.1 Default value is .wiki |
serverId |
String |
Server's <code>id</code> in <code>settings.xml</code> to look up username and password |
securityDispatcher |
SecDispatcher |
Issue 39 MNG-4384 @since 1.5 @component role="hidden.org.sonatype.plexus.components.sec.dispatcher.SecDispatcher" @required |
siteDescriptor |
File |
site xml descriptor Default value is ${basedir}/src/site/confluence/site.xml |
artifactMetadataSource |
ArtifactMetadataSource |
No description. |
collector |
ArtifactCollector |
No description. |
factory |
ArtifactFactory |
No description. |
mavenProjectBuilder |
MavenProjectBuilder |
Maven Project Builder. |
i18n |
I18N |
No description. |
outputDirectory |
File |
No description. |
anonymousConnection |
String |
The scm anonymous connection url. Default value is ${project.scm.connection} |
developerConnection |
String |
The scm developer connection url. Default value is ${project.scm.developerConnection} |
webAccessUrl |
String |
The scm web access url. Default value is ${project.scm.url} |
Parameter Details
properties
additional properties pass to template processor
Type |
java.util.Map |
Required |
No |
endPoint
Confluence end point url
Type |
java.lang.String |
Required |
No |
Expression |
${confluence.endPoint} |
Default |
http://localhost:8080/rpc/xmlrpc |
spaceKey
Confluence target confluence's spaceKey
Type |
java.lang.String |
Required |
Yes |
Expression |
${confluence.spaceKey} |
parentPageTitle
Confluence target confluence's spaceKey
Type |
java.lang.String |
Required |
No |
Expression |
${confluence.parentPage} |
Default |
Home |
username
Confluence username
Type |
java.lang.String |
Required |
No |
Expression |
${confluence.userName} |
password
Confluence password
Type |
java.lang.String |
Required |
No |
Expression |
${confluence.password} |
templateWiki
Home page template source. Template name will be used also as template source for children
Type |
java.io.File |
Required |
No |
Default |
${basedir}/src/site/confluence/template.wiki |
children
child pages - <child><name/><source/></child>
Deprecated |
use children folder instead |
Type |
java.util.List |
Required |
No |
attachmentFolder
attachment folder
Type |
java.io.File |
Required |
No |
Default |
${basedir}/src/site/confluence/attachments |
childrenFolder
children folder
Type |
java.io.File |
Required |
No |
Default |
${basedir}/src/site/confluence/children |
removeSnapshots
During publish of documentation related to a new release, if it's true, the pages related to SNAPSHOT will be removed
Type |
boolean |
Required |
No |
Expression |
${confluence.removeSnapshots} |
Default |
false |
labels
Labels to add
Type |
java.util.List |
Required |
No |
title
Confluence Page Title - since 3.1.3
Type |
java.lang.String |
Required |
No |
Expression |
${project.build.finalName} |
wikiFilesExt
Children files extension - since 3.2.1
Type |
java.lang.String |
Required |
No |
Expression |
${wikiFilesExt} |
Default |
.wiki |
serverId
Server's <code>id</code> in <code>settings.xml</code> to look up username and password
Type |
java.lang.String |
Required |
No |
Expression |
${confluence.serverId} |
securityDispatcher
Issue 39
MNG-4384
@since 1.5
@component role="hidden.org.sonatype.plexus.components.sec.dispatcher.SecDispatcher"
@required
Type |
org.sonatype.plexus.components.sec.dispatcher.SecDispatcher |
Required |
No |
siteDescriptor
site xml descriptor
Type |
java.io.File |
Required |
No |
Default |
${basedir}/src/site/confluence/site.xml |
artifactMetadataSource
No Description.
Type |
org.apache.maven.artifact.metadata.ArtifactMetadataSource |
Required |
No |
collector
No Description.
Type |
org.apache.maven.artifact.resolver.ArtifactCollector |
Required |
No |
factory
No Description.
Type |
org.apache.maven.artifact.factory.ArtifactFactory |
Required |
No |
mavenProjectBuilder
Maven Project Builder.
Type |
org.apache.maven.project.MavenProjectBuilder |
Required |
No |
i18n
No Description.
Type |
org.codehaus.plexus.i18n.I18N |
Required |
No |
outputDirectory
No Description.
Type |
java.io.File |
Required |
No |
Expression |
${project.reporting.outputDirectory} |
checkoutDirectoryName
The directory name to checkout right after the scm url
Type |
java.lang.String |
Required |
Yes |
Expression |
${project.artifactId} |
anonymousConnection
The scm anonymous connection url.
Type |
java.lang.String |
Required |
No |
Default |
${project.scm.connection} |
developerConnection
The scm developer connection url.
Type |
java.lang.String |
Required |
No |
Default |
${project.scm.developerConnection} |
webAccessUrl
The scm web access url.
Type |
java.lang.String |
Required |
No |
Default |
${project.scm.url} |
To help you on your way, we've inserted some of our favourite macros on this home page. As you start creating pages, adding news items and commenting you'll see the macros below fill up with all the activity in your space.