Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
== BaseX relies on the Apache-maintained [http://xml.apache.org/commons XML Entity and URI Resolvers ==Commons Resolver]. The ''xml-resolver-1.2.jar'' library is included in the full distributions of BaseX comes with a default URI . If the resolver that is usable out of not found in the boxclasspath, and if Java 8 is used, Java’s built-in resolver will be applied (via <code>com.sun.org.apache.xml.internal.resolver.*</code>).
<?xml version="1.0"?>
<rewriteSystem systemIdStartString="http://www.w3.org/TR/xhtml1/DTD/" rewritePrefix="file:///path/to/dtds/" />
This rewrites all systemIds starting with: ''<nowiki>http://www.w3.org/TR/xhtml1/DTD/</nowiki>'' to ''file:///path/to/dtds/''.
To enable Entity Resolving in Console Mode, specify the following [[options]]:
* <code>SET CATFILE [path]</code>
Now entity resolving is active for the current session. All subsequent <code>ADD</code> commands will use the catalog file to resolve entities.
The '''paths''' To enable Entity Resolving in Console Mode, enable the {{Option|DTD}} option and assign the path to your XML catalog file and the actual DTDs are either absolute or relative to the ''current working directory''{{Option|CATFILE}} option. When using BaseX in Client-Server-Mode, this is relative All subsequent commands for adding documents will use the specified catalog file to the ''server's'' working directoryresolve entities.
===Please Note===Entity resolving only works if Paths to your catalog file and the [[Parsers#XML Parsers|internal XML parser]] is switched off (which is actual DTDs are either absolute or relative to the default case)''current working directory''.If you use When using BaseX in client-server mode, they are resolved against the working directory of the internal parser, you can manually specify whether you want to parse DTDs and entities or not''server''.
BaseX offers support for Entity resolving only works if the Apache-maintained [http://xml.apache.org/commons [Parsers#XML Parsers|internal XML Commons Resolverparser], available for download [http://xerces.apache.org/mirrors.cgi here]. To use it add '''resolver.jar''' to is switched off (which is the classpath when [[Startup|starting BaseX]]:<pre class="brush:bash">java -cp basex.jar:resolver.jar org.basexdefault case).BaseXServer</pre>
== More Information ==*[http://enThe runtime properties of the catalog resolver can be changed by setting system properties, or adding a ''CatalogManager.properties'' file to the classpath. By default, and if the system property {{Code|xml.catalog.wikipediaignoreMissing}} is not assigned, no warnings will be output to standard error if the properties file or resources linked from that file are not found.org/wiki/Document_Type_Definition Wikipedia on Document Type Definitions]*See [httphttps://xmlxerces.apache.org/xml-commons/components/resolver/resolver-article.html Apache XML Commons Article on Entity Resolving#ctrlresolver Controlling the Catalog Resolver]*[http://java.sun.com/webservices/docs/1for more information.6/jaxb/catalog.html XML Entity and URI Resolvers], Sun*[http://www.oasis-open.org/committees/download.php/14810/xml-catalogs.pdf XML Catalogs. OASIS Standard, Version 1.1. 07-October-2005.]
no edit summary
This article is part of the [[Advanced User's Guide]]. It clarifies how to deal with external DTD declarations when parsing and transforming XML data. ==OverviewIntroduction== XML documents often rely on Document Type Definitions (DTDs). While parsing a document with BaseX, entities Entities can be resolved and the whole document can be checked for validity with respect to that particular DTD.By default, the DTD is only used for entity resolution.
XHTML, for example, defines its doctype via the following line:
<pre class="brush:xml">
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
</pre>
Fetching <code>xhtml1-strict.dtd</code> obviously involves network traffic. When dealing with single files, this may seem tolerable, but importing large collections benefits from caching these resources. Depending on the remote server, you will experience significant speed improvements when caching DTDs locally. To address these issues, the [https://www.oasis-open.org/committees/download.php/14809/xml-catalogs.html XML Catalogs Standard] defines an entity catalog that maps both external identifiers and arbitrary URI references to URI references. ==Usage==
To enable entity resolving you have to provide a valid XML Catalog file, so that the parser knows where to look for mirrored DTDs.
A simple working example for XHTML might look like this:
<pre class="brush:xml" start="0">
<catalog prefer="system" xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
</catalog>
</pre>
This rewrites all systemIds starting with: <code><nowiki>http://www.w3.org/TR/xhtml1/DTD/</nowiki></code> to <code>file:///path/to/dtds/</code>. For example, if the following XML file is parsed: <pre class="brush:xml" start="0"><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"/></pre> The XHTML DTD <code>xhtml1-stricttransitional.dtd</code> and all its linked resources will now be loaded from the specified path. The catalog file ''etc/w3-catalog.xml'' in the full distributions can be used out of the box. It defines rewriting for some common W3 DTD files.
===GUI Mode===
When running BaseX in GUI mode, simply enable DTD parsing and provide the path to your XML Catalog file in the ''Parsing'' Tab of the Database Creation Dialog.
===Console & Server Mode===
== Using other Resolvers =Additional Notes===There might be some cases when you do not want to use the built-in resolver that Java provides by default(via <code>com.sun.org.apache.xml.internal.resolver.*</code>).
==Links==
* [https://www.oasis-open.org/committees/download.php/14809/xml-catalogs.html XML Catalogs. OASIS Standard, Version 1.1. 07-October-2005]* [Categoryhttp:Internal//en.wikipedia.org/wiki/Document_Type_Definition Wikipedia on Document Type Definitions]* [http://xml.apache.org/commons/components/resolver/resolver-article.html Apache XML Commons Article on Entity Resolving]* [http://java.sun.com/webservices/docs/1.6/jaxb/catalog.html XML Entity and URI Resolvers], Sun
