Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

New attribute fileSuffix for the tag doc:registerReport allow to use another extension than '.html' for a report link.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@379963 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
aheritier 2006-02-22 23:07:07 +00:00
parent a6316863ad
commit b673ebcf4d
5 changed files with 30 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
xdoc/plugin.jelly
View File

@ -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, ...)
-->
<maven:get var="reports" plugin="maven-xdoc-plugin" property="reports" />
@ -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)}

8
xdoc/src/plugin-resources/navigation.jelly
View File

@ -76,13 +76,17 @@
<j:set var="link" value="${report.link}" />
<j:set var="externalLink" value="${report.externalLink}" />
<j:if test="${!empty(link)}">
<j:set var="fileSuffix" value="${report.fileSuffix}" />
<j:if test="${fileSuffix == null}">
<j:set var="fileSuffix" value=".html" />
</j:if>
<item name="${report.name}"
href="/${report.link}.html"
href="/${link}${fileSuffix}"
target="${report.target}" />
</j:if>
<j:if test="${empty(link) and !empty(externalLink)}">
<item name="${report.name}"
href="${report.externalLink}"
href="${externalLink}"
target="${report.target}" />
</j:if>
</j:forEach>

9
xdoc/src/plugin-resources/templates/maven-reports.xml
View File

@ -59,16 +59,21 @@
#foreach ($report in $reports)
#if ($report.link && $report.link.length() != 0)
<tr>
#if($report.fileSuffix && $report.linfileSuffixk.length() != 0)
#set ($fileSuffix = $report.fileSuffix)
#else
#set ($fileSuffix = '.html')
#end
#if($report.target && $report.target.length() != 0)
<td>
<a href="${report.link}.html"
<a href="${report.link}${fileSuffix}"
target="${report.target}">
$report.name
</a>
</td>
#else
<td>
<a href="${report.link}.html">
<a href="${report.link}${fileSuffix}">
$report.name
</a>
</td>

1
xdoc/xdocs/changes.xml
View File

@ -27,6 +27,7 @@
</properties>
<body>
<release version="1.10-SNAPSHOT" date="in SVN">
<action dev="aheritier" type="add">New attribute fileSuffix for the tag doc:registerReport allow to use another extension than '.html' for a report link.</action>
<action dev="ltheussl" type="add">Include instructions for ClearCase, Starteam and Perforce access in the scm-usage page.</action>
<action dev="ltheussl" type="add" issue="MPXDOC-191">Include dependencies' scope in dependencies page.</action>
<action dev="ltheussl" type="add" issue="MPXDOC-190">Include the new theme <code>maven-stylus.css</code>.</action>

16
xdoc/xdocs/tags.xml
View File

@ -44,7 +44,7 @@
<tr>
<td>name</td>
<td>No</td>
<td>The name of the report to register.</td>
<td>The name of the report to register. Used for navigation items.</td>
</tr>
<tr>
<td>pluginName</td>
@ -58,8 +58,18 @@
</tr>
<tr>
<td>link</td>
<td>No</td>
<td>The nav-bar link for this report.</td>
<td>Either the link or the externalLink attributes must be defined.</td>
<td>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).</td>
</tr>
<tr>
<td>fileSuffix</td>
<td>Yes</td>
<td>the file suffix to add to the link. '.html' by default. Used only if the link attribute is defined.</td>
</tr>
<tr>
<td>externalLink</td>
<td>Either the link or the externalLink attributes must be defined.</td>
<td>The nav-bar link for this report. This is a full url link (http://somewhere...).</td>
</tr>
<tr>
<td>target</td>