Catalog Resolver - Revision history

CG: Text replacement - "syntaxhighlight" to "pre"

2023-12-01T16:38:16Z

Text replacement - "syntaxhighlight" to "pre"

CG: Text replacement - "" to "

2023-12-01T16:35:26Z

Text replacement - "<syntaxhighlight lang="xquery">" to "<pre lang='xquery'>"

CG: Text replacement - "" to ""

2023-12-01T16:33:08Z

Text replacement - "</syntaxhighlight>" to "</pre>"

CG at 10:25, 26 October 2023

2023-10-26T10:25:38Z

Gimsieke: on using xmlresolver.org for XSLT includes/imports

2023-06-03T09:52:49Z

on using xmlresolver.org for XSLT includes/imports

CG: Text replacement - "db:pre(" to "db:get("

2022-07-20T11:34:01Z

Text replacement - "db:pre(" to "db:get("

CG at 09:03, 20 July 2022

2022-07-20T09:03:45Z

CG at 08:45, 20 July 2022

2022-07-20T08:45:44Z

CG at 06:51, 20 July 2022

2022-07-20T06:51:28Z

CG: Text replacement - "db:open" to "db:pre"

2022-07-19T18:55:52Z

Text replacement - "db:open" to "db:pre"

@@ Line 15: / Line 15: @@
 XHTML, for example, defines its doctype via the following line:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 </pre>
@@ Line 33: / Line 33: @@
 A simple working example for XHTML might look like this:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <catalog prefer="system" xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
    <rewriteSystem systemIdStartString="http://www.w3.org/TR/xhtml1/DTD/" rewritePrefix="file:///path/to/dtds/" />
@@ Line 41: / Line 41: @@
 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:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
@@ Line 55: / Line 55: @@
 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:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <xsl:import href="http://acme.com/xsltlib/acme2html/1.0/acme2html.xsl"/>
 </pre>
@@ Line 61: / Line 61: @@
 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:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <rewriteURI uriStartString="http://acme.com/xsltlib/acme2html/1.0/" rewritePrefix="../acmehtml10/"/>
 </pre>
@@ Line 87: / Line 87: @@
 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…
-<syntaxhighlight lang="perl">
+<pre lang="perl">
 java -Djavax.xml.catalog.resolve=continue ... org.basex.BaseX
 </pre>
@@ Line 115: / Line 115: @@
 As mentioned above, the Java resolver doesn’t work for XSLT include or import URIs when executing XSLT with Saxon. You can use Norman Walsh’s xmlresolver.org instead. The catalog location may be given as a path relative to the current working directory, as described above. When you want to specify it as an absolute path, this resolver expects a file URI, not a file system path. Example for setting it on Windows before executing one of the .bat scripts, such as bin\basexgui.bat:
-<syntaxhighlight lang="bat">
+<pre lang="bat">
 set BASEX_JVM="-Dorg.basex.catalog=file:///c:/Users/Jane/path/to/catalog.xml"
 </pre>

@@ Line 93: / Line 93: @@
 …or via XQuery:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 Q{java:System}setProperty('javax.xml.catalog.resolve', 'continue'),
 ...
@@ Line 101: / Line 101: @@
 When using a catalog within an XQuery Module, the global <code>db:catalog</code> option may not be set in this module. You can set it via pragma instead:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 (# db:catalog xmlcatalog/catalog.xml #) {
    xslt:transform(db:get('acme_content')[1], '../acmecustom/acmehtml.xsl')

@@ Line 17: / Line 17: @@
 <syntaxhighlight lang="xml">
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-</syntaxhighlight>
+</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.
@@ Line 37: / Line 37: @@
    <rewriteSystem systemIdStartString="http://www.w3.org/TR/xhtml1/DTD/" rewritePrefix="file:///path/to/dtds/" />
 </catalog>
-</syntaxhighlight>
+</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:
@@ Line 45: / Line 45: @@
      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml"/>
-</syntaxhighlight>
+</pre>
 The XHTML DTD <code>xhtml1-transitional.dtd</code> and all its linked resources will now be loaded from the specified path.
@@ Line 57: / Line 57: @@
 <syntaxhighlight lang="xml">
 <xsl:import href="http://acme.com/xsltlib/acme2html/1.0/acme2html.xsl"/>
-</syntaxhighlight>
+</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:
@@ Line 63: / Line 63: @@
 <syntaxhighlight lang="xml">
 <rewriteURI uriStartString="http://acme.com/xsltlib/acme2html/1.0/" rewritePrefix="../acmehtml10/"/>
-</syntaxhighlight>
+</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.
@@ Line 89: / Line 89: @@
 <syntaxhighlight lang="perl">
 java -Djavax.xml.catalog.resolve=continue ... org.basex.BaseX
-</syntaxhighlight>
+</pre>
 …or via XQuery:
@@ Line 96: / Line 96: @@
 Q{java:System}setProperty('javax.xml.catalog.resolve', 'continue'),
 ...
-</syntaxhighlight>
+</pre>
 See [https://docs.oracle.com/en/java/javase/11/core/xml-catalog-api1.html Java 11: XML Catalog API] for more information.
@@ Line 105: / Line 105: @@
    xslt:transform(db:get('acme_content')[1], '../acmecustom/acmehtml.xsl')
+}
-</syntaxhighlight>
+</pre>
 It is assumed that this stylesheet <code>../acmecustom/acmehtml.xsl</code> (location relative to the current XQuery script or module) imports <code>acme2html/1.0/acme2html.xsl</code> by its canonical URI that will be resolved to a local URI by the catalog resolver.
@@ Line 117: / Line 117: @@
 <syntaxhighlight lang="bat">
 set BASEX_JVM="-Dorg.basex.catalog=file:///c:/Users/Jane/path/to/catalog.xml"
-</syntaxhighlight>
+</pre>
 =Changelog=

@@ Line 1: / Line 1: @@
-This article is part of the [[Advanced User's Guide]]. It clarifies how to deal with mapping system IDs (DTD locations) and URIs to local resources when parsing and transforming XML data.
+This article is part of the [[Advanced User's Guide]]. It clarifies how to deal with mapping system IDs (DTD locations) 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.
@@ Line 115: / Line 113: @@
 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.
-As mentioned above, the Java resolver doesn’t work for XSLT include or import URIs when executing XSLT with Saxon. You can use Norman Walsh’s xmlresolver.org instead. The catalog location may be given as a path relative to the current working directory as described above. When you want to specify it as an absolute path, this resolver expects a file URI, not a file system path. Example for setting it on Windows prior to executing one of the .bat scripts, such as bin\basexgui.bat:
+As mentioned above, the Java resolver doesn’t work for XSLT include or import URIs when executing XSLT with Saxon. You can use Norman Walsh’s xmlresolver.org instead. The catalog location may be given as a path relative to the current working directory, as described above. When you want to specify it as an absolute path, this resolver expects a file URI, not a file system path. Example for setting it on Windows before executing one of the .bat scripts, such as bin\basexgui.bat:
 <syntaxhighlight lang="bat">

@@ Line 71: / Line 71: @@
 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.
+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 W⁠alsh’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===
@@ Line 114: / Line 114: @@
 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.
 =Changelog=

← Older revision		Revision as of 09:03, 20 July 2022
Line 114:		Line 114:

	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.		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.
−
−	~~==Links==~~
−
−	* [https://docs.oracle.com/en/java/javase/11/core/xml-catalog-api1.html Java 11: XML Catalog API]
−	* [https://www.oasis-open.org/committees/download.php/14809/xml-catalogs.html XML Catalogs. OASIS Standard, Version 1.1. 07-October-2005]
−	* [https://en.wikipedia.org/wiki/Document_Type_Definition Wikipedia on Document Type Definitions]

	=Changelog=		=Changelog=

@@ Line 1: / Line 1: @@
 This article is part of the [[Advanced User's Guide]]. It clarifies how to deal with mapping system IDs (DTD locations) and URIs to local resources when parsing and transforming XML data.
 ==Introduction==
@@ Line 21: / Line 31: @@
 ===System ID (DTD Location) Rewrites===
-BaseX relies on the Apache-maintained [https://xml.apache.org/commons XML Commons Resolver]. The {{Code|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>).
+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:
@@ Line 79: / Line 87: @@
 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 properties file or resources linked from that file are not found. See [https://xerces.apache.org/xml-commons/components/resolver/resolver-article.html#ctrlresolver Controlling the Catalog Resolver] for more information.
+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…
 When using a catalog within an XQuery Module, the global <code>db:catalog</code> option may not be set in this module. You can set it via pragma instead:
@@ Line 97: / Line 117: @@
 ==Links==
 * [https://www.oasis-open.org/committees/download.php/14809/xml-catalogs.html XML Catalogs. OASIS Standard, Version 1.1. 07-October-2005]
 * [https://en.wikipedia.org/wiki/Document_Type_Definition Wikipedia on Document Type Definitions]
 =Changelog=