Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
m
== To address these issues, the [https://www.oasis-open.org/committees/download.php/14809/xml-catalogs.html XML Entity Catalogs Standard] defines an entity catalog that maps both external identifiers and arbitrary URI Resolvers ==BaseX comes with a default references to URI resolver that is usable out of the boxreferences.
<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 to the {{Option|CATALOG}} option. All subsequent commands for adding documents will use the specified catalog file to resolve entities. Paths to your catalog file and the actual DTDs are either absolute or relative to the ''current working directory''. When using BaseX in Clientclient-Server-Modeserver mode, this is relative to they are resolved against the working directory of the ''server's'' working directory. ===Additional Notes===
===Please Note===
If you use the internal parser, you can manually specify whether you want to parse DTDs and entities or not.
BaseX offers support As mentioned above, the Java resolver doesn’t work for the Apache-maintained [http://xmlXSLT include or import URIs when executing XSLT with Saxon.apacheYou can use Norman Walsh’s xmlresolver.org/commons XML Commons Resolver]instead. The catalog location may be given as a path relative to the current working directory, available for download [http://xercesas described above.apacheWhen you want to specify it as an absolute path, this resolver expects a file URI, not a file system path.org/mirrorsExample for setting it on Windows before executing one of the .cgi here]bat scripts, such as bin\basexgui.bat:
To use it add '''resolver.jar''' to the classpath when [[Startup|starting BaseX]]:<pre classlang="brush:bashbat">java set BASEX_JVM="-cp Dorg.basex.jarcatalog=file:///c:resolver/Users/Jane/path/to/catalog.jar org.basex.BaseXServerxml"
[[Category;Version 10.0* Updated:Internals]]<code>CATFILE</code> option renamed to {{Option|CATALOG}}.
Text replacement - "syntaxhighlight" to "pre"
This article is part of the [[Advanced User's Guide]].It clarifies how to deal with external mapping system IDs (DTD declarationslocations) and URIs to local resources when parsing and transforming XML data.:
* The [https://docs.oracle.com/en/java/javase/11/core/xml-catalog-api1.html Java 11: XML Catalog API] is used to resolve references to external resources.* As an alternative, Norman Walsh’s [https://xmlresolver.org/ Enhanced XML Resolver] is utilized if it is found in the classpath. * The Apache-maintained [https://xml.apache.org/commons XML Commons Resolver] has become obsolete.* If enabled, a catalog is universally applied for resolving:** entities (when parsing XML documents);** URIs (for documents, module imports, XSL transformations);** resources (when validating documents). ==OverviewIntroduction== XML documents often rely on Document Type Definitions (DTDs). While parsing a document with BaseX, entities Entities can be 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 classlang="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> from the W3C’s server 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.
Another application for XML catalogs is to provide local resources for reusable XSLT stylesheet libraries that are imported from a canonical location. This is described in greater detail in the following section. ==Usage== ===System ID (DTD Location) Rewrites=== 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" startlang="0"><?xml version="1.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 lang="xml"><!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 <code>etc/w3-catalog.xml</code> in the full distributions can be used out of the box. It defines rewritings for some common W3 DTD files. ===URI Rewrites=== Consider a library of reusable XSLT stylesheets. For performance reasons, this library will be cached locally. However, the import URI for a given stylesheet should always be the same, independent of the accidental relative or absolute path that it is stored at locally. Example: <pre lang="xml"><xsl:import href="http://acme.com/xsltlib/acme2html/1.0/acme2html.xsl"/></pre> The XSLT stylesheet might not even be available from this location. The URI serves as a canonical location identifier for this XSLT stylesheet. A local copy of the <code>acme2html/1.0/</code> directory is expected to reside somewhere, and the location of this directory relative to the local XML catalog file is specified in an entry in this catalog, like this: <pre lang="xml"><rewriteURI uriStartString="http://acme.com/xsltlib/acme2html/1.0/" rewritePrefix="../acmehtml10/"/></pre> This way, XSLT import URIs don’t have to be adjusted for the relative or absolute locations of the XSLT library’s local copy. The same URI rewriting works for resources retrieved by the <code>doc()</code> function from within an XSLT stylesheet. See [[XSLT Module]] for details on how to invoke XSLT stylesheets from within BaseX. NOTE: This URI rewriting is currently restricted to XSLT stylesheets. It has neither been enabled yet for the XQuery function <code>doc()</code> nor for XSD schema locations. It needs Norman Walsh’s resolver mentioned above, the Java resolver apparently does not work for XSLT includes/imports in stylesheets run by Saxon using <code>xslt:transform()</code> et al. See the note below about setting the <code>org.basex.catalog</code> property for Norm’s xmlresolver.org resolver.
===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===
Entity resolving only works if the [[Parsers#XML Parsers|internal XML parser]] is switched off (which is the default case).
By default, an error is raised if the catalog resolution fails. The runtime properties of the catalog resolver can be changed by setting system properties, either on startup… <pre lang="perl">java -Djavax.xml.catalog.resolve= Using other Resolvers =continue ... org.basex.BaseX</pre> …or via XQuery: <pre lang='xquery'>Q{java:System}setProperty('javax.xml.catalog.resolve', 'continue'),...</pre>See [https://docs.oracle.com/en/java/javase/11/core/xml-catalog-api1.html Java 11: XML Catalog API] for more information. There might When using a catalog within an XQuery Module, the global <code>db:catalog</code> option may not be some cases when you do not want to use the built-set in resolver that Java provides by defaultthis module. You can set it via pragma instead: <pre lang='xquery'>(# db:catalog xmlcatalog/catalog.xml #) { xslt:transform(via db:get('acme_content')[1], '../acmecustom/acmehtml.xsl')}</pre> It is assumed that this stylesheet <code>com.sun.org/acmecustom/acmehtml.apachexsl</code> (location relative to the current XQuery script or module) imports <code>acme2html/1.xml0/acme2html.internalxsl</code> by its canonical URI that will be resolved to a local URI by the catalog resolver.resolver Please note that since catalog-based URI rewriting does not work yet within URIs accessed from XQuery, you cannot give a canonical location that needs to be catalog-resolved as the second argument of <code>xslt:transform()</code>.* The catalog location in the pragma can be given relative to the current working directory (the directory that is returned by <code>file:current-dir()</code>)or as an absolute operating system path. The catalog location in the pragma is not an XQuery expression; no concatenation or other operations may occur in the pragma, and the location string must not be surrounded by quotes.
</pre>
=Changelog= More Information ==*[http://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*[http://www.oasis-open.org/committees/download.php/14810/xml-catalogs.pdf XML Catalogs. OASIS Standard, Version 1.1. 07-October-2005.]
