incubator-odf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r794847 - /websites/staging/odftoolkit/trunk/content/odftoolkit/conformance/ODFValidator.html
Date Wed, 24 Aug 2011 20:28:01 GMT
Author: buildbot
Date: Wed Aug 24 20:28:00 2011
New Revision: 794847

Log:
Staging update by buildbot

Modified:
    websites/staging/odftoolkit/trunk/content/odftoolkit/conformance/ODFValidator.html

Modified: websites/staging/odftoolkit/trunk/content/odftoolkit/conformance/ODFValidator.html
==============================================================================
--- websites/staging/odftoolkit/trunk/content/odftoolkit/conformance/ODFValidator.html (original)
+++ websites/staging/odftoolkit/trunk/content/odftoolkit/conformance/ODFValidator.html Wed
Aug 24 20:28:00 2011
@@ -71,23 +71,7 @@
   <div id="contenta">
   
     <h1 class="title">ODF Validator</h1>
-    <p>Notice:    Licensed to the Apache Software Foundation (ASF) under one
-           or more contributor license agreements.  See the NOTICE file
-           distributed with this work for additional information
-           regarding copyright ownership.  The ASF licenses this file
-           to you 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.
-<strong>ODF Validator</strong> is a tool that validates OpenDocument files and
checks them for certain conformance criteria.</p>
+    <p><strong>ODF Validator</strong> is a tool that validates OpenDocument
files and checks them for certain conformance criteria.</p>
 <p><strong>ODF Validator</strong> is available as an <a href="http://tools.odftoolkit.org/odfvalidator">online
service</a> and as a 
 command line tool. This page primarily describes the command line tool. 
 Please visit the <a href="http://tools.odftoolkit.org/odfvalidator">ODF Online Validator</a>
web page for details regarding 
@@ -103,14 +87,14 @@ the online tool.</p>
 <li>Choose an arbitrary OpenDocument file &lt;odffile&gt;</li>
 <li>
 <p>If you are using JRE 1.5, call the '''ODF Validator''' with</p>
-<p>java -jar "&lt;path&gt;/odfvalidator.jar" &lt;odffile&gt;</p>
+<p>java -jar "<path>/odfvalidator.jar" <odffile></p>
 </li>
 <li>
 <p>If you are using JRE 1.6, call the ODF Validator with</p>
 <p>java 
   -Djavax.xml.validation.SchemaFactory:http://relaxng.org/ns/structure/1.0=org.iso_relax.verifier.jaxp.validation.RELAXNGSchemaFactoryImpl
   -Dorg.iso_relax.verifier.VerifierFactoryLoader=com.sun.msv.verifier.jarv.FactoryLoaderImpl
-  -jar "&lt;path&gt;/odfvalidator.jar"  &lt;odffile&gt;</p>
+  -jar "<path>/odfvalidator.jar"  <odffile></p>
 </li>
 </ul>
 <h2 id="usage">Usage</h2>
@@ -124,24 +108,24 @@ the online tool.</p>
 <div class="codehilite"><pre><span class="n">java</span>
   <span class="o">-</span><span class="n">Djavax</span><span class="o">.</span><span
class="n">xml</span><span class="o">.</span><span class="n">validation</span><span
class="o">.</span><span class="n">SchemaFactory:http:</span><span
class="sr">//</span><span class="n">relaxng</span><span class="o">.</span><span
class="n">org</span><span class="sr">/ns/s</span><span class="n">tructure</span><span
class="o">/</span><span class="mf">1.0</span><span class="o">=</span><span
class="n">org</span><span class="o">.</span><span class="n">iso_relax</span><span
class="o">.</span><span class="n">verifier</span><span class="o">.</span><span
class="n">jaxp</span><span class="o">.</span><span class="n">validation</span><span
class="o">.</span><span class="n">RELAXNGSchemaFactoryImpl</span>
   <span class="o">-</span><span class="n">Dorg</span><span class="o">.</span><span
class="n">iso_relax</span><span class="o">.</span><span class="n">verifier</span><span
class="o">.</span><span class="n">VerifierFactoryLoader</span><span
class="o">=</span><span class="n">com</span><span class="o">.</span><span
class="n">sun</span><span class="o">.</span><span class="n">msv</span><span
class="o">.</span><span class="n">verifier</span><span class="o">.</span><span
class="n">jarv</span><span class="o">.</span><span class="n">FactoryLoaderImpl</span>
-  <span class="o">-</span><span class="n">jar</span> <span class="s">&quot;&amp;lt;path&amp;gt;/odfvalidator.jar&quot;</span>
+  <span class="o">-</span><span class="n">jar</span> <span class="s">&quot;&lt;path&gt;/odfvalidator.jar&quot;</span>
 </pre></div>
 
 
 <p>These command lines are abbreviated <em>odfvalidator</em> from now on.</p>
 <p>The <strong>ODF Validator</strong> may be called with the following
options:</p>
-<div class="codehilite"><pre> <span class="n">odfvalidator</span>
<span class="p">[</span><span class="o">-</span><span class="n">r</span><span
class="p">]</span> <span class="p">[</span><span class="o">-</span><span
class="n">c</span><span class="o">|-</span><span class="n">e</span><span
class="o">|-</span><span class="n">s</span><span class="p">]</span>
<span class="p">[</span><span class="o">-</span><span class="n">d</span><span
class="p">]</span> <span class="p">[</span><span class="o">-</span><span
class="n">v</span><span class="o">|-</span><span class="n">w</span><span
class="p">]</span> <span class="p">[</span><span class="o">-</span><span
class="n">x</span> <span class="o">&amp;</span><span class="ow">lt</span><span
class="p">;</span><span class="n">expclude</span> <span class="n">pattern</span><span
class="o">&amp;</span><span class="ow">gt</span><span class="p">;]</span>

-              <span class="p">[</span><span class="o">-</span><span
class="n">o</span> <span class="n">outputfile</span><span class="p">]</span>
<span class="p">[</span><span class="o">-</span><span class="mf">1.0</span><span
class="o">|-</span><span class="mf">1.1</span><span class="o">|-</span><span
class="mf">1.2</span><span class="p">]</span> <span class="o">&amp;</span><span
class="ow">lt</span><span class="p">;</span><span class="n">odffiles</span><span
class="o">&amp;</span><span class="ow">gt</span><span class="p">;</span>
- <span class="n">odfvalidator</span> <span class="p">[</span><span
class="o">-</span><span class="n">r</span><span class="p">]</span>
<span class="p">[</span><span class="o">-</span><span class="n">c</span><span
class="o">|-</span><span class="n">e</span><span class="o">|-</span><span
class="n">s</span><span class="p">]</span> <span class="p">[</span><span
class="o">-</span><span class="n">d</span><span class="p">]</span>
<span class="p">[</span><span class="o">-</span><span class="n">v</span><span
class="o">|-</span><span class="n">w</span><span class="p">]</span>
<span class="p">[</span><span class="o">-</span><span class="n">x</span>
<span class="o">&amp;</span><span class="ow">lt</span><span
class="p">;</span><span class="n">expclude</span> <span class="n">pattern</span><span
class="o">&amp;</span><span class="ow">gt</span><span class="p">;]</span>
-              <span class="p">[</span><span class="o">-</span><span
class="n">o</span> <span class="n">outputfile</span><span class="p">]</span>
<span class="o">-</span><span class="n">S</span> <span class="o">&amp;</span><span
class="ow">lt</span><span class="p">;</span><span class="n">schemafile</span><span
class="o">&amp;</span><span class="ow">gt</span><span class="p">;</span>
<span class="o">&amp;</span><span class="ow">lt</span><span
class="p">;</span><span class="n">odffiles</span><span class="o">&amp;</span><span
class="ow">gt</span><span class="p">;</span>
- <span class="n">odfvalidator</span> <span class="p">[</span><span
class="o">-</span><span class="n">c</span><span class="o">|-</span><span
class="n">s</span><span class="p">]</span> <span class="p">[</span><span
class="o">-</span><span class="n">v</span><span class="o">|-</span><span
class="n">w</span><span class="p">]</span> <span class="p">[</span><span
class="o">-</span><span class="n">d</span><span class="p">]</span>
<span class="p">[</span><span class="o">-</span><span class="n">o</span>
<span class="n">outputfile</span><span class="p">]</span> <span
class="o">-</span><span class="n">C</span> <span class="o">&amp;</span><span
class="ow">lt</span><span class="p">;</span><span class="n">configfile</span><span
class="o">&amp;</span><span class="ow">gt</span><span class="p">;</span>
- <span class="n">odfvalidator</span> <span class="o">-</span><span
class="n">g</span> <span class="o">&amp;</span><span class="ow">lt</span><span
class="p">;</span><span class="n">odffiles</span><span class="o">&amp;</span><span
class="ow">gt</span><span class="p">;</span>
+<div class="codehilite"><pre> <span class="n">odfvalidator</span>
<span class="p">[</span><span class="o">-</span><span class="n">r</span><span
class="p">]</span> <span class="p">[</span><span class="o">-</span><span
class="n">c</span><span class="o">|-</span><span class="n">e</span><span
class="o">|-</span><span class="n">s</span><span class="p">]</span>
<span class="p">[</span><span class="o">-</span><span class="n">d</span><span
class="p">]</span> <span class="p">[</span><span class="o">-</span><span
class="n">v</span><span class="o">|-</span><span class="n">w</span><span
class="p">]</span> <span class="p">[</span><span class="o">-</span><span
class="n">x</span> <span class="o">&lt;</span><span class="n">expclude</span>
<span class="n">pattern</span><span class="o">&gt;</span><span
class="p">]</span> 
+              <span class="p">[</span><span class="o">-</span><span
class="n">o</span> <span class="n">outputfile</span><span class="p">]</span>
<span class="p">[</span><span class="o">-</span><span class="mf">1.0</span><span
class="o">|-</span><span class="mf">1.1</span><span class="o">|-</span><span
class="mf">1.2</span><span class="p">]</span> <span class="sr">&lt;odffiles&gt;</span>
+ <span class="n">odfvalidator</span> <span class="p">[</span><span
class="o">-</span><span class="n">r</span><span class="p">]</span>
<span class="p">[</span><span class="o">-</span><span class="n">c</span><span
class="o">|-</span><span class="n">e</span><span class="o">|-</span><span
class="n">s</span><span class="p">]</span> <span class="p">[</span><span
class="o">-</span><span class="n">d</span><span class="p">]</span>
<span class="p">[</span><span class="o">-</span><span class="n">v</span><span
class="o">|-</span><span class="n">w</span><span class="p">]</span>
<span class="p">[</span><span class="o">-</span><span class="n">x</span>
<span class="o">&lt;</span><span class="n">expclude</span> <span
class="n">pattern</span><span class="o">&gt;</span><span class="p">]</span>
+              <span class="p">[</span><span class="o">-</span><span
class="n">o</span> <span class="n">outputfile</span><span class="p">]</span>
<span class="o">-</span><span class="n">S</span> <span class="sr">&lt;schemafile&gt;</span>
<span class="o">&amp;</span><span class="ow">lt</span><span
class="p">;</span><span class="n">odffiles</span><span class="o">&gt;</span>
+ <span class="n">odfvalidator</span> <span class="p">[</span><span
class="o">-</span><span class="n">c</span><span class="o">|-</span><span
class="n">s</span><span class="p">]</span> <span class="p">[</span><span
class="o">-</span><span class="n">v</span><span class="o">|-</span><span
class="n">w</span><span class="p">]</span> <span class="p">[</span><span
class="o">-</span><span class="n">d</span><span class="p">]</span>
<span class="p">[</span><span class="o">-</span><span class="n">o</span>
<span class="n">outputfile</span><span class="p">]</span> <span
class="o">-</span><span class="n">C</span> <span class="o">&amp;</span><span
class="ow">lt</span><span class="p">;</span><span class="n">configfile</span><span
class="o">&gt;</span>
+ <span class="n">odfvalidator</span> <span class="o">-</span><span
class="n">g</span> <span class="sr">&lt;odffiles&gt;</span>
  <span class="n">odfvalidator</span> <span class="o">-</span><span
class="n">h</span>
  <span class="n">odfvalidator</span> <span class="o">-</span><span
class="n">V</span>
 </pre></div>
 
 
-<p>If no parameters are specified, the files <strong>&lt;odffiles&gt;</strong>
are validated using the schema that belongs to the ODF version of the file. For ODF 1.0 files
the ODF 1.0 schema is used, for ODF 1.1 files the ODF 1.1 schema is used, and so on. The version
of an ODF file is detected for each file separately.</p>
+<p>If no parameters are specified, the files <strong><odffiles></strong>
are validated using the schema that belongs to the ODF version of the file. For ODF 1.0 files
the ODF 1.0 schema is used, for ODF 1.1 files the ODF 1.1 schema is used, and so on. The version
of an ODF file is detected for each file separately.</p>
 <p>The options have the following meaning:</p>
 <p><strong>-1.0</strong>: Use the ODF 1.0 schemas regardless of the version
specified by the validated document.</p>
 <p><strong>-1.1</strong>: Use the ODF 1.0 schemas regardless of the version
specified by the validated document.</p>
@@ -205,9 +189,11 @@ expression using the <strong>|</strong> 
 <p>If <strong>-v</strong> is specified additionally, not only validation
errors and warnings are reported, but also the generator stored in the manifest, MIME types,
the files that are processed, etc.</p>
 <p>If the <strong>-o</strong> option is present, all messages go into the
specified file. Otherwise, they are printed to standard out.</p>
 <h3 id="validation_using_a_non-default_schema">Validation using a non-default schema</h3>
-<p>To specify the schema that is used for <strong>meta-xml</strong>, <strong>content.xml</strong>,
<strong>styles.xml</strong> and <strong>settings.xml</strong> on the
command line, <strong>ODF Validator</strong> has to be called with the following
parameters:</p>
+<p>To specify the schema that is used for <strong>meta-xml</strong>, <strong>content.xml</strong>,

+<strong>styles.xml</strong> and <strong>settings.xml</strong> on
the command line, 
+<strong>ODF Validator</strong> has to be called with the following parameters:</p>
 <div class="codehilite"><pre><span class="n">odfvalidator</span>
<span class="p">[</span><span class="o">-</span><span class="n">r</span><span
class="p">]</span> <span class="p">[</span><span class="o">-</span><span
class="n">c</span><span class="o">|-</span><span class="n">e</span><span
class="o">|-</span><span class="n">s</span><span class="p">]</span>
<span class="p">[</span><span class="o">-</span><span class="n">d</span><span
class="p">]</span> <span class="p">[</span><span class="o">-</span><span
class="n">v</span><span class="o">|-</span><span class="n">w</span><span
class="p">]</span> <span class="p">[</span><span class="o">-</span><span
class="n">x</span> <span class="o">&amp;</span><span class="ow">lt</span><span
class="p">;</span><span class="n">expclude</span> <span class="n">pattern</span><span
class="o">&amp;</span><span class="ow">gt</span><span class="p">;]</span>
- <span class="p">[</span><span class="o">-</span><span class="n">o</span>
<span class="n">outputfile</span><span class="p">]</span> <span
class="o">-</span><span class="n">S</span> <span class="o">&amp;</span><span
class="ow">lt</span><span class="p">;</span><span class="n">schemafile</span><span
class="o">&amp;</span><span class="ow">gt</span><span class="p">;</span>
<span class="o">&amp;</span><span class="ow">lt</span><span
class="p">;</span><span class="n">odffiles</span><span class="o">&amp;</span><span
class="ow">gt</span><span class="p">;</span>
+ <span class="p">[</span><span class="o">-</span><span class="n">o</span>
<span class="n">outputfile</span><span class="p">]</span> <span
class="o">-</span><span class="n">S</span> <span class="sr">&lt;schemafile&gt;</span>
<span class="sr">&lt;odffiles&gt;</span>
 </pre></div>
 
 
@@ -261,19 +247,47 @@ and if the file is not a formula file, t
 <li>The file <em>META-INF/manifest.xml</em> is validated with respect to
the manifest schema of the selected ODF specification.</li>
 <li>If the file is an ODF 1.2 file, then the <em>META-INF/documentsignatures.xml</em>
and <em>META-INF/macrosignatures.xml</em> sub files are validated with respect
to the digital signatures schema of the ODF 1.2 specification.</li>
 <li>For all embedded objects in ODF format, the <em>content.xml</em>, <em>styles.xml</em>,
<em>meta.xml</em> and <em>settings.xml</em> are validated as described
for the main document above.</li>
-<li>It is checked whether the file itself ans all embedded objects in ODF format contain
at least a <em>content.xml</em> or <em>styles.xml</em> sub file.</li>
+<li>It is checked whether the file itself and all embedded objects in ODF format contain
at least a <em>content.xml</em> or <em>styles.xml</em> sub file.</li>
 </ul>
 </li>
 </ul>
 <p>The following actions take place before or during the validation:</p>
-<div class="codehilite"><pre> - A DTD document declaration within a *manifest.xml*
file is ignored. For the logging level **all**, an information is displayed if this happens.
<span class="nt">&lt;br/&gt;</span>**Note:** Very early ODF implementations
in OpenOffice.org wrongly included a document type declaration. Ignoring the document type
enables the validation of the manifest despite of this error.
- - A namespace <span class="ni">&amp;quot;</span>http://openoffice.org/2001/manifest<span
class="ni">&amp;quot;</span> within a *manifest.xml* file is changed to <span
class="ni">&amp;quot;</span>urn:oasis:names:tc:opendocument:xmlns:manifest:1.0<span
class="ni">&amp;quot;</span>. For the logging level **all**, an information is
displayed if this happens. <span class="nt">&lt;br/&gt;</span>**Note:**
Early ODF implementations in OpenOffice.org used the wrong namespace. Changing it to the correct
one enables the validation of the manifest despite the wrong namespace.
- - Namespaces defined in the <span class="nt">&lt;a</span> <span class="na">href=</span><span
class="s">&quot;http://www.oasis-open.org/committees/download.php/10765/office-spec-1.0-cd-2.pdf&quot;</span><span
class="nt">&gt;</span>ODF v1.0 Committee Draft 2<span class="nt">&lt;/a&gt;</span>
are replaced with those of the <span class="nt">&lt;a</span> <span class="na">href=</span><span
class="s">&quot;http://www.oasis-open.org/specs/index.php#opendocumentv1.0&quot;</span><span
class="nt">&gt;</span>ODF v1.0 OASIS Standard<span class="nt">&lt;/a&gt;</span>.
For the logging level **all**, an information is displayed if this happens.<span class="nt">&lt;br/&gt;</span>**Note:**
Changing the namespaces enables the validation of documents that conform to the ODF v1.0 CD2.
Such documents have been saved by OpenOffice.org 1.0 beta versions.
- - The value of *draw:points* attributes is truncated to 2048 characters. For the logging
level **all**, an information is displayed if this happens.<span class="nt">&lt;br/&gt;</span>**Note:**
The truncation of this attribute value avoids a stack overflow in MSV while validating the
attribute value against a regular expression.
- - A namespace <span class="ni">&amp;quot;</span>http://openoffice.org/2004/database<span
class="ni">&amp;quot;</span> within a *content.xml* file is changed to <span
class="ni">&amp;quot;</span>urn:oasis:names:tc:opendocument:xmlns:database:1.0<span
class="ni">&amp;quot;</span>, and a namespace <span class="ni">&amp;quot;</span>http://openoffice.org/2004/office<span
class="ni">&amp;quot;</span> within a *content.xml* file is changed to <span
class="ni">&amp;quot;</span>urn:oasis:names:tc:opendocument:xmlns:office:1.0<span
class="ni">&amp;quot;</span>. For the logging level **all**, an information is
displayed if this happens.<span class="nt">&lt;br/&gt;</span>**Note:**
These namespaces were used in OpenOffice.org 2.x database documents, because database documents
are included in OpenDocument since version 1.2 only. Changing them enables the validation
of  OpenOffice.org 2.x database documents.
-</pre></div>
-
-
+<ul>
+<li>A DTD document declaration within a <em>manifest.xml</em> file is ignored.
+    For the logging level <strong>all</strong>, an information is displayed if
this
+    happens. <br/><strong>Note:</strong> Very early ODF implementations
in
+    OpenOffice.org wrongly included a document type declaration.
+    Ignoring the document type enables the validation of the manifest
+    despite of this error.</li>
+<li>A namespace &quot;http://openoffice.org/2001/manifest&quot; within a
+    <em>manifest.xml</em> file is changed to &quot;urn:oasis:names:tc:opendocument:xmlns:manifest:1.0&quot;.
For
+    the logging level <strong>all</strong>, an information is displayed if this
+    happens. <br/><strong>Note:</strong> Early ODF implementations in OpenOffice.org
+    used the wrong namespace. Changing it to the correct one enables the
+    validation of the manifest despite the wrong namespace.</li>
+<li>Namespaces defined in the <a
+    href="http://www.oasis-open.org/committees/download.php/10765/office-spec-1.0-cd-2.pdf">ODF
+    v1.0 Committee Draft 2</a> are replaced with those of the <a
+    href="http://www.oasis-open.org/specs/index.php#opendocumentv1.0">ODF
+    v1.0 OASIS Standard</a>. For the logging level <strong>all</strong>,
an
+    information is displayed if this happens.<br/><strong>Note:</strong>
Changing the
+    namespaces enables the validation of documents that conform to the
+    ODF v1.0 CD2. Such documents have been saved by OpenOffice.org 1.0
+    beta versions.</li>
+<li>The value of <em>draw:points</em> attributes is truncated to 2048
+    characters. For the logging level <strong>all</strong>, an information is
+    displayed if this happens.<br/><strong>Note:</strong> The truncation
of this
+    attribute value avoids a stack overflow in MSV while validating the
+    attribute value against a regular expression.</li>
+<li>A namespace &quot;http://openoffice.org/2004/database&quot; within a
+    <em>content.xml</em> file is changed to &quot;urn:oasis:names:tc:opendocument:xmlns:database:1.0&quot;,
and
+    a namespace &quot;http://openoffice.org/2004/office&quot; within a
+    <em>content.xml</em> file is changed to &quot;urn:oasis:names:tc:opendocument:xmlns:office:1.0&quot;.
For
+    the logging level <strong>all</strong>, an information is displayed if this
+    happens.<br/><strong>Note:</strong> These namespaces were used in OpenOffice.org
+    2.x database documents, because database documents are included in OpenDocument since
version 1.2 only. Changing them enables the
+    validation of  OpenOffice.org 2.x database documents.</li>
+</ul>
 <h2 id="where_do_i_get_the_schemas">Where do I get the schemas?</h2>
 <p>The OpenDocument schemas are available on the <a href="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office">OASIS
OpenDocument Technical 
 Committee</a> page. The ODF 1.0 and 1.1 schemas can be downloaded directly 



Mime
View raw message