Changes

Jump to navigation Jump to search
1,914 bytes added ,  17:00, 16 May 2022
no edit summary
This page is part of the [[Getting Started]] Section. In addition to its standalone console mode, BaseX comes with its own a graphical user interface which that offers you great tools for managing, querying and visualising visualizing your (XML) dataand write complex applications in XQuery.
=Startup=
Depending on your operating system, you The graphical user interface can launch a GUI instance of BaseX by double-clicking on the '''BaseX GUI''' start icon (Windows only) or running the <code>basexgui</code> script. Additional startup options are listed in the [[Startup#Graphical User Interface|Startup]] article.be started as follows:
The * If you have installed BaseX on ''Windows'', click on the '''BaseX GUI''' icon.* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basexgui]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basexgui.bat]]}} scripts.* You can also double-click on the {{Code|BaseX .jar}} file (this way, no libraries will be added).* For developers: type in {{Code|mvn exec:java}} in the main directory of the {{Code|basex}} project. Some additional [[Command-Line_Options#GUI |command-line options]] are available. It is divided into 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= 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 number 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 can be displayed or hidden using will help you to understand your data even better. Use the ''ViewOptions'' menuto set your preferences regarding real-time execution, colors, fonts, and packages. On the upper border,  [[File:Basex-menu-bar.png|600px]] 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]]
The ''Status Bar'' is situated at the lower borderbottom of the BaseX window.
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'' view panel with buttons for creating, opening, saving, searching, executing and debugging your files.
[[File:Basex-editor-panel.png]]
In addition to that, there are the ''Result'' view, which displays the content output of the currently open queries and database or the results of queries, operations and the ''Info'' view, which shows you information about the database or processes and query execution.
[[File:Basex-result-info-panel.png]]
 
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''.
=Database Management=
The BaseX GUI is a great place for creating and administrating 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 [httphttps://basex.org/download full distributions] ( ZIP Package and Windows Installer) or can be downloaded [httphttps://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.
** 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 An open databases are 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.
 
[[File:Basex-buttons-bar-database.png]]
=Editor=
BaseX's The built-in editor of BaseX is a powerful tool. You can create and which allows you to edit text documents (XML, JSON and any other kind of text document, JavaScript, …), write and run XQuery files and modules, assemble [[Commands#Basics|Command Scripts]] and develop [[RESTXQ]] applications:
* The editor offers '''Syntax highlighting''' for XML, XQuery, JSON and JavaScript files.
* XQuery, XML and JSON files will be '''parsed''' in realtime 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).
* Ctrl .: Jump to the next erroneous code in your project.
{{Mark|Introduced with Version 9.1}}: 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]]
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.
 
If a directory contains a {{Code|.ignore}} file, its files and contents will be ignored.
=Input Bar=
On top of the main window, you can find the 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]]
In the '''XQuery''' mode, XPath and XQuery expressions can be entered in the input bar.
To evaluate the following example queries: enter , type them in the input bar, and press ENTER Enter or click on the START ''Run query'' button(green triangle) adjacent to the input bar:
{| class="wikitable"
==Command==
In the '''Command''' mode, BaseX [[Commands|BaseX Commands]] can be entered and executed. Just try the following examples:
* <code>INFO</code>: Returns system information.
* <code>CREATE DB TEST</code>: Creates an empty database named "TEST".
* <code>LIST</code>: Lists all databases.
 
=Realtime Options=
 
Via 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.
* '''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.
=Visualizations=
which help you to explore your XML data instances from different perspectives:
<table cellpadding="0" cellspacing="10"><tr><td valign="top" width="50%">[[Image:Result.png|thumb|Text View200px]]
'''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'' 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|Map View200px]]
'''Map'''
:Displays all data in a [httphttps://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></tr><tr><td valign="top" width="50%">[[Image:Tree.png|thumb|Tree View200px]]
'''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|Folder View200px]]
'''Folder'''
:Displays all nodes in an Explorer-like folder view. Nodes can be expanded or closed by clicking on the arrows.
</td></tr><tr><td valign="top" width="50%">[[Image:Scatterplot.png|thumb|Scatterplot View200px]]
'''Plot'''
:Displays all nodes in a scatterplotscatter plot, which is particularly helpful if you want to explore analyze your data. Three drop down dropdown menus allow custom axis assignments.</td></tr><tr><td valign="top" width="50%">[[Image:Table.png|thumb|The Table View200px]]
'''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></tr><tr><td valign="top" width="50%">[[Image:Explorer.png|thumb|Explorer View200px]]
'''Explorer'''
:Can be used to explore the contents of your database via drop-down menus, search fields and double sliders.
</td><td valign="top"/tr></table>[[Image:InfoView.png|thumb|Info View]]=Real-time Options=
In the ''Options'' menu, you can change how queries are executed and visualized: * '''InfoReal-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.* '''Real-time Filtering''':Helpful for analyzing If enabled, all visualizations will be limited to the actual results in real-time. If this feature is disabled, the query plans of your XQuery expressions. It also displays information on results are highlighted in the compilation visualizations and evaluation of queriescan be explicitly filtered with the 'Filter' button.</td></tr></table>
=Look and FeelsFeel=
<table>
<tr>
<tdvalign="top">
By default, the Look and Feel of your operating system will be used in the GUI.
In the ''Preferences'' dialog, you can choose among some more from additional window themes.
The [http://www.jtattoo.net/ScreenShots.html JTattoo library] offers some more
look and feels. If you download and copy the JTattoo jar file into the {{Code|lib}}
directory provided by the ZIP and EXE distribution of BaseX,
13 additional looks and feels themes will get available.
</td>
<td>[[Image:defaultlaf.png|thumb|Default Look & Feel]]</td>
=Changelog=
 
;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 JTattoo library
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu