diff --git a/xdoc/plugin.jelly b/xdoc/plugin.jelly index fe101d7e..0a61063c 100644 --- a/xdoc/plugin.jelly +++ b/xdoc/plugin.jelly @@ -58,6 +58,8 @@ @pluginName the name of the plugin. @plugin:report goal must exist @description text description of report @link the nav-bar link for this report + @fileSuffix the file suffix to add to the link ('.html' by default) + @externalLink the nav-bar link for this report @target the target for the new page (_self, _blank, ...) --> @@ -77,6 +79,7 @@ ${report.put('pluginName', pluginName)} ${report.put('description', description)} ${report.put('link', link)} + ${report.put('fileSuffix', fileSuffix)} ${report.put('externalLink', externalLink)} ${report.put('target', target)} ${reports.add(report)} diff --git a/xdoc/src/plugin-resources/navigation.jelly b/xdoc/src/plugin-resources/navigation.jelly index 98001f69..506bab75 100644 --- a/xdoc/src/plugin-resources/navigation.jelly +++ b/xdoc/src/plugin-resources/navigation.jelly @@ -76,13 +76,17 @@ + + + + diff --git a/xdoc/src/plugin-resources/templates/maven-reports.xml b/xdoc/src/plugin-resources/templates/maven-reports.xml index ce9196ff..196bb58a 100644 --- a/xdoc/src/plugin-resources/templates/maven-reports.xml +++ b/xdoc/src/plugin-resources/templates/maven-reports.xml @@ -59,16 +59,21 @@ #foreach ($report in $reports) #if ($report.link && $report.link.length() != 0) + #if($report.fileSuffix && $report.linfileSuffixk.length() != 0) + #set ($fileSuffix = $report.fileSuffix) + #else + #set ($fileSuffix = '.html') + #end #if($report.target && $report.target.length() != 0) - $report.name #else - + $report.name diff --git a/xdoc/xdocs/changes.xml b/xdoc/xdocs/changes.xml index a3703baf..a7ff0d69 100644 --- a/xdoc/xdocs/changes.xml +++ b/xdoc/xdocs/changes.xml @@ -27,6 +27,7 @@ + New attribute fileSuffix for the tag doc:registerReport allow to use another extension than '.html' for a report link. Include instructions for ClearCase, Starteam and Perforce access in the scm-usage page. Include dependencies' scope in dependencies page. Include the new theme maven-stylus.css. diff --git a/xdoc/xdocs/tags.xml b/xdoc/xdocs/tags.xml index e269b1d7..28ef336a 100644 --- a/xdoc/xdocs/tags.xml +++ b/xdoc/xdocs/tags.xml @@ -44,7 +44,7 @@ name No - The name of the report to register. + The name of the report to register. Used for navigation items. pluginName @@ -58,8 +58,18 @@ link - No - The nav-bar link for this report. + Either the link or the externalLink attributes must be defined. + The nav-bar link for this report. This link must be relative to the root directory of the documentation and it musn't contain the file suffix ('.html' for example). + + + fileSuffix + Yes + the file suffix to add to the link. '.html' by default. Used only if the link attribute is defined. + + + externalLink + Either the link or the externalLink attributes must be defined. + The nav-bar link for this report. This is a full url link (http://somewhere...). target