You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ah...@apache.org on 2006/02/23 00:07:11 UTC
svn commit: r379963 - in /maven/maven-1/plugins/trunk/xdoc: plugin.jelly
src/plugin-resources/navigation.jelly
src/plugin-resources/templates/maven-reports.xml xdocs/changes.xml
xdocs/tags.xml
Author: aheritier
Date: Wed Feb 22 15:07:07 2006
New Revision: 379963
URL: http://svn.apache.org/viewcvs?rev=379963&view=rev
Log:
New attribute fileSuffix for the tag doc:registerReport allow to use another extension than '.html' for a report link.
Modified:
maven/maven-1/plugins/trunk/xdoc/plugin.jelly
maven/maven-1/plugins/trunk/xdoc/src/plugin-resources/navigation.jelly
maven/maven-1/plugins/trunk/xdoc/src/plugin-resources/templates/maven-reports.xml
maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml
maven/maven-1/plugins/trunk/xdoc/xdocs/tags.xml
Modified: maven/maven-1/plugins/trunk/xdoc/plugin.jelly
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/plugin.jelly?rev=379963&r1=379962&r2=379963&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/plugin.jelly (original)
+++ maven/maven-1/plugins/trunk/xdoc/plugin.jelly Wed Feb 22 15:07:07 2006
@@ -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)}
Modified: maven/maven-1/plugins/trunk/xdoc/src/plugin-resources/navigation.jelly
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/src/plugin-resources/navigation.jelly?rev=379963&r1=379962&r2=379963&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/src/plugin-resources/navigation.jelly (original)
+++ maven/maven-1/plugins/trunk/xdoc/src/plugin-resources/navigation.jelly Wed Feb 22 15:07:07 2006
@@ -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>
Modified: maven/maven-1/plugins/trunk/xdoc/src/plugin-resources/templates/maven-reports.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/src/plugin-resources/templates/maven-reports.xml?rev=379963&r1=379962&r2=379963&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/src/plugin-resources/templates/maven-reports.xml (original)
+++ maven/maven-1/plugins/trunk/xdoc/src/plugin-resources/templates/maven-reports.xml Wed Feb 22 15:07:07 2006
@@ -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>
Modified: maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml?rev=379963&r1=379962&r2=379963&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml (original)
+++ maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml Wed Feb 22 15:07:07 2006
@@ -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>
Modified: maven/maven-1/plugins/trunk/xdoc/xdocs/tags.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/xdocs/tags.xml?rev=379963&r1=379962&r2=379963&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/xdocs/tags.xml (original)
+++ maven/maven-1/plugins/trunk/xdoc/xdocs/tags.xml Wed Feb 22 15:07:07 2006
@@ -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>