Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
XHTML for example defines its doctype via the following line:
== To enable entity resolving you have to provide a valid XML Entity and URI Resolvers in BaseX ==BaseX is able Catalog file, so that the parser knows where to use available URI resolvers without any additional configurationlook for mirrored DTDs. A simple working example for XHTML might look like this:
To enable entity resolving you have to provide a valid XML Catalog file.
A simple working example for XHTML might look like this:
<?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/''.
[[File:catalog-file.jpg|thumb|Location for the Catalog File]]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.
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.
'''Please note''' that entity resolving only works with To enable Entity Resolving in Console Mode, enable the {{Option|DTD}} option and assign the path to your XML catalog file to the {{Option|CATFILE}} option: <code>SET INTPARSE false</code>. <code>INTPARSE</code> is set All subsequent commands for adding documents will use the specified catalog file to false by defaultresolve entities.
== Using other Resolvers ==There might be some cases when you do not want Paths to use your catalog file and the builtactual DTDs are either absolute or relative to the ''current working directory''. When using BaseX in client-in resolver that Java provides by default (via <code>com.sun.org.apache.xml.internal.resolver.*</code>)server mode, they are resolved against the working directory of the ''server''.
BaseX offers support for ===Additional Notes=== Entity resolving only works if the [[Parsers#XML Parsers|internal XML parser]] is switched off (which is the default case). The 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.ignoreMissing}} is not assigned, no warnings will be output to standard error if the Apache maintained properties file or resources linked from that file are not found. See [httphttps://xmlxerces.apache.org/xml-commons XML Commons /components/resolver/resolver-article.html#ctrlresolver Controlling the Catalog Resolver] available for more information. ==Links== * [https://www.oasis-open.org/committees/download .php/14809/xml-catalogs.html XML Catalogs. OASIS Standard, Version 1.1. 07-October-2005]* [http://xercesen.apachewikipedia.org/mirrorswiki/Document_Type_Definition Wikipedia on Document Type Definitions]* [http://xml.cgi here]apache.To use it add '''org/commons/components/resolver/resolver-article.jar''' to the classpath when [[Startup|starting BaseX]html Apache XML Commons Article on Entity Resolving]:<pre class="brush* [http:bash">//java -cp basex.jar:resolversun.jar orgcom/webservices/docs/1.basex6/jaxb/catalog.BaseXServer</pre>html XML Entity and URI Resolvers], Sun
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 (DTDDTDs). While parsing a document with BaseX elements and entities Entities can be checked for validity resolved 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 the <code>xhtml1-strict.dtd</code> obviously involves some network traffic. When dealing with single files , this may seem tolerable, but importing large collections might benefit benefits from caching these resources locally. Depending on your connection the remote server, you will experience significant speed improvementswhen 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== BaseX relies on the Apache-maintained [http://xml.apache.org/commons XML Commons Resolver]. The ''xml-resolver-1.2.jar'' library is included in the full distributions of BaseX. If the resolver is not found in the classpath, and if Java 8 is used, Java’s built-in resolver will be applied (via <code>com.sun.org.apache.xml.internal.resolver.*</code>).
<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===
===Console & Server Mode===
