Graphical User Interface - Revision history

CG: /* Editor */

2022-07-25T14:24:21Z

Editor

CG at 07:32, 19 July 2022

2022-07-19T07:32:43Z

CG at 16:00, 16 May 2022

2022-05-16T16:00:20Z

CG: /* Visualizations */

2020-07-29T10:27:42Z

Visualizations

CG at 10:52, 8 July 2020

2020-07-08T10:52:04Z

CG: Text replacement - "[http://en.wikipedia.org/" to "[https://en.wikipedia.org/"

2020-07-02T10:56:37Z

Text replacement - "[http://en.wikipedia.org/" to "[https://en.wikipedia.org/"

CG: Text replacement - "[http://basex.org/" to "[https://basex.org/"

2020-07-02T10:52:03Z

Text replacement - "[http://basex.org/" to "[https://basex.org/"

CG: Text replacement - "[http://files.basex.org/" to "[https://files.basex.org/"

2020-07-02T10:46:04Z

Text replacement - "[http://files.basex.org/" to "[https://files.basex.org/"

CG at 14:41, 27 February 2020

2020-02-27T14:41:00Z

CG at 14:40, 27 February 2020

2020-02-27T14:40:35Z

@@ Line 59: / Line 59: @@
 =Editor=
-The built-in editor of BaseX is a powerful tool which allows you to edit text documents (XML, JSON, JavaScript, …), write and run XQuery files and modules, assemble [[Commands#Basics|Command Scripts]] and develop [[RESTXQ]] applications:
+The built-in editor of BaseX is a powerful tool for write XQuery code and [[Commands#Basics|Command Scripts]], editing text documents (XML, JSON, JavaScript, …), and developing [[RESTXQ]] applications:
-* The editor offers '''Syntax highlighting''' for XML, XQuery, JSON and JavaScript files.
+* The editor offers native '''syntax highlighting''' for XQuery, XML, JSON and JavaScript.
-* XQuery, XML and JSON files will be '''parsed''' in real-time and '''errors''' will be highlighted.
+* XQuery, XML and JSON files will be '''parsed''' in real time and '''errors''' will be highlighted.
 * XQuery code and command scripts can be '''executed''' (via Ctrl Enter or by clicking on the green triangle).
 Numerous [[Shortcuts|keyboard shortcuts]] are available to speed up editing and debugging. Some examples:
-* Ctrl H: Search the currently selected string in your complete project.
+* Ctrl H: Search for the currently selected string in your complete project.
 * Ctrl .: Jump to the next erroneous code in your project.

@@ Line 17: / Line 17: @@
 At the top of the BaseX window, the menu bar resides. It houses all important features of the BaseX GUI. Use the ''Database'' menu to [[Graphical_User_Interface#Database Management|create and manage your XML databases]]. The ''Editor'' menu gives you access to a variety of tools and options for working with files. The ''View'' menu lets you toggle between the bars and panels described below. The ''Visualization'' menu offers you a comprehensive set of data representations that will help you to understand your data even better. Use the ''Options'' menu to set your preferences regarding real-time execution, colors, fonts, and packages.
 Right below the menu bar, you can find the ''Buttons'' bar and just below that the ''Input Bar''. The ''Buttons'' bar offers you a wide range of shortcuts, mostly for menu options, such as managing databases and displaying views and visualizations, but also for navigating through your data. With the [[Graphical_User_Interface#Input Bar|''Input Bar'']], you can query your data using three different kinds of query syntax.
-[[File:Basex-buttons-input-bar.png]]
+[[File:GUI-Header.png|600px]]
 The ''Status Bar'' is situated at the bottom of the BaseX window.
@@ Line 28: / Line 26: @@
 The BaseX [[Graphical_User_Interface#Editor|editor]] consists of the ''Project'' view, a file browser with optional input fields for searching files, and the actual ''Editor'' panel with buttons for creating, opening, saving, searching, executing and debugging your files.
-[[File:Basex-editor-panel.png]]
+[[File:GUI-Editor.png|600px]]
 In addition to that, the ''Result'' view displays the output of queries and database operations and the ''Info'' view shows you information about database processes and query execution.
-[[File:Basex-result-info-panel.png]]
+[[File:GUI-ResultInfo.png|600px]]
 To gain further insights into your data, you can choose to display various [[Graphical_User_Interface#Visualizations|visualizations]] such as ''Map'', ''Tree'', ''Folder'', ''Plot'', ''Table'' and ''Explorer''.
@@ Line 40: / Line 38: @@
 The BaseX GUI is a great place for creating and managing your XML databases.
-To '''create a new database''', select ''Database'' → ''New'' from the menu and browse to an XML document of your choice. You can start with the {{Code|factbook.xml}} document, which contains statistical information on the worlds' countries. It is included in the {{Code|etc}} directory of our [https://basex.org/download full distributions] ( ZIP Package and Windows Installer) or can be downloaded [https://files.basex.org/xml/factbook.xml here] (1.3 MB). In the ''Create Database'' dialog, specify the path to your input file and the name of the new database. If you leave the input file field empty, an empty database will be created. Click the ''OK'' button to create the database.
+To '''create a new database''', select ''Database'' → ''New'' from the menu and browse to an XML document of your choice. You can start with the {{Code|factbook.xml}} document, which contains statistical information on the worlds' countries. It is included in the {{Code|etc}} directory of our [https://basex.org/download full distributions] (ZIP Package and Windows Installer) or can be downloaded [https://files.basex.org/xml/factbook.xml here] (1.3 MB). In the ''Create Database'' dialog, specify the path to your input file and the name of the new database. If you leave the input file field empty, an empty database will be created. Click the ''OK'' button to create the database.
 '''Note:''' You can also use the GUI's [[Graphical_User_Interface#Editor|editor]] to create and edit your own XML document. Just specify it as input file for the creation of a new database after saving the document to disk.
@@ Line 57: / Line 55: @@
 '''Note:''' You can also access the menu options ''New'', ''Open & Manage'', ''Properties'' and ''Close'' from BaseX's Buttons bar.
-[[File:Basex-buttons-bar-database.png]]
+[[File:GUI-Menu.png|600px]]
 =Editor=
@@ Line 74: / Line 72: @@
 If you right-click on an XML document in the ''Project'' view, the selected file will be parsed and bound to the context item:
-[[Image:BaseX-Editor-Context.png|449px]]
+[[File:GUI-Context.png|600px]]
 ==Project View==
@@ Line 88: / Line 86: @@
 The ''Input Bar'' is situated on top of the main window. It offers you three different modes to query your XML databases: '''Find''', '''XQuery''' and '''Command'''.
-[[Image:InputBar.png|Input Bar]]
+[[Image:GUI-Input.png|600px]]
 The upcoming example queries can all be used with an instance of the <code>factbook</code> database:

@@ Line 1: / Line 1: @@
-This page is part of the [[Getting Started]] Section. BaseX comes with a graphical user interface that offers you marvellous tools for managing, querying and visualizing your data and write complex applications in XQuery.
+This page is part of the [[Getting Started]] Section. BaseX comes with a graphical user interface that offers you great tools for managing, querying and visualizing your data and write complex applications in XQuery.
 =Startup=
@@ Line 12: / Line 12: @@
 Some additional [[Command-Line_Options#GUI|command-line options]] are available.
-Please note that the standalone client must not be used if you perform parallel (concurrent) read and write operations on your databases. See [[Startup#Concurrent Operations|Concurrent Operations]] for more details.
+It is worth mentioning that the standalone client must not be used if you perform parallel (concurrent) read and write operations on your databases. See [[Startup#Concurrent Operations|Concurrent Operations]] for more details.
 =Introduction=
-The BaseX GUI window is divided into various bars and panels.
+At the top of the BaseX window, the menu bar resides. It houses all important features of the BaseX GUI. Use the ''Database'' menu to [[Graphical_User_Interface#Database Management|create and manage your XML databases]]. The ''Editor'' menu gives you access to a variety of tools and options for working with files. The ''View'' menu lets you toggle between the bars and panels described below. The ''Visualization'' menu offers you a comprehensive set of data representations that will help you to understand your data even better. Use the ''Options'' menu to set your preferences regarding real-time execution, colors, fonts, and packages.
 [[File:Basex-menu-bar.png|600px]]
@@ Line 55: / Line 53: @@
 ** Create and manage text, attribute, token and full-text indexes. Customize indexes by specifying language, stemming, case-sensitivity and diacritics settings or include a stop word list.
 * With the ''Export'' item, you can serialize your database into a whole range of different output formats, including XML, JSON and CSV.
-* The ''Close'' item closes the database. Currently open databases are closed automatically as soon as another database is opened.
+* The ''Close'' item closes the database. An open database is closed automatically as soon as another database is opened.
 '''Note:''' You can also access the menu options ''New'', ''Open & Manage'', ''Properties'' and ''Close'' from BaseX's Buttons bar.
@@ Line 66: / Line 64: @@
 * The editor offers '''Syntax highlighting''' for XML, XQuery, JSON and JavaScript files.
-* XQuery, XML and JSON files will be '''parsed''' in realtime and '''errors''' will be highlighted.
+* XQuery, XML and JSON files will be '''parsed''' in real-time and '''errors''' will be highlighted.
 * XQuery code and command scripts can be '''executed''' (via Ctrl Enter or by clicking on the green triangle).
@@ Line 161: / Line 159: @@
 '''Result''' (''View'' menu)
-:Displays query results and other textual output (e.g. content of the currently open database). Query results can be saved in a file.
+:Displays query results and other textual output (e.g., content of the currently open database). Query results can be saved in a file.
 </td><td valign="top" width="50%">
 [[Image:InfoView.png|thumb|200px]]
@@ Line 176: / Line 174: @@
 '''Tree'''
-:Displays all XML nodes in a top down tree with edges and nodes. You can change some settings of the Tree in the Menu ''Options'' → ''Tree Options''.
+:Displays all XML nodes in a top-down tree with edges and nodes. You can change some settings of the Tree in the Menu ''Options'' → ''Tree Options''.
 </td></tr><tr><td valign="top" width="50%">
 [[Image:Folder.png|thumb|200px]]
@@ Line 186: / Line 184: @@
 '''Plot'''
-:Displays all nodes in a scatterplot, which is particularly helpful if you want to explore analyze your data. Three drop down menus allow custom axis assignments.
+:Displays all nodes in a scatter plot, which is particularly helpful if you want to explore analyze your data. Three dropdown menus allow custom axis assignments.
 </td></tr><tr><td valign="top" width="50%">
 [[Image:Table.png|thumb|200px]]
@@ Line 199: / Line 197: @@
 </td></tr></table>
-=Realtime Options=
+=Real-time Options=
 In the ''Options'' menu, you can change how queries are executed and visualized:
-* '''Realtime Execution''': If realtime execution is enabled, your searches and queries will be executed with each key click and the results will be instantly shown.
+* '''Real-time Execution''': If real-time execution is enabled, your searches and queries will be executed with each key click and the results will be instantly shown.
-* '''Realtime Filtering''': If enabled, all visualizations will be limited to the actual results in realtime. If this feature is disabled, the query results are highlighted in the visualizations and can be explicitly filtered with the 'Filter' button.
+* '''Real-time Filtering''': If enabled, all visualizations will be limited to the actual results in real-time. If this feature is disabled, the query results are highlighted in the visualizations and can be explicitly filtered with the 'Filter' button.
 =Look and Feel=
@@ Line 236: / Line 234: @@
 ;Version 8.0
-* Updated: support for dark look and feels; support for JTatto library
+* Updated: support for dark look and feels; support for JTattoo library

@@ Line 158: / Line 158: @@
 <table cellpadding="0" cellspacing="10"><tr><td valign="top" width="50%">
-[[Image:Result.png|thumb|200px|Result View]]
+[[Image:Result.png|thumb|200px]]
 '''Result''' (''View'' menu)
 :Displays query results and other textual output (e.g. content of the currently open database). Query results can be saved in a file.
 </td><td valign="top" width="50%">
-[[Image:InfoView.png|thumb|200px|Info View]]
+[[Image:InfoView.png|thumb|200px]]
 '''Info''' (''View'' menu)
 :Helpful for analyzing the query plans of your XQuery expressions. It also displays information on the compilation and evaluation of queries.
 </td></tr><tr><td valign="top" width="50%">
-[[Image:Map.png|thumb|200px|Map View]]
+[[Image:Map.png|thumb|200px]]
 '''Map'''
 :Displays all data in a [https://en.wikipedia.org/wiki/Treemap TreeMap]. All nodes of the XML document are represented as rectangles, filling the complete area. You can choose different layout algorithms in the Menu ''Options'' → ''Map Layout''.
 </td><td valign="top" width="50%">
-[[Image:Tree.png|thumb|200px|Tree View]]
+[[Image:Tree.png|thumb|200px]]
 '''Tree'''
 :Displays all XML nodes in a top down tree with edges and nodes. You can change some settings of the Tree in the Menu ''Options'' → ''Tree Options''.
 </td></tr><tr><td valign="top" width="50%">
-[[Image:Folder.png|thumb|200px|Folder View]]
+[[Image:Folder.png|thumb|200px]]
 '''Folder'''
 :Displays all nodes in an Explorer-like folder view. Nodes can be expanded or closed by clicking on the arrows.
 </td><td valign="top" width="50%">
-[[Image:Scatterplot.png|thumb|200px|Scatterplot View]]
+[[Image:Scatterplot.png|thumb|200px]]
 '''Plot'''
 :Displays all nodes in a scatterplot, which is particularly helpful if you want to explore analyze your data. Three drop down menus allow custom axis assignments.
 </td></tr><tr><td valign="top" width="50%">
-[[Image:Table.png|thumb|200px|The Table View]]
+[[Image:Table.png|thumb|200px]]
 '''Table'''
 :Comes in handy if your data is highly regular. It displays all nodes in a table with rows and columns. Different assignments can be chosen by clicking on the arrow in the right upper corner.
 </td><td valign="top" width="50%">
-[[Image:Explorer.png|thumb|200px|Explorer View]]
+[[Image:Explorer.png|thumb|200px]]
 '''Explorer'''

@@ Line 84: / Line 84: @@
 All XQuery files in the project directory will be parsed in the background. Buggy XQuery modules, and files importing these modules, will be marked red. With the text fields on top, you can interactively search for file names and contents.
-{{Mark|Updated with Version 9.3:}} If a directory contains a {{Code|.ignore}} file, its files and contents will be ignored.
+If a directory contains a {{Code|.ignore}} file, its files and contents will be ignored.
 =Input Bar=
@@ Line 227: / Line 227: @@
 ;Version 9.3
 * Updated: Project View: ignore directories with {{Code|.ignore}} file
 ;Version 9.1
 * Added: Project View, set XML document as context.
 ;Version 8.4
 * Added: highlighting of erroneous XQuery modules in the project view.
 ;Version 8.0
 * Updated: support for dark look and feels; support for JTatto library

@@ Line 42: / Line 42: @@
 The BaseX GUI is a great place for creating and managing your XML databases.
-To '''create a new database''', select ''Database'' → ''New'' from the menu and browse to an XML document of your choice. You can start with the {{Code|factbook.xml}} document, which contains statistical information on the worlds' countries. It is included in the {{Code|etc}} directory of our [http://basex.org/download full distributions] ( ZIP Package and Windows Installer) or can be downloaded [http://files.basex.org/xml/factbook.xml here] (1.3 MB). In the ''Create Database'' dialog, specify the path to your input file and the name of the new database. If you leave the input file field empty, an empty database will be created. Click the ''OK'' button to create the database.
+To '''create a new database''', select ''Database'' → ''New'' from the menu and browse to an XML document of your choice. You can start with the {{Code|factbook.xml}} document, which contains statistical information on the worlds' countries. It is included in the {{Code|etc}} directory of our [http://basex.org/download full distributions] ( ZIP Package and Windows Installer) or can be downloaded [https://files.basex.org/xml/factbook.xml here] (1.3 MB). In the ''Create Database'' dialog, specify the path to your input file and the name of the new database. If you leave the input file field empty, an empty database will be created. Click the ''OK'' button to create the database.
 '''Note:''' You can also use the GUI's [[Graphical_User_Interface#Editor|editor]] to create and edit your own XML document. Just specify it as input file for the creation of a new database after saving the document to disk.

@@ Line 210: / Line 210: @@
 <table>
    <tr>
-     <td>
+     <td valign="top">
 By default, the Look and Feel of your operating system will be used in the GUI.
 In the ''Preferences'' dialog, you can choose from additional window themes.