Configuration - Revision history

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

2022-07-25T13:59:05Z

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

CG: /* Home Directory */

2022-07-20T11:10:57Z

Home Directory

CG at 11:24, 31 March 2022

2022-03-31T11:24:50Z

CG: /* Home Directory */

2021-01-26T10:44:38Z

Home Directory

CG: /* Configuration Files */

2021-01-26T10:42:24Z

Configuration Files

CG at 13:31, 10 April 2019

2019-04-10T13:31:36Z

CG at 11:09, 24 May 2018

2018-05-24T11:09:51Z

CG at 12:15, 23 March 2018

2018-03-23T12:15:48Z

CG: /* Database Directory */

2018-03-23T12:14:54Z

Database Directory

CG: /* Home Directory */

2018-03-12T13:02:17Z

Home Directory

@@ Line 38: / Line 38: @@
 ==Log Files==
-Log files are stored in text format in a <code>.logs</code> sub-directory of the database folder (see [[Logging]] for more information).
+Log files are stored in text format in a <code>.logs</code> subdirectory of the database folder (see [[Logging]] for more information).
 =Changelog=

@@ Line 20: / Line 20: @@
 * First, the '''Java system property''' {{Code|org.basex.path}} is checked. If it contains a value, it is chosen as directory path.
-* If not, the '''current user directory''' (defined by the system property {{Code|user.dir}}) is chosen if the {{Code|.basex}} or {{Code|.basexhome}} file is found in this directory.
+* If not, the '''current user directory''' (defined by the system property {{Code|user.dir}}) is selected if the {{Code|.basex}} or {{Code|.basexhome}} file is found in this directory.
 * If not, the '''application directory''' (the folder in which BaseX is located) is chosen if one of these two files is found in that directory.
 * In all other cases, a {{Code|basex}} subdirectory in the '''user home directory''' will be returned. The user home directory is retrieved via the {{Code|HOME}} environment variable, or (if unassigned) the Java system property {{Code|user.home}}.
-If BaseX is used in an embedded environment (such as a servlet in a [[Web Application]]), it may not immediately be clear which directory was chosen. You can run the XQuery expression <code>Q{org.basex.util.Prop}HOMEDIR()</code> to find out.
+If BaseX is used in an embedded environment (such as a servlet in a [[Web Application]]), it may not immediately be clear which directory was picked. You can run the XQuery expression <code>Q{java:org.basex.util.Prop}HOMEDIR()</code> to find out.
 ==Database Directory==

← Older revision		Revision as of 11:24, 31 March 2022
Line 1:		Line 1:
−	This ~~article~~ is part of the [[~~Advanced User's Guide~~]].	+	This page is part of the [[Getting Started]] Section. It gives some insight into the configuration of BaseX.
−	It gives some ~~more~~ insight into the configuration of BaseX.

	==Configuration Files==		==Configuration Files==

@@ Line 18: / Line 18: @@
 ==Home Directory==
-As BaseX is distributed in different flavors, and may be started from different locations, it dynamically determines its home directory:
+As BaseX is distributed in different flavors, and as it may be started from different locations, it dynamically determines its home directory:
 * First, the '''Java system property''' {{Code|org.basex.path}} is checked. If it contains a value, it is chosen as directory path.
 * If not, the '''current user directory''' (defined by the system property {{Code|user.dir}}) is chosen if the {{Code|.basex}} or {{Code|.basexhome}} file is found in this directory.
-* If not, the '''application directory''' (the folder in which BaseX is located) is chosen if one of these two files is found.
+* If not, the '''application directory''' (the folder in which BaseX is located) is chosen if one of these two files is found in that directory.
-* In all other cases, a {{Code|basex}} subdirectory in the '''user home directory''' will be returned. The user home directory is retrieved via the {{Code|HOME}} environment variable, or (if unassigned), from the Java system property {{Code|user.home}}.
+* In all other cases, a {{Code|basex}} subdirectory in the '''user home directory''' will be returned. The user home directory is retrieved via the {{Code|HOME}} environment variable, or (if unassigned) the Java system property {{Code|user.home}}.
-If BaseX is used in an embedded environment (such as a servlet in a [[Web Application]]), it may not immediately be clear what directory was chosen. You can run the XQuery expression <code>Q{org.basex.util.Prop}HOMEDIR()</code> to find out.
+If BaseX is used in an embedded environment (such as a servlet in a [[Web Application]]), it may not immediately be clear which directory was chosen. You can run the XQuery expression <code>Q{org.basex.util.Prop}HOMEDIR()</code> to find out.
 ==Database Directory==

@@ Line 9: / Line 9: @@
 * <code>.basexgui</code> defines all options relevant to the BaseX GUI.
 * <code>.basexhistory</code> contains commands that have been typed in most recently.
-* <code>.basexhome</code> can be created by a user to mark a folder as [[#Home Directory|home directory]]. Its contents do not matter, so it is usually empty.
+* An empty <code>.basexhome</code> file can be added to a directory to mark it as [[#Home Directory|home directory]].
 Note that:

@@ Line 33: / Line 33: @@
 The database path can be changed as follows:
 * GUI: Choose ''Options'' → ''Preferences'' and choose a new database path.
-* General: edit the <code>[[Options#DBPATH|DBPATH]]</code> option in the {{Code|.basex}} configuration file
+* General: edit the {{Option|DBPATH}} option in the {{Code|.basex}} configuration file
 '''Note:''' Existing databases will not automatically be moved to the new destination.

@@ Line 46: / Line 46: @@
 =Changelog=
 ;Version 8.0
@@ Line 53: / Line 57: @@
 ;Version 7.7
-* Updated: the {{Code|.basexhome}} file marks a folder as [[#Home Directory|home directory]].
+* Updated: The {{Code|.basexhome}} file marks a folder as [[#Home Directory|home directory]].

@@ Line 31: / Line 31: @@
 ==Database Directory==
-{{Mark|Updated with Version 9.0::}}
+{{Mark|Updated with Version 9.0:}}
 [[Databases]] consists of several binary files. These are located in a directory named by the name of the database. The database root directory is named {{Code|data}}.

@@ Line 27: / Line 27: @@
 * In all other cases, a {{Code|basex}} subdirectory in the '''user home directory''' will be returned. The user home directory is retrieved via the {{Code|HOME}} environment variable, or (if unassigned), from the Java system property {{Code|user.home}}. Before {{Version|9.0}}, the home directory itself was returned.
-If BaseX is used in an embedded environment (such as a servlet in a [[Web Application]]), it may not immediately be clear what directory was chosen. In this case, you can run the XQuery expression <code>Q{org.basex.util.Prop}USERHOME()</code> to find out.
+If BaseX is used in an embedded environment (such as a servlet in a [[Web Application]]), it may not immediately be clear what directory was chosen. You can run the XQuery expression <code>Q{org.basex.util.Prop}HOMEDIR()</code> to find out.
 ==Database Directory==