diff --git a/multiproject/xdocs/changes.xml b/multiproject/xdocs/changes.xml index d1b079f5..b8e2ded3 100644 --- a/multiproject/xdocs/changes.xml +++ b/multiproject/xdocs/changes.xml @@ -7,6 +7,9 @@ + + Updated multiproject:site to automate navigation generation for all projects + Added multiproject 'install', 'install-snapshot', 'deploy' and 'deploy-snapshot' facility diff --git a/multiproject/xdocs/goals.xml b/multiproject/xdocs/goals.xml index 969298fe..b93c644d 100644 --- a/multiproject/xdocs/goals.xml +++ b/multiproject/xdocs/goals.xml @@ -8,10 +8,48 @@ + multiproject - Run the site goal of all projects + Executes multiproject:site + + + multiproject:artifact + + Run 'artifact':'artifact' goal for all projects. + + + multiproject:deploy + + Run 'artifact':install-snapshot goal for all projects. + + + + + multiproject:deploy-snapshot + + Run 'artifact':install-snapshot goal for all projects. + + + + + multiproject:goal + + Run the comma separated list of goals provided by the variable goal for all projects + e.g. + + maven -Dgoal=java:compile multiproject:goal + + or + + maven -Dgoal=clean,java:compile,test multiproject:goal + + + + multiproject:install @@ -37,45 +75,28 @@ + multiproject:install-snapshot Run 'artifact':install-snapshot goal for all projects. + - multiproject:deploy + multiproject:site - Run 'artifact':install-snapshot goal for all projects. - - - - multiproject:deploy-snapshot - - Run 'artifact':install-snapshot goal for all projects. - - - - multiproject:artifact - - Run 'artifact':'artifact' goal for all projects. - - - multiproject:goal - - Run the comma separated list of goals provided by the variable goal for all projects - e.g. - - maven -Dgoal=java:compile multiproject:goal - - or - - maven -Dgoal=clean,java:compile,test multiproject:goal - +

+ Run the site goal of all projects, generating navigation for projects processed according to the + maven.multiproject.navigation property. +

+

+ If a navigation.xml is found in ${basedir}/multiproject/navigation.xml, it will + take precedence over the multiproject navigation. +

+
\ No newline at end of file diff --git a/multiproject/xdocs/properties.xml b/multiproject/xdocs/properties.xml index 97510b8c..763c2227 100644 --- a/multiproject/xdocs/properties.xml +++ b/multiproject/xdocs/properties.xml @@ -66,6 +66,33 @@ + + maven.multiproject.navigation + Yes + +

+ This property tells the plugin how to generate navigation for the set of sites being managed. +

+

+ If the property is set to independent a navigation menu is generated with each + project's name linking to the project's URL, as specified in that project's descriptor, project.xml. +

+

+ If the property is set to aggregate a navigation menu is generated with each + project's name linking to /multiproject/${project.name}/index.html. At the completion of + the multiproject:site goal, each project's generated site is copied into + the appropriate directory. e.g. if WebProject1 and JarProject2 are the names of projects + processed via multiproject:site, the project that is executing + multiproject:site will have the generated sites from + WebProject1/target/docs and JarProject2/target/docs copied into + target/docs/multiproject/WebProject1 and + target/docs/multiproject/JarProject2 respectively. +

+

+ Default value is aggregate. +

+ + maven.multiproject.type No