Author: ltheussl
Date: Thu May 4 13:01:02 2006
New Revision: 399845
URL: http://svn.apache.org/viewcvs?rev=399845&view=rev
Log:
PR: MPXDOC-17
Revert last commit as it was breaking lots of other stuff.
Implemented and documented workaround solution using <entity> tags.
Modified:
maven/maven-1/plugins/trunk/xdoc/src/plugin-resources/site.jsl
maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test01/xdocs-replacement/test.xml
maven/maven-1/plugins/trunk/xdoc/xdocs/reference/xdocs.xml
Modified: maven/maven-1/plugins/trunk/xdoc/src/plugin-resources/site.jsl
URL:
http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/src/plugin-resources/site.jsl?rev=399845&r1=399844&r2=399845&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/src/plugin-resources/site.jsl (original)
+++ maven/maven-1/plugins/trunk/xdoc/src/plugin-resources/site.jsl Thu May 4
13:01:02 2006
@@ -976,10 +976,11 @@
<jsl:template match="text()"><x:expr select="."/></jsl:template>
<!-- copy any other elements through -->
- <!-- This does not work with entities, see
http://jira.codehaus.org/browse/MPXDOC-17 -->
- <!--<jsl:template match="*" trim="false"><jsl:copy
trim="false"><jsl:applyTemplates trim="false"/></jsl:copy></jsl:template>-->
- <jsl:template match="*" trim="false"><jsl:copyOf select="."/></jsl:template>
-
+ <jsl:template match="*" trim="false"><jsl:copy
trim="false"><jsl:applyTemplates trim="false"/></jsl:copy></jsl:template>
+
+ <jsl:template match="entity" trim="false"><jsl:copyOf
select="."/></jsl:template>
+
+
<!-- process a message -->
<!-- Key is more important than message... -->
<jsl:template match="message" trim="true">
Modified:
maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test01/xdocs-replacement/test.xml
URL:
http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test01/xdocs-replacement/test.xml?rev=399845&r1=399844&r2=399845&view=diff
==============================================================================
---
maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test01/xdocs-replacement/test.xml
(original)
+++
maven/maven-1/plugins/trunk/xdoc/src/plugin-test/test01/xdocs-replacement/test.xml
Thu May 4 13:01:02 2006
@@ -40,44 +40,44 @@
<tr>
<td>_module</td>
<td><code><module></code></td>
- <td>&_module;</td>
+ <td><entity>&_module;</entity></td>
</tr>
<tr>
<td>module</td>
- <td><a href="descriptor.html#module">module</a></td>
- <td>&module;</td>
+ <td><a
href="descriptor.html#module"><code><module></code></a></td>
+ <td><entity>&module;</entity></td>
</tr>
<tr>
<td>apache.a</td>
<td>Apache</td>
- <td>&apache.a;</td>
+ <td><entity>&apache.a;</entity></td>
</tr>
<tr>
<td>apache.b</td>
<td><Apache></td>
- <td>&apache.b;</td>
+ <td><entity>&apache.b;</entity></td>
</tr>
<tr>
<td>apache.c</td>
<td>[Apache]</td>
- <td>&apache.c;</td>
+ <td><entity>&apache.c;</entity></td>
</tr>
<tr>
<td>apache.d</td>
<td>
- <a
href="http://www.apache.org/">&apache.b;</a>
+ <a
href="http://www.apache.org/"><Apache></a>
</td>
- <td>&apache.d;</td>
+ <td><entity>&apache.d;</entity></td>
</tr>
<tr>
<td>apache.e</td>
- <td><a href="http://www.apache.org/";>&apache.b;</a></td>
- <td>&apache.e;</td>
+ <td><a href="http://www.apache.org/";><Apache></a></td>
+ <td><entity>&apache.e;</entity></td>
</tr>
<tr>
<td>apache.f</td>
- <td><em>&apache.a;</em></td>
- <td>&apache.f;</td>
+ <td><em>Apache</em></td>
+ <td><entity>&apache.f;</entity></td>
</tr>
</table>
Modified: maven/maven-1/plugins/trunk/xdoc/xdocs/reference/xdocs.xml
URL:
http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/xdocs/reference/xdocs.xml?rev=399845&r1=399844&r2=399845&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/xdocs/reference/xdocs.xml (original)
+++ maven/maven-1/plugins/trunk/xdoc/xdocs/reference/xdocs.xml Thu May 4
13:01:02 2006
@@ -134,6 +134,37 @@
</p>
</subsection>
+ <subsection name="Custom entities">
+ <p>
+ Due to a bug in Jelly, it is not possible to use custom entities
directly in xdoc documents.
+ A workaround has been implemented such that you need to embed your
entities
+ in <code><entity></code> tags. First you should declare the
resource file
+ for your entities:
+ </p>
+ <source><![CDATA[<?xml version="1.0"?>
+<!DOCTYPE document [
+ <!ENTITY % my-entities SYSTEM "entities.ent">
+ %my-entities;
+]>
+<document>
+...]]></source>
+ <p>
+ where the file <code>entities.ent</code> contains, eg:
+ </p>
+ <source><![CDATA[<!ENTITY version '1.3.2-SNAPSHOT'>]]></source>
+ <p>
+ which can then be used in your xdoc like:
+ </p>
+ <source><![CDATA[<p>
+ This information only applies to version <entity>&version;</entity>.
+</p>]]></source>
+ <p>
+ <strong>Note</strong> that xdoc files using entities in this way
+ cannot be validated with the <code>xdoc:validate</code> goal
+ (see below).
+ </p>
+ </subsection>
+
</section>
<section name="Validation">
