]> source.dussan.org Git - xmlgraphics-fop.git/commitdiff
Move testing.xml to dev area.
authorWilliam Victor Mote <vmote@apache.org>
Mon, 7 Apr 2003 04:22:59 +0000 (04:22 +0000)
committerWilliam Victor Mote <vmote@apache.org>
Mon, 7 Apr 2003 04:22:59 +0000 (04:22 +0000)
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196222 13f79535-47bb-0310-9956-ffa450edef68

src/documentation/content/xdocs/book.xml
src/documentation/content/xdocs/dev/book.xml
src/documentation/content/xdocs/dev/testing.xml [new file with mode: 0644]
src/documentation/content/xdocs/testing.xml [deleted file]

index f86e16ad0b07aee0a77ab1e3016e891093fe79d6..e1f1ec610b90d57f9bf4d69c90214fa85925adc8 100644 (file)
           <menu-item label="Configuration" href="configuration.html"/>
         </menu>
 
-        <menu label="Developing">
-          <menu-item label="Testing" href="testing.html"/>
-        </menu>
-
         <menu label="Resources">
           <menu-item label="Getting Help" href="gethelp.html"/>
           <menu-item label="FAQs" href="faq.html"/>
index 9b55bad3873c51b17507cda34647e3ba09815ac4..5b45063427aed770b15cef4f0315f86b18ab843b 100644 (file)
@@ -28,6 +28,7 @@
       <external label="FOP Wiki" href="http://nagoya.apache.org/wiki/apachewiki.cgi?FOPProjectPages"/>
       <menu-item label="Design" href="../design/index.html"/>
       <menu-item label="Tools" href="tools.html"/>
+      <menu-item label="Testing" href="testing.html"/>
       <external label="Patch queue" href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;email1=&amp;emailtype1=substring&amp;emailassigned_to1=1&amp;email2=&amp;emailtype2=substring&amp;emailreporter2=1&amp;bugidtype=include&amp;bug_id=&amp;changedin=&amp;votes=&amp;chfieldfrom=&amp;chfieldto=Now&amp;chfieldvalue=&amp;product=Fop&amp;short_desc=%5BPATCH%5D&amp;short_desc_type=allwordssubstr&amp;long_desc=&amp;long_desc_type=allwordssubstr&amp;bug_file_loc=&amp;bug_file_loc_type=allwordssubstr&amp;keywords=&amp;keywords_type=anywords&amp;field0-0-0=noop&amp;type0-0-0=noop&amp;value0-0-0=&amp;namedcmd=Fop+all&amp;newqueryname=fop+patch+queue&amp;tofooter=1&amp;order=Reuse+same+sort+as+last+time"/>
     </menu>
 </book>
diff --git a/src/documentation/content/xdocs/dev/testing.xml b/src/documentation/content/xdocs/dev/testing.xml
new file mode 100644 (file)
index 0000000..3218de2
--- /dev/null
@@ -0,0 +1,108 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
+    "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/document-v11.dtd">
+
+<document>
+    <header>
+        <title>Testing FOP</title>
+    </header>
+
+    <body>
+  <section>
+    <title>Running and Using Tests</title>
+    <p>
+Testing is an important part of getting FOP to operate correctly and conform to the
+necessary standards.
+    </p>
+    <p>
+A testing system has been set up that works with as a build target when developing
+with FOP. A developer can run the tests after making changes to the code, the aim
+is to have the tests run to verfiy that nothing working has been broken.
+    </p>
+    <p>
+To setup the testing the developer must place a reference fop.jar in the
+"&lt;cvs_repository>/test/reference/" directory. This jar will be dynamically
+loaded to create the reference output.
+    </p>
+  </section>
+
+  <section>
+    <title>W3C TestSuite</title>
+    <p>
+The testing is set up so that you can download the testsuite from
+<jump href="http://www.w3.org/Style/XSL/TestSuite/">http://www.w3.org/Style/XSL/TestSuite/</jump>,
+unzip the file into the base directory of FOP.
+Then you can uncomment the lines in the build.xml file in the test target and itwill run through all the tests in the testsuite distribution.
+    </p>
+  </section>
+
+  <section>
+    <title>Writing a Test</title>
+    <p>
+A test belongs to one of a few catagories. A basic test should excercise one
+element in a number of situations such as changing a property. This should have
+at least one normal value, one border value and one invalid value. If the property
+can be of different types then this should also be included.
+    </p>
+    <p>
+A bug test is a test that is specifically aimed at a problem with FOP. That is, the test
+is not excercising the specification but rather a problem with FOP in handling a particular
+situation that is not exposed with the other testing.
+    </p>
+    <p>
+A system test is one that tests the abitlity of FOP to handle a number of different
+elements together.
+    </p>
+    <p>
+A test can consist of a complete fo document or a part of the document such as
+some elements that will be placed into the flow of a standard document.
+    </p>
+
+  </section>
+  <section>
+    <title>Submitting a Test</title>
+    <p>
+If you have a test which you think would be useful you should supply the
+test and a diff to the appropriate test suite xml file. Make sure that the
+test works as would be expected against the current build.
+    </p>
+  </section>
+
+  <section>
+    <title>How Testing Works</title>
+    <p>
+The tests are stored in the "&lt;cvs_repository>/test" directory.
+    </p>
+    <p>
+You can run the tests by specifying the build target "test" ie: <br/>
+<code>build.sh test</code>
+    </p>
+    <p>
+This will then compare the current code in the local src directory to a specified
+release of FOP. Any differences between the current code and the output from
+the reference version will be reported. If the test previously passed then the
+test run will have failed.
+    </p>
+    <p>
+The testing is done by reading a test suite xml file, which corresponds to the
+standard testsuite.dtd supplied from w3c. This xml file contains a test xml
+file and an xsl file (which may simply copy the file). It also contains information
+such as if the test has passed and any comments.
+    </p>
+    <p>
+For FOP the testing is done by rendering all the testing documents using the
+XML renderer. The XML files are then compared to see if there are any differences.
+    </p>
+  </section>
+
+  <section>
+    <title>SVG Testing</title>
+    <p>
+The testing of SVG is not part of this testing system. SVG is tested for its rendering
+accuracy by using the transcoding mechanism via Batik. So that the only part that needs
+testing is how the SVG image is embedded inside the flow of the fo document.
+    </p>
+  </section>
+</body>
+</document>
+
diff --git a/src/documentation/content/xdocs/testing.xml b/src/documentation/content/xdocs/testing.xml
deleted file mode 100644 (file)
index 3218de2..0000000
+++ /dev/null
@@ -1,108 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
-    "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/document-v11.dtd">
-
-<document>
-    <header>
-        <title>Testing FOP</title>
-    </header>
-
-    <body>
-  <section>
-    <title>Running and Using Tests</title>
-    <p>
-Testing is an important part of getting FOP to operate correctly and conform to the
-necessary standards.
-    </p>
-    <p>
-A testing system has been set up that works with as a build target when developing
-with FOP. A developer can run the tests after making changes to the code, the aim
-is to have the tests run to verfiy that nothing working has been broken.
-    </p>
-    <p>
-To setup the testing the developer must place a reference fop.jar in the
-"&lt;cvs_repository>/test/reference/" directory. This jar will be dynamically
-loaded to create the reference output.
-    </p>
-  </section>
-
-  <section>
-    <title>W3C TestSuite</title>
-    <p>
-The testing is set up so that you can download the testsuite from
-<jump href="http://www.w3.org/Style/XSL/TestSuite/">http://www.w3.org/Style/XSL/TestSuite/</jump>,
-unzip the file into the base directory of FOP.
-Then you can uncomment the lines in the build.xml file in the test target and itwill run through all the tests in the testsuite distribution.
-    </p>
-  </section>
-
-  <section>
-    <title>Writing a Test</title>
-    <p>
-A test belongs to one of a few catagories. A basic test should excercise one
-element in a number of situations such as changing a property. This should have
-at least one normal value, one border value and one invalid value. If the property
-can be of different types then this should also be included.
-    </p>
-    <p>
-A bug test is a test that is specifically aimed at a problem with FOP. That is, the test
-is not excercising the specification but rather a problem with FOP in handling a particular
-situation that is not exposed with the other testing.
-    </p>
-    <p>
-A system test is one that tests the abitlity of FOP to handle a number of different
-elements together.
-    </p>
-    <p>
-A test can consist of a complete fo document or a part of the document such as
-some elements that will be placed into the flow of a standard document.
-    </p>
-
-  </section>
-  <section>
-    <title>Submitting a Test</title>
-    <p>
-If you have a test which you think would be useful you should supply the
-test and a diff to the appropriate test suite xml file. Make sure that the
-test works as would be expected against the current build.
-    </p>
-  </section>
-
-  <section>
-    <title>How Testing Works</title>
-    <p>
-The tests are stored in the "&lt;cvs_repository>/test" directory.
-    </p>
-    <p>
-You can run the tests by specifying the build target "test" ie: <br/>
-<code>build.sh test</code>
-    </p>
-    <p>
-This will then compare the current code in the local src directory to a specified
-release of FOP. Any differences between the current code and the output from
-the reference version will be reported. If the test previously passed then the
-test run will have failed.
-    </p>
-    <p>
-The testing is done by reading a test suite xml file, which corresponds to the
-standard testsuite.dtd supplied from w3c. This xml file contains a test xml
-file and an xsl file (which may simply copy the file). It also contains information
-such as if the test has passed and any comments.
-    </p>
-    <p>
-For FOP the testing is done by rendering all the testing documents using the
-XML renderer. The XML files are then compared to see if there are any differences.
-    </p>
-  </section>
-
-  <section>
-    <title>SVG Testing</title>
-    <p>
-The testing of SVG is not part of this testing system. SVG is tested for its rendering
-accuracy by using the transcoding mechanism via Batik. So that the only part that needs
-testing is how the SVG image is embedded inside the flow of the fo document.
-    </p>
-  </section>
-</body>
-</document>
-