Repository - Revision history

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

2023-12-01T16:39:55Z

Text replacement - "syntaxhighlight" to "pre"

CG: Text replacement - "" to ""

2023-12-01T16:37:00Z

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

CG: Text replacement - "" to "

2023-12-01T16:31:23Z

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

CG at 08:08, 9 March 2023

2023-03-09T08:08:14Z

CG: Text replacement - "ub-director" to "ubdirector"

2022-07-25T13:59:40Z

Text replacement - "ub-director" to "ubdirector"

CG at 13:42, 25 July 2022

2022-07-25T13:42:55Z

CG at 21:21, 6 September 2021

2021-09-06T21:21:22Z

CG: /* Installation */

2021-09-06T21:20:35Z

Installation

CG at 10:14, 15 February 2021

2021-02-15T10:14:06Z

James Ball: Minor grammatical updates

2020-12-18T18:03:15Z

Minor grammatical updates

@@ Line 118: / Line 118: @@
 Contents of the file {{Code|Hello.java}} (comments removed):
-<syntaxhighlight lang="java">
+<pre lang="java">
 package org.basex.modules;
 public class Hello {
@@ Line 212: / Line 212: @@
 ; Java class {{Code|Hello.java}}:
-<syntaxhighlight lang="java">
+<pre lang="java">
 package org.basex.modules;
@@ Line 252: / Line 252: @@
 * Apart from the package descriptor <code>expath-pkg.xml</code>, the package has to contain a descriptor file at its root, defining the included jars and the binary names of their public classes. It must be named <code>basex.xml</code> and must conform to the following structure:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <package xmlns="http://expath.org/ns/pkg">
    <jar>...</jar>
@@ Line 268: / Line 268: @@
 Suppose we have a simple class <code>Printer</code> having just one public method <code>print()</code>:
-<syntaxhighlight lang="java">
+<pre lang="java">
 package test;

@@ Line 21: / Line 21: @@
 import module namespace m = 'http://basex.org/modules/hello' at 'hello-world.xqm';
 m:hello("Universe")
-</syntaxhighlight>
+</pre>
 '''Library Module''' <code>hello-world.xqm</code> (in the same directory):
@@ Line 30: / Line 30: @@
    'Hello ' || $world
 };
-</syntaxhighlight>
+</pre>
 If no location is supplied, modules will be looked up in the repository. Repository modules are stored in the {{Code|repo}} directory, which resides in your [[Configuration#Home Directory|home directory]]. XQuery modules can be manually copied to the repository directory or installed and deleted via [[#Commands|commands]].
@@ Line 39: / Line 39: @@
 import module namespace functx = 'http://www.functx.com';
 functx:capitalize-first('test')
-</syntaxhighlight>
+</pre>
 =Commands=
@@ Line 92: / Line 92: @@
 import module namespace m = 'http://basex.org/modules/Hello';
 m:hello("Universe")
-</syntaxhighlight>
+</pre>
 ==Java==
@@ Line 125: / Line 125: @@
+   }
+}
-</syntaxhighlight>
+</pre>
 Installation (the file will be copied to {{Code|org/basex/modules/Hello.jar}}):
@@ Line 136: / Line 136: @@
 import module namespace m = 'http://basex.org/modules/Hello';
 m:hello("Universe")
-</syntaxhighlight>
+</pre>
 After having installed the module, all of the following URIs can be used in XQuery to import this module or call its functions (see [[Java Bindings#URI Rewriting|URI Rewriting]] for more information):
@@ Line 188: / Line 188: @@
 import module namespace m = 'http://basex.org/modules/Hello';
 m:hello("Universe")
-</syntaxhighlight>
+</pre>
 ; Wrapper Module {{Code|Hello.xqm}}:
@@ Line 208: / Line 208: @@
    java:hello($world)
 };
-</syntaxhighlight>
+</pre>
 ; Java class {{Code|Hello.java}}:
@@ Line 220: / Line 220: @@
+   }
+}
-</syntaxhighlight>
+</pre>
 If the JAR file is installed, {{Code|Combined}} will be displayed as type:
@@ Line 260: / Line 260: @@
      ....
 </package>
-</syntaxhighlight>
+</pre>
 * The jar file itself along with an XQuery file defining wrapper functions around the java methods has to reside in the module directory. The following example illustrates how java methods are wrapped with XQuery functions:
@@ Line 276: / Line 276: @@
+   }
+}
-</syntaxhighlight>
+</pre>
 We want to extend BaseX with this class and use its method. In order to make this possible we have to define an XQuery function which wraps the <code>print</code> method of our class. This can be done in the following way:
@@ Line 289: / Line 289: @@
    return p:print($printer, $str)
 };
-</syntaxhighlight>
+</pre>
 As it can be seen, the class {{Code|Printer}} is declared with its binary name as a namespace prefixed with "java" and the XQuery function is implemented using the [http://docs.basex.org/wiki/Java_Bindings Java Bindings] offered by BaseX.

@@ Line 18: / Line 18: @@
 '''Main Module''' <code>hello-universe.xq</code>:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 import module namespace m = 'http://basex.org/modules/hello' at 'hello-world.xqm';
 m:hello("Universe")
@@ Line 25: / Line 25: @@
 '''Library Module''' <code>hello-world.xqm</code> (in the same directory):
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 module namespace m = 'http://basex.org/modules/Hello';
 declare function m:hello($world) {
@@ Line 36: / Line 36: @@
 The following example calls a function from the FunctX module in the repository:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 import module namespace functx = 'http://www.functx.com';
 functx:capitalize-first('test')
@@ Line 89: / Line 89: @@
 Importing the repository module:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 import module namespace m = 'http://basex.org/modules/Hello';
 m:hello("Universe")
@@ Line 133: / Line 133: @@
 XQuery file <code>[https://files.basex.org/modules/org/basex/modules/Hello/HelloUniverse.xq HelloUniverse.xq]</code> (same as above):
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 import module namespace m = 'http://basex.org/modules/Hello';
 m:hello("Universe")
@@ Line 185: / Line 185: @@
 ; Main Module {{Code|hello-universe.xq}}:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 import module namespace m = 'http://basex.org/modules/Hello';
 m:hello("Universe")
@@ Line 192: / Line 192: @@
 ; Wrapper Module {{Code|Hello.xqm}}:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 module namespace hello = 'http://basex.org/modules/Hello';
@@ Line 280: / Line 280: @@
 We want to extend BaseX with this class and use its method. In order to make this possible we have to define an XQuery function which wraps the <code>print</code> method of our class. This can be done in the following way:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 import module namespace j="http://basex.org/lib/testJar";

@@ Line 264: / Line 264: @@
 * The jar file itself along with an XQuery file defining wrapper functions around the java methods has to reside in the module directory. The following example illustrates how java methods are wrapped with XQuery functions:
-'''Example:'''<br>Suppose we have a simple class <code>Printer</code> having just one public method <code>print()</code>:
+'''Example:'''
 <syntaxhighlight lang="java">

@@ Line 83: / Line 83: @@
 '''Example:'''
-Installation (the original file will be copied to the {{Code|org/basex/modules/Hello}} sub-directory of the repository):
+Installation (the original file will be copied to the {{Code|org/basex/modules/Hello}} subdirectory of the repository):
   REPO INSTALL https://files.basex.org/modules/org/basex/modules/Hello/HelloWorld.xqm
@@ Line 148: / Line 148: @@
 A Java class may depend on additional libraries. The dependencies can be resolved by creating a fat JAR file, i.e., extracting all files of the library archives and producing a single, flat JAR package.
-Another solution is to copy the libraries into a {{Code|lib}} directory of the JAR package. When the package is installed, the additional library archives will be extracted and copied to a hidden sub-directory in the repository. If the package is deleted, the hidden sub-directory will be removed as well.
+Another solution is to copy the libraries into a {{Code|lib}} directory of the JAR package. When the package is installed, the additional library archives will be extracted and copied to a hidden subdirectory in the repository. If the package is deleted, the hidden subdirectory will be removed as well.
 ; Examplary contents of {{Code|Image.jar}}

@@ Line 233: / Line 233: @@
 =EXPath Packaging=
-The [http://expath.org/spec/pkg EXPath specification] defines the structure of a .xar archive. The package contains at its root a package descriptor named <code>expath-pkg.xml</code>. This descriptor presents some meta data about the package as well as the libraries which it contains and their dependencies on other libraries or processors.
+The [http://expath.org/spec/pkg EXPath specification] defines the structure of a .xar archive. The package contains at its root a package descriptor named <code>expath-pkg.xml</code>. This descriptor presents some metadata about the package as well as the libraries which it contains and their dependencies on other libraries or processors.
 ==XQuery==

@@ Line 85: / Line 85: @@
 Installation (the original file will be copied to the {{Code|org/basex/modules/Hello}} sub-directory of the repository):
-  REPO INSTALL http://files.basex.org/modules/org/basex/modules/Hello/HelloWorld.xqm
+  REPO INSTALL https://files.basex.org/modules/org/basex/modules/Hello/HelloWorld.xqm
 Importing the repository module:
@@ Line 224: / Line 224: @@
 If the JAR file is installed, {{Code|Combined}} will be displayed as type:
-  REPO INSTALL http://files.basex.org/modules/org/basex/modules/Hello.jar
+  REPO INSTALL https://files.basex.org/modules/org/basex/modules/Hello.jar
   REPO LIST

@@ Line 55: / Line 55: @@
 A module or package can be installed with {{Command|REPO INSTALL}}. The path to the file has to be given as a parameter:
-  REPO INSTALL http://files.basex.org/modules/expath/functx-1.0.xar
+  REPO INSTALL https://files.basex.org/modules/expath/functx-1.0.xar
   REPO INSTALL hello-world.xqm

@@ Line 239: / Line 239: @@
 Apart from the package descriptor, a {{Code|.xar}} archive contains a directory which includes the actual XQuery modules. For example, the [https://files.basex.org/modules/expath/functx-1.0.xar FunctX XAR archive] is packaged as follows:
-<syntaxhighlight>
+<pre>
 expath-pkg.xml
 functx/
    functx.xql
    functx.xsl
-</syntaxhighlight>
+</pre>
 ==Java==