diff --git a/xdoc/plugin.jelly b/xdoc/plugin.jelly index 8e941292..76002cad 100644 --- a/xdoc/plugin.jelly +++ b/xdoc/plugin.jelly @@ -97,7 +97,7 @@ + + + + + + + + + Unknown report format for report [${pomDocument}]. + + + diff --git a/xdoc/plugin.properties b/xdoc/plugin.properties index eeb2f5f7..64d7e708 100644 --- a/xdoc/plugin.properties +++ b/xdoc/plugin.properties @@ -26,12 +26,26 @@ maven.xdoc.includeProjectDocumentation = yes maven.xdoc.crumb.separator=| maven.xdoc.theme.url= +# Location where the artifacts are distributed. This property is optional. +# If it is not defined, then the Download report will not be added to the +# navigation menu. +# NOTE: In the future this information will be described in the POM +# Ex: maven.xdoc.distributionUrl=http://www.ibiblio.org/maven/maven/plugins + +# Type of the distributed artifact. Defaults to jar. Override this property if +# your project is distributing artifacts of a different type. +# NOTE: In the future this information will be described in the POM +maven.xdoc.distributionType=jar + # # DATE Preferences # + # The place of the date on the pages : choices are 'bottom', 'left', 'right', 'navigation-top', 'navigation-bottom' maven.xdoc.date = + maven.xdoc.date.format = dd MMMM yyyy + # The date locale maven.xdoc.date.locale = en @@ -97,12 +111,13 @@ maven.xdoc.pomDocuments = cvs-usage.xml,\ issue-tracking.xml,\ mail-lists.xml,\ project-info.xml,\ - team-list.xml + team-list.xml,\ + downloads.jelly maven.xdoc.projectInfo = cvs-usage.xml,\ - dependencies.xml,\ - issue-tracking.xml,\ - mail-lists.xml,\ - project-info.xml,\ - team-list.xml - + dependencies.xml,\ + issue-tracking.xml,\ + mail-lists.xml,\ + project-info.xml,\ + team-list.xml,\ + downloads.jelly diff --git a/xdoc/src/plugin-resources/navigation.jelly b/xdoc/src/plugin-resources/navigation.jelly index a44b332a..f2471998 100644 --- a/xdoc/src/plugin-resources/navigation.jelly +++ b/xdoc/src/plugin-resources/navigation.jelly @@ -28,7 +28,13 @@ - + + + + + + diff --git a/xdoc/src/plugin-resources/templates/downloads.jelly b/xdoc/src/plugin-resources/templates/downloads.jelly new file mode 100644 index 00000000..53c02fc8 --- /dev/null +++ b/xdoc/src/plugin-resources/templates/downloads.jelly @@ -0,0 +1,89 @@ + + + + + + + + + + Downloads + + + +
+ + + + + +

+ You must define the maven.xdoc.distributionUrl + property if you wish to generate the download report. +

+
+ + + + + +

+ This project has not released any version yet. +

+
+ + +

+ List of available downloads. +

+ + + + + + + + + + + + +
Download links
+ ${pom.name} v${version} +
+
+
+ +
+
+ +
+ + +
+
diff --git a/xdoc/src/plugin-resources/templates/downloads.xml b/xdoc/src/plugin-resources/templates/downloads.xml deleted file mode 100644 index 809a4591..00000000 --- a/xdoc/src/plugin-resources/templates/downloads.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - - - Downloads - - - -
-

- #set ($url = $escape.getText($project.distributionUrl)) - $url -

-
- -
- diff --git a/xdoc/xdocs/changes.xml b/xdoc/xdocs/changes.xml index 996aaa72..8d3f6105 100644 --- a/xdoc/xdocs/changes.xml +++ b/xdoc/xdocs/changes.xml @@ -22,9 +22,22 @@ Changes dIon Gillard + Vincent Massol + + Added new download report along with a new link in the Maven + generated documentation. This new link will only appear if you have + defined the new maven.xdoc.distributionUrl property. + There is also a new maven.xdoc.distributionType property + that indicates what type of artifact your project is delivering. It + defaults to "jar". + + The xdoc plugin now supports generating custom reports using Jelly. + It was previously only supporting Velocity. Simply name your report + templates with a ".jelly" extension. + Allow reports to be generated even if they aren't linked from the "project reports" section by giving an empty link attribute to the register report tag. Only show "CVS Access Behind a Firewall" section if using CVS. wrong lists generated for not expandable menu items. Some changes in patch were already put in place by brett. diff --git a/xdoc/xdocs/properties.xml b/xdoc/xdocs/properties.xml index 9796b151..3116ee14 100644 --- a/xdoc/xdocs/properties.xml +++ b/xdoc/xdocs/properties.xml @@ -22,6 +22,7 @@ Xdoc Properties Stéphane MOR + Vincent Massol @@ -498,6 +499,28 @@ file: URL. + + maven.xdoc.distributionUrl + Yes + + Location where the artifacts are distributed. This property is + optional. If it is not defined, then the Download report will + not be added to the navigation menu. NOTE: In the future this + information will be described in the POM. Usage example: + maven.xdoc.distributionUrl=http://www.ibiblio.org/maven/maven/plugins. + + + + maven.xdoc.distributionType + Yes + + Type of the distributed artifact. Override this property if + your project is distributing artifacts of a type different + that the default. NOTE: In the future + this information will be described in the POM. + Default value: maven.xdoc.distributionType=jar + +