Skip to end of metadata
Go to start of metadata

auto generated page

Icon

this page has been generated by plugin: org.bsc.maven:maven-confluence-reporting-plugin

Index

Description

plugin that document a project (using maven site style) and send result to a live confluence site http://www.atlassian.com/software/confluence/


Plugin Goals

Name

Description

confluence-reporting:delete

Delete a confluence pageTitle

confluence-reporting:export

Export a confluence page either in PDF or DOC

confluence-reporting:deploy

Generate Project's documentation in confluence's wiki format and deploy it

confluence-reporting:help

Display help information on confluence-reporting-maven-plugin.<br/>
Call <code>mvn confluence-reporting:help -Ddetail=true -Dgoal=<goal-name></code> to display parameter details.


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 POM

plugin repository

Usage

Below examples of plugin declarations

Basic Declaration

Add labels

Inject custom properties within template

Change wiki files extension

Authentication

Icon

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 variables

Built-In template variables

variable

description

example

${project.summary}

project summary

 

${project.scmManager}

scm information

 

${project.dependencies}

dependencies

 

${pageTitle}

title of page

confluence-reporting-maven-plugin-4.0.0-SNAPSHOT

${artifactId}

artifactId

confluence-reporting-maven-plugin

${version}

version

4.0.0-SNAPSHOT

Tips & Tricks

Icon
  • How to refer to an image

    !${pageTitle}^image_name!.

  • How to refer to an attachment

    [${pageTitle}^attachment_name].

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}

${project.summary}


${project.scmManager}


${project.dependencies}
  
  • No labels