MPXDOC-144 : Add a property to override navigation.xml

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@279918 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
ltheussl 2005-09-09 23:48:39 +00:00
parent 348eb32720
commit a30cfc340e
4 changed files with 20 additions and 9 deletions

View File

@ -370,7 +370,7 @@
<patternset> <patternset>
<exclude name="**/project.xml"/> <exclude name="**/project.xml"/>
<exclude name="**/template.xml"/> <exclude name="**/template.xml"/>
<exclude name="**/navigation.xml"/> <exclude name="**/${maven.xdoc.navigation.file}"/>
<exclude name="changes.xml"/> <exclude name="changes.xml"/>
<exclude name="**/*.properties"/> <exclude name="**/*.properties"/>
<j:if test="${maven_xdoc_xml_copy_pattern!=null and !maven_xdoc_xml_copy_pattern.equals('')}"> <j:if test="${maven_xdoc_xml_copy_pattern!=null and !maven_xdoc_xml_copy_pattern.equals('')}">
@ -409,12 +409,12 @@
<util:file var="siteNavFile" name="${maven.docs.src}/project.xml"/> <util:file var="siteNavFile" name="${maven.docs.src}/project.xml"/>
</util:available> </util:available>
<!-- supplied navigation file in root of xdocs source tree --> <!-- supplied navigation file in root of xdocs source tree -->
<util:available file="${maven.docs.src}/navigation.xml"> <util:available file="${maven.docs.src}/${maven.xdoc.navigation.file}">
<util:file var="siteNavFile" name="${maven.docs.src}/navigation.xml"/> <util:file var="siteNavFile" name="${maven.docs.src}/${maven.xdoc.navigation.file}"/>
</util:available> </util:available>
<!-- navigation file that was generated --> <!-- navigation file that was generated -->
<util:available file="${maven.gen.docs}/navigation.xml"> <util:available file="${maven.gen.docs}/${maven.xdoc.navigation.file}">
<util:file var="siteNavFile" name="${maven.gen.docs}/navigation.xml"/> <util:file var="siteNavFile" name="${maven.gen.docs}/${maven.xdoc.navigation.file}"/>
</util:available> </util:available>
<!-- hold onto maven.docs.src for later --> <!-- hold onto maven.docs.src for later -->
<util:file var="docsSrcFile" name="${maven.docs.src}"/> <util:file var="docsSrcFile" name="${maven.docs.src}"/>
@ -459,10 +459,10 @@
<!-- in the same directory as xml file being processed --> <!-- in the same directory as xml file being processed -->
<!-- if no such nav file available use sitewide nav file --> <!-- if no such nav file available use sitewide nav file -->
<j:set var="navFile" value="${siteNavFile}" /> <j:set var="navFile" value="${siteNavFile}" />
<util:available file="${file.parentFile.absoluteFile}/navigation.xml"> <util:available file="${file.parentFile.absoluteFile}/${maven.xdoc.navigation.file}">
<!-- dont use current directory navigation.xml if it's in maven.docs.src --> <!-- dont use current directory ${maven.xdoc.navigation.file} if it's in maven.docs.src -->
<j:if test="${!(file.parentFile.equals(docsSrcFile))}"> <j:if test="${!(file.parentFile.equals(docsSrcFile))}">
<util:file var="navFile" name="${file.parentFile.absoluteFile}/navigation.xml"/> <util:file var="navFile" name="${file.parentFile.absoluteFile}/${maven.xdoc.navigation.file}"/>
</j:if> </j:if>
</util:available> </util:available>
@ -732,7 +732,7 @@
<fileScanner var="navFiles"> <fileScanner var="navFiles">
<fileset dir="${maven.docs.src}"> <fileset dir="${maven.docs.src}">
<patternset> <patternset>
<include name="**/navigation.xml"/> <include name="**/${maven.xdoc.navigation.file}"/>
</patternset> </patternset>
</fileset> </fileset>
</fileScanner> </fileScanner>

View File

@ -20,6 +20,8 @@
# Xdoc plugin. # Xdoc plugin.
# ------------------------------------------------------------------- # -------------------------------------------------------------------
maven.xdoc.navigation.file=navigation.xml
maven.xdoc.developmentProcessUrl=http://maven.apache.org/development-process.html maven.xdoc.developmentProcessUrl=http://maven.apache.org/development-process.html
maven.xdoc.includeProjectDocumentation = yes maven.xdoc.includeProjectDocumentation = yes

View File

@ -27,6 +27,7 @@
</properties> </properties>
<body> <body>
<release version="1.10" date="in SVN"> <release version="1.10" date="in SVN">
<action dev="ltheussl" type="add" issue="MPXDOC-144">Add a property to override <code>navigation.xml</code>.</action>
<action dev="ltheussl" type="add" issue="MPXDOC-127" due-to="Shinobu Kawai Yoshida">Show organization in header even if logo not set.</action> <action dev="ltheussl" type="add" issue="MPXDOC-127" due-to="Shinobu Kawai Yoshida">Show organization in header even if logo not set.</action>
<action dev="ltheussl" type="fix" issue="MPXDOC-47">Ampersands in navigation.xml being escaped twice.</action> <action dev="ltheussl" type="fix" issue="MPXDOC-47">Ampersands in navigation.xml being escaped twice.</action>
<action dev="ltheussl" type="fix" issue="MPXDOC-133">Ampersand in section/subsection not correct.</action> <action dev="ltheussl" type="fix" issue="MPXDOC-133">Ampersand in section/subsection not correct.</action>

View File

@ -202,6 +202,14 @@
<th>Optional?</th> <th>Optional?</th>
<th>Description</th> <th>Description</th>
</tr> </tr>
<tr>
<td>maven.xdoc.navigation.file</td>
<td>Yes</td>
<td>
The name of the navigation file to use.
The default is <code>navigation.xml</code>.
</td>
</tr>
<tr> <tr>
<td>maven.xdoc.theme</td> <td>maven.xdoc.theme</td>
<td>Yes</td> <td>Yes</td>