Options - Revision history

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

2023-12-01T16:39:03Z

Text replacement - "syntaxhighlight" to "pre"

CG: Text replacement - "" to "

2023-12-01T16:37:09Z

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

CG: Text replacement - "" to ""

2023-12-01T16:37:00Z

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

CG at 18:17, 31 October 2023

2023-10-31T18:17:46Z

CG at 10:26, 26 October 2023

2023-10-26T10:26:49Z

CG: /* STOPPORT */

2023-09-17T12:24:50Z

STOPPORT

CG at 08:18, 28 July 2023

2023-07-28T08:18:54Z

CG at 08:17, 28 July 2023

2023-07-28T08:17:56Z

Show changes

CG: /* LOGPATH */

2023-07-28T08:01:32Z

LOGPATH

CG: /* General Options */

2023-07-28T07:56:50Z

General Options

@@ Line 12: / Line 12: @@
 * The {{Code|.basex}} [[Configuration#Configuration Files|configuration file]] is parsed by every new local BaseX instance. It contains all global options. Local options can be specified at the end of the file after the {{Code|Local Options}} comment:
-<syntaxhighlight lang="perl">
+<pre lang="perl">
 # General Options
 DEBUG = false
@@ Line 23: / Line 23: @@
 * Initial values for global options can also be specified via system properties, which can be passed on with the [https://docs.oracle.com/en/java/javase/11/tools/java.html -D flag] on the command line, or with [https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#setProperty(java.lang.String,java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{Code|org.basex.}}. An example:
-<syntaxhighlight lang="perl">
+<pre lang="perl">
 java -Dorg.basex.CATALOG=etc/w3-catalog.xml -cp basex.jar org.basex.BaseX -c"SHOW OPTIONS catalog"
 CATALOG: etc/w3-catalog.xml
@@ Line 30: / Line 30: @@
 * If the Mac OS X packaged application is used, global options can be set within the Info.plist file within the Contents folder of the application package. For example:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <key>JVMOptions</key>
 <array>
@@ Line 39: / Line 39: @@
 * In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <context-param>
    <param-name>org.basex.catalog</param-name>
@@ Line 732: / Line 732: @@
 * If the option is enabled, whitespaces of an element and its descendants can locally be preserved with the <code>xml:space="preserve"</code> attribute:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <xml>
    <title>

@@ Line 1,144: / Line 1,144: @@
 * <code>{URI}a=x</code> &nbsp; binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}.
 * In the following [[Commands#Command_Scripts| Command Script]], the value {{Code|hello world!}} is bound to the variable {{Code|$GREETING}}:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 SET BINDINGS GREETING="hello world!"
 XQUERY declare variable $GREETING external; $GREETING
@@ Line 1,212: / Line 1,212: @@
 | '''Summary'''
 |When creating new nodes in XQuery via [https://www.w3.org/TR/xquery-31/#id-constructors Node Constructors], copies of all enclosed nodes are created, and the copied nodes get new node identities. As a result, the following query yields <code>false</code>:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $a := <a/>
 let $b := <b>{ $a }</b>

@@ Line 19: / Line 19: @@
 # Local Options
 CATALOG = etc/w3-catalog.xml
-</syntaxhighlight>
+</pre>
 * Initial values for global options can also be specified via system properties, which can be passed on with the [https://docs.oracle.com/en/java/javase/11/tools/java.html -D flag] on the command line, or with [https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#setProperty(java.lang.String,java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{Code|org.basex.}}. An example:
@@ Line 26: / Line 26: @@
 java -Dorg.basex.CATALOG=etc/w3-catalog.xml -cp basex.jar org.basex.BaseX -c"SHOW OPTIONS catalog"
 CATALOG: etc/w3-catalog.xml
-</syntaxhighlight>
+</pre>
 * If the Mac OS X packaged application is used, global options can be set within the Info.plist file within the Contents folder of the application package. For example:
@@ Line 35: / Line 35: @@
    <string>-Dorg.basex.CATALOG=etc/w3-catalog.xml</string>
 </array>
-</syntaxhighlight>
+</pre>
 * In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows:
@@ Line 44: / Line 44: @@
    <param-value>etc/w3-catalog.xml</param-value>
 </context-param>
-</syntaxhighlight>
+</pre>
 * In XQuery, local options can be set via option declarations and [[XQuery Extensions#Pragmas|pragmas]].
@@ Line 739: / Line 739: @@
    <text xml:space="preserve">To <b>be</b>, or not to <b>be</b>, that is the question.</text>
 </xml>
-</syntaxhighlight>
+</pre>
 If whitespaces are stripped, <code>indent=yes</code> can be assigned to the {{Option|SERIALIZER}} option to get properly indented XML output.<br/>
 See [[BaseX_10#Whitespaces|BaseX 10: Whitespaces]] for more information on whitespace handling.
@@ Line 1,147: / Line 1,147: @@
 SET BINDINGS GREETING="hello world!"
 XQUERY declare variable $GREETING external; $GREETING
-</syntaxhighlight>
+</pre>
 |}
@@ Line 1,216: / Line 1,216: @@
 let $b := <b>{ $a }</b>
 return $b/a is $a
-</syntaxhighlight>
+</pre>
 This step can be expensive and memory consuming. If the option is disabled, child nodes will only be linked to the new parent nodes, and the upper query returns <code>true</code>.<br/>The option should be used carefully as it changes the semantics of XQuery. It should preferably be used in [[XQuery Extensions#Database Pragmas|Pragmas]].
 |}

@@ Line 1,118: / Line 1,118: @@
 ===BINDINGS===
 {| width='100%'
@@ Line 1,133: / Line 1,135: @@
 * Commas in values must be duplicated.
 * Variables may optionally be introduced with a leading dollar sign.
-* If a variable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [https://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notation].
+* If a variable uses a namespace different from the default namespace, it can be specified with the [[XQuery 3.0#Expanded QNames|Expanded QNames]] notation.
 This option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-b</code>.
 |- valign="top"
@@ Line 1,483: / Line 1,485: @@
 ;Version 11.0
 * Removed: <code>TEXTPARSER</code>
 ;Version 10.0

@@ Line 309: / Line 309: @@
 ===IGNORECERT===
 {| width='100%'
@@ Line 718: / Line 716: @@
 ===STRIPWS===
 {| width='100%'
@@ Line 809: / Line 805: @@
 ===CATALOG===
 {| width='100%'

@@ Line 534: / Line 534: @@
 |- valign="top"
 | '''Summary'''
-|This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed:
+|If Jetty is started from BaseX, this is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be closed:
 * The listener for stopping the web server will only be started if the specified value is greater than {{Code|0}}.
 * The option is ignored if BaseX is used as a [[Web Application]] or started via [[Web Application#Maven|Maven]].

@@ Line 413: / Line 413: @@
 ==HTTP Services==
-Most HTTP options are defined in the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files in the <code>[https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/webapp/WEB-INF webapp/WEB-INF]</code> directory. Some additional BaseX-specific options exist that will be set before the web server is started:
+Most HTTP options are defined in the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files in the <code>[https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/webapp/WEB-INF webapp/WEB-INF]</code> directory. Some additional BaseX-specific options exist that are set before the web server is started:
 ===WEBPATH===
@@ Line 428: / Line 428: @@
 |Points to the directory in which all the [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files:
 * The option is ignored if BaseX is deployed as [[Web Application#Servlet_Container|web servlet]].
-* It cannot be assigned via the {{Code|web.xml}} file, as it will be evaluated before the configuration files are parsed.
+* It cannot be assigned via the {{Code|web.xml}} file, as it is evaluated before the configuration files are parsed.
 |}
@@ Line 631: / Line 631: @@
 |- valign="top"
 | '''Summary'''
-|Skips corrupt (i.e., not well-formed) files while creating a database or adding new documents. If this option is activated, document updates are slowed down, as all files are parsed twice. Next, main memory consumption is higher, as parsed files will be cached in main memory.
+|Skips corrupt (i.e., not well-formed) files while creating a database or adding new documents. If this option is activated, document updates are slowed down, as all files are parsed twice. Next, main-memory consumption is higher, as parsed files are cached in main memory.
 |}

@@ Line 95: / Line 95: @@
 |- valign="top"
 | '''Summary'''
-|Points to the directory in which all [[Logging|log files]] are stored. Relative paths will be resolved against the {{Option|DBPATH}} directory.
+|Points to the directory where [[Logging|log files]] are stored. Relative paths are resolved against the {{Option|DBPATH}} directory.
 |}

@@ Line 67: / Line 67: @@
 |- valign="top"
 | '''Summary'''
-|Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes. It can also be triggered on [[Command-Line Options#BaseX Standalone|command line]] via <code>-d</code>.
+|Sends debug information to STDERR. This option can be enabled to get additional information for development and debugging purposes. It can also be triggered on the [[Command-Line Options#BaseX Standalone|command line]] via <code>-d</code>. Note that the amount of output can be overwhelming, so it should not be used productively.
 |}