Cocoon is fun! disabled-testcases.xml from both fotree and layoutengine directories integrated into a single page about "known issues".

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@348437 13f79535-47bb-0310-9956-ffa450edef68
author: Jeremias Maerki <jeremias@apache.org> 2005-11-23 13:36:07 +0000
committer: Jeremias Maerki <jeremias@apache.org> 2005-11-23 13:36:07 +0000
commit: 7fdd2fafd7a040752c337b162f47911cd9d84997 (patch)
tree: 2af832cccde39033407467430a673df8e410d5d1
parent: bffc89284806e3f4bf67854005a9a7c30acd206b (diff)
download: xmlgraphics-fop-7fdd2fafd7a040752c337b162f47911cd9d84997.tar.gz
xmlgraphics-fop-7fdd2fafd7a040752c337b162f47911cd9d84997.zip
4 files changed, 152 insertions, 0 deletions
diff --git a/src/documentation/content/xdocs/knownissues.xml b/src/documentation/content/xdocs/knownissues.xml
new file mode 100644
index 000000000..797755621
--- /dev/null
+++ b/src/documentation/content/xdocs/knownissues.xml
@@ -0,0 +1,69 @@
+<?xml version="1.0" standalone="no"?>
+<!--
+  Copyright 2005 The Apache Software Foundation
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!-- $Id$ -->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document xmlns:xi="http://www.w3.org/2001/XInclude">
+  <header>
+    <title>Apache FOP: Known Issues</title>
+    <version>$Revision$</version>
+  </header>
+<body>
+<section>
+  <title>Known issues</title>
+  <p>
+    This page lists currently known issues in the FOP codebase. Please note that this list is generated
+    from data in FOP's code repository (Trunk) and may not exactly represent the list of issues in
+    the latest release.
+  </p>
+  <note>
+    <p>
+      For additional information on known issues in Apache FOP, please have a look at the following pages, too:
+    </p>
+    <ul>
+      <li><a href="relnotes.html">the release notes</a></li>
+      <li><a href="bugs.html">the bug list in Bugzilla</a></li>
+      <li><a href="http://wiki.apache.org/xmlgraphics-fop/FOPProjectTasks">the task list in the Wiki</a></li>
+    </ul>
+  </note>
+  <p>
+    Apache FOP has an extensive automated testing infrastructure. Parts of this infrastructure are several 
+    sets of test cases. When a test case is listed in disabled-testcases.xml it is disabled in the JUnit 
+    tests during the normal build process. This indicates a problem in the current codebase. When a bug is 
+    fixed or a missing feature is added the entry for the relevant test case(s) are removed.
+  </p>
+  <section>
+    <title>FO Tree</title>
+    <p>
+      This section lists currently disabled test cases in the test suite for the FO tree tests.
+      The data for this section comes from 
+      <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/test/fotree/disabled-testcases.xml">test/fotree/disabled-testcases.xml</a>.
+    </p>
+    <xi:include href="cocoon://knownissues-raw-fotree.xml#xpointer(/document/body/*)"/>
+  </section>
+  <section>
+    <title>Layout Engine</title>
+    <p>
+      This section lists currently disabled test cases in the test suite for the layout engine tests.
+      The data for this section comes from 
+      <a href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/test/layoutengine/disabled-testcases.xml">test/layoutengine/disabled-testcases.xml</a>.
+    </p>
+    <xi:include href="cocoon://knownissues-raw-layoutengine.xml#xpointer(/document/body/*)"/>
+  </section>
+</section>
+</body>
+</document>
+
diff --git a/src/documentation/content/xdocs/site.xml b/src/documentation/content/xdocs/site.xml
index c9ee8224d..d97bb3310 100644
--- a/src/documentation/content/xdocs/site.xml
+++ b/src/documentation/content/xdocs/site.xml
@@ -46,6 +46,7 @@
     <news label="News" href="news.html"/>
     <team label="Who We Are" href="team.html"/>
     <status label="Status" href="status.html"/>
+    <knownissues label="Known Issues" href="knownissues.html"/>
     <changes label="Changes" href="changes.html"/>
     <!--todo label="Todo" href="todo.html"/-->
   </project>
diff --git a/src/documentation/resources/stylesheets/disabled-testcases2document.xsl b/src/documentation/resources/stylesheets/disabled-testcases2document.xsl
new file mode 100644
index 000000000..7e3fcf501
--- /dev/null
+++ b/src/documentation/resources/stylesheets/disabled-testcases2document.xsl
@@ -0,0 +1,60 @@
+<?xml version="1.0"?>
+<!--
+  Copyright 2005 The Apache Software Foundation.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!-- $Id$ -->
+<xsl:stylesheet
+    xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+    version="1.0">
+
+  <xsl:template match="disabled-testcases">
+   <document>
+    <header>
+     <title>Disabled Test Cases</title>
+    </header>
+    <body>
+      <xsl:choose>
+        <xsl:when test="count(testcase) &gt; 0">
+          <xsl:apply-templates select="testcase"/>
+        </xsl:when>
+        <xsl:otherwise>
+          <p>Currently, there are no known issues to list here!</p>
+        </xsl:otherwise>
+      </xsl:choose>
+    </body>
+   </document>  
+  </xsl:template>
+
+  <xsl:template match="testcase">
+    <p>
+      <strong><xsl:value-of select="file"/></strong>
+      <xsl:if test="boolean(name)"><xsl:text> (</xsl:text><xsl:value-of select="name"/>)</xsl:if>:<br/>
+      <xsl:choose>
+        <xsl:when test="string-length(description) &gt; 0">
+          <xsl:value-of select="description"/>
+        </xsl:when>
+        <xsl:otherwise><em>TODO: Add missing description in disabled-testcases.xml!</em></xsl:otherwise>
+      </xsl:choose>
+      <xsl:apply-templates select="reference"/>
+    </p>
+    <p/>
+  </xsl:template>
+  
+  <xsl:template match="reference">
+    <br/>
+    See also: <a href="{.}"><xsl:value-of select="."/></a>
+  </xsl:template>
+  
+</xsl:stylesheet>
diff --git a/src/documentation/sitemap.xmap b/src/documentation/sitemap.xmap
index ac47d12ca..18e5ed69d 100644
--- a/src/documentation/sitemap.xmap
+++ b/src/documentation/sitemap.xmap
@@ -50,5 +50,27 @@
       </map:match>
 
     </map:pipeline>
+    
+    <!-- This is used by xinclude statements in knownissues.xml -->
+    <map:pipeline internal-only="true">
+      <map:match type="regexp" pattern="^(.*?)([^/]*)knownissues-raw-layoutengine.xml$">
+        <map:generate type="file" src="../../test/layoutengine/disabled-testcases.xml"/>
+        <map:transform src="resources/stylesheets/disabled-testcases2document.xsl" >
+          <map:parameter name="bugtracking-url" value="{defaults:bugtracking-url}"/>
+          <map:parameter name="path" value="{1}{2}"/>
+        </map:transform>
+        <map:serialize type="xml-document"/>
+      </map:match>
+      <map:match type="regexp" pattern="^(.*?)([^/]*)knownissues-raw-fotree.xml$">
+        <map:generate type="file" src="../../test/fotree/disabled-testcases.xml"/>
+        <map:transform src="resources/stylesheets/disabled-testcases2document.xsl" >
+          <map:parameter name="bugtracking-url" value="{defaults:bugtracking-url}"/>
+          <map:parameter name="path" value="{1}{2}"/>
+        </map:transform>
+        <map:serialize type="xml-document"/>
+      </map:match>
+    
+    </map:pipeline>
+     
   </map:pipelines>
 </map:sitemap>
author	Jeremias Maerki <jeremias@apache.org>	2005-11-23 13:36:07 +0000
committer	Jeremias Maerki <jeremias@apache.org>	2005-11-23 13:36:07 +0000
commit	7fdd2fafd7a040752c337b162f47911cd9d84997 (patch)
tree	2af832cccde39033407467430a673df8e410d5d1
parent	bffc89284806e3f4bf67854005a9a7c30acd206b (diff)
download	xmlgraphics-fop-7fdd2fafd7a040752c337b162f47911cd9d84997.tar.gz xmlgraphics-fop-7fdd2fafd7a040752c337b162f47911cd9d84997.zip