home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2004 December / PCpro_2004_12.ISO / files / webserver / xampp / xampp-cocoon-addon-1.4.9-installer.exe / validation.xml < prev    next >
Encoding:
Extensible Markup Language  |  2004-07-12  |  4.7 KB  |  169 lines
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--
  3.   Copyright 1999-2004 The Apache Software Foundation
  4.  
  5.   Licensed under the Apache License, Version 2.0 (the "License");
  6.   you may not use this file except in compliance with the License.
  7.   You may obtain a copy of the License at
  8.  
  9.       http://www.apache.org/licenses/LICENSE-2.0
  10.  
  11.   Unless required by applicable law or agreed to in writing, software
  12.   distributed under the License is distributed on an "AS IS" BASIS,
  13.   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.   See the License for the specific language governing permissions and
  15.   limitations under the License.
  16. -->
  17. <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "document-v10.dtd">
  18.  
  19. <document>
  20.  <header>
  21.   <title>XML Validation Facilities</title>
  22.   <subtitle>Conducting build-time and run-time validation</subtitle>
  23.   <version>0.2</version> 
  24.   <type>Technical document</type> 
  25.   <authors>
  26.    <person name="David Crossley" email="crossley@apache.org"/>
  27.    <person name="Colin Adams" email="colin@colina.demon.co.uk"/>
  28.   </authors>
  29.  </header>
  30.  
  31.  <body>
  32.  <s1 title="Goal">
  33.   <p>
  34. ###
  35.   </p>
  36.  </s1>
  37.  
  38.  <anchor id="overview"/>
  39.  <s1 title="Overview">
  40. <note>This document is under development.</note>
  41.   <p>You really should validate documents in your editing environment.
  42.     It is not the concern of Cocoon. However there are some facilities.
  43.   </p>
  44.  </s1>
  45.  
  46.  <s1 title="Warning: Validation facilities are under development">
  47.   <p>
  48. The validation facilities are under development in the head CVS.
  49. The RELAX NG grammars for each document type are basic (and some of them are
  50. just generated from old DTDs). The RNG with embedded Schematron rules
  51. (e.g. sitemap.rng) are minimal tests only and utilises Schematron Basic.
  52. Everything is experimental.
  53.   </p>
  54.  
  55.   <p>
  56. With that said, the validation system does work and is waiting for your help
  57. to extend it.
  58.   </p>
  59.  </s1>
  60.  
  61.  <s1 title="Operation">
  62.    <p>
  63.     There are three validation targets in build.xml (see some internal notes).
  64.     If you do not want validation to happen automatically during the build,
  65.     then you can switch it off in
  66.     <code>./properties.xml</code>
  67.    </p>
  68.  
  69.   <s2 title="Build target validate-config">
  70.    <p>
  71.     2.1-dev and 2.0.5
  72.    </p>
  73.    <p>
  74.     <code>./build.sh validate-config</code>
  75.    </p>
  76.    <p>
  77.     Called automatically during the build (only 2.1) and can also be called
  78.     from the command-line.
  79.    </p>
  80.    <p>
  81.     Validation of some core configuration files using RELAX NG. Currently doing:
  82.     cocoon.roles, *.xsl, **/sitemap.xmap,
  83.     and treeprocessor-builtins.xml (using DTD).
  84.    </p>
  85.   </s2>
  86.  
  87.   <s2 title="Build target validate-schematron">
  88.    <p>
  89.     2.1-dev
  90.    </p>
  91.    <p>
  92.     <code>./build.sh validate-schematron</code>
  93.    </p>
  94.    <p>
  95.     Can only be called from the command-line.
  96.    </p>
  97.    <p>
  98.     Validation of all sitemap.xmap using Schematron rules embedded in
  99.     RELAX NG grammars. (Very experimental.)
  100.    </p>
  101.   </s2>
  102.  
  103.   <s2 title="Build target validate-xdocs">
  104.    <p>
  105.     2.1-dev
  106.    </p>
  107.    <p>
  108.     <code>./build.sh validate-xdocs</code>
  109.    </p>
  110.    <p>
  111.     Called automatically during the build, and can also be called from the
  112.     command-line.
  113.    </p>
  114.    <p>
  115.     Validation of all core documentation/xdocs Currently doing:
  116.     book.xml (using RELAX NG), *.xml (using DTD).
  117.    </p>
  118.   </s2>
  119.  
  120.  </s1>
  121.  
  122.  <s1 title="To Do">
  123. <ul>
  124. <li>Is the validate-config stuff properly integrated in the build.xml ?
  125. Is it being called from all of the appropriate places? e.g. should it also be
  126. called from the default target "all"?</li>
  127. <li>Integrate this build-time validation into 2.0.5 (currently standalone
  128. targets).</li>
  129. <li>All of the RELAX NG grammars are basic and need enhancement.</li>
  130. <li>The validate-schematron targets are particularly experimental.</li>
  131. <li>After this build-time validation is settled, then perhaps we can also do
  132. run-time validation when sitemap changes are effected.</li>
  133. </ul>
  134.  </s1>
  135.  
  136.  <s1 title="Stuff">
  137.   <p>
  138. See
  139. <link href="http://cvs.apache.org/viewcvs.cgi/xml-forrest/src/resources/schema/relaxng/README.txt?rev=HEAD&content-type=text/vnd.viewcvs-markup">xml-forrest/src/resources/schema/relaxng/README.txt</link>
  140.   </p>
  141.  
  142.   <p>
  143. See 
  144. <link href="http://cvs.apache.org/viewcvs.cgi/cocoon-2.1/tools/src/schematron/README.txt?rev=HEAD&content-type=text/vnd.viewcvs-markup">cocoon-2.1/tools/src/schematron/README.txt</link>
  145.   </p>
  146.  
  147.   <p>
  148. See notes in the top of 
  149. cocoon-2.1/src/webapp/WEB-INF/entities/sitemap-v06.rng
  150.   </p>
  151.  
  152.  </s1>
  153.  
  154.  <anchor id="info"/>
  155.  <s1 title="Further information">
  156.   <ul>
  157. <li>Organization for the Advancement of Structured Information Standards
  158. (<link href="http://www.oasis-open.org/">OASIS</link>)
  159. </li>
  160. <li>Document Schema Definition Languages
  161. (<link href="http://www.dsdl.org/">DSDL</link>) -
  162. ISO/IEC 19757 - DSDL
  163. </li>
  164.   </ul>
  165.  </s1>
  166.  
  167.  </body>
  168. </document>
  169.