Changes

The This page is part of the [[Getting Started]] Section. BaseX homepage gives you comes with a [http://basex.org/products/gui visual impression] of the graphical user interface (GUI) of BaseXthat offers you great tools for managing,querying and visualizing your data and the [http://www.youtube.com/watch?v=xILHKGPGaJ4&hd=1 introductory video] presents some of the interactive features that the BaseX GUI provides. This small tutorial demonstrates how easy it is to perform simple XPath querieswrite complex applications in XQuery.

==Startup==First of all, please launch a GUI instance of BaseX. Depending on your operating system, double click on the '''BaseX GUI''' start icon or run the <code>basexgui</code> script. [[Startup#BaseX GUI|Follow this link]] for more information (or check out the additional [[Startup Options#BaseX GUI|command-line options]]).

Select * If you have installed BaseX on ''DatabaseWindows'' → ''New'' and browse to , click on the '''factbook.xmlBaseX GUI''' documenticon. This XML file contains statistical information on * Run one of the worlds' countries{{Code|[[Start_Scripts#Linux.2FMac:_basex|basexgui]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basexgui.bat]]}} scripts. It is included in * You can also double-click on the official releases of {{Code|BaseX.jar}} file (this way, and it can also no libraries will be [httpadded).* For developers: type in {{Code|mvn exec://files.java}} in the main directory of the {{Code|basex.org/xml/factbook.xml downloaded here]}} project.

Next, choose the ''OK'' button, and BaseX will create a database that you can visually exploreSome additional [[Command-Line_Options#GUI|command-line options]] are available.

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=  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:GUI-Header.png|600px]] The ''Status Bar'' is situated at the bottom 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'' panel with buttons for creating, opening, saving, searching, executing and debugging your files. [[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: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''. =Database Management= 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. '''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. To '''open, rename, copy or drop a database''', choose ''Database'' → ''Open & Manage...'' from the menu. Select one of the available databases on the left-hand side and click on one of the buttons on the right: ''Open'', ''Rename'', ''Copy'' or ''Drop''. To open a database, you can also double-click on the database name. Opening a database activates three more options in the ''Database'' menu: * The ''Properties'' item gives you access to a variety of database options and information:** Add resources and/or set parsing preferences.** Gain insights into element and attribute names, paths and other meta information.** 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. 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. [[File:GUI-Menu.png|600px]] =Editor= 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 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 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 for the currently selected string in your complete project.* Ctrl .: Jump to the next erroneous code in your project. If you right-click on an XML document in the ''Project'' view, the selected file will be parsed and bound to the context item: [[File:GUI-Context.png|600px]] ==Project View== The ''Project'' view is attached to the ''Editor'' panel. It displays all files of the current project directory in a tree structure. Files can be renamed and deleted by right-clicking on the files. The project directory can be changed as well; the most recent directories will be kept in the history. 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= 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:GUI-Input.png|600px]] The upcoming example queries can all be used with an instance of the <code>factbook</code> database: ==Find== In the '''Find''' mode, the input bar can be used to find single elements and texts in the currently opened database. The following syntax is supported: {| class="wikitable"!Query!Description|-|<code>city</code>|Find elements named {{Code|city}}, and texts containing this token.|-|<code>=India</code>|Find texts matching the exact string {{Code|India}}.|-|<code>~Cingdom</code>|Find texts equal or similar to the token {{Code|Cingdom}}.|-|<code>@id</code>|Find attributes named {{Code|id}} and attribute values containing this token.|-|<code>@=f0_119</code>|Find attribute values matching the exact string {{Code|f0_119}}.|-|<code>"European Chinese"</code>|Find texts containing the phrase {{Code|"European Chinese"}}.|-|<code>//city</code>|Leading slash: Interpret the input as XPath expression (see below).|} ==XQuery== In the '''XQuery''' mode, XPath and XQuery expressions can be entered in the input bar. To evaluate the following example queries, type them in the input bar and press Enter or click on the ''Run query'' button (green triangle) adjacent to the input bar: {| class="wikitable"!Query!Description|-|<code>//country</code>|Return all <code>country</code> elements.|-|<code>//country[name = "Switzerland"]</code>|Return the <code>country</code> element of "Switzerland".|-|<code>for $city in //city<br/>where $city/population > 1000000<br/>order by $city ascending<br/>return $city/name</code>|Return the names of all cities with a population larger than one million and order the results by the name of the city.|} ==Command== In the '''Command''' mode, BaseX [[Commands|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. =Visualizations=

<table cellpadding="0" cellspacing="010"><tr><td valign="top" width="4950%">[[Image:TextViewResult.jpgpng|thumb|Text View200px]];→ '''Result''' (''TextView''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="2%">&nbsp;</td><td valign="top" width="4950%">[[Image:MapViewInfoView.jpgpng|thumb|Map View200px]];→ ''Map'':This visualization represents all data in a TreeMap. All nodes of the XML document are represented as rectangles, filling the complete area. You can choose one of the following layout algorithms in the Menu ''Options'Info' → ''Map Layout('': Split, Strip, Squarified, Slice&Dice and Binary Layout.</td></tr><tr><td valign="top">[[Image:TreeView.jpg|thumb|Tree View]];→ ''Tree''menu):This visualization displays all XML nodes in a top down tree with edges and nodes. You can change some settings Helpful for analyzing the query plans of the Tree in the Menu ''Options'' → ''Tree Options''your XQuery expressions.</td><td valign="top" width="2%">&nbsp;</td><td valign="top" width="49%">[[Image:FolderView.jpg|thumb|Folder View]];→ ''Folder'':This visualization It also displays all nodes in a usual folder view.</td></tr><tr><td valign="top">[[Image:Scatterplot.jpg|thumb|Scatterplot View]];→ ''Plot'':This visualization displays all nodes in a scatterplot. There are drop down menus to configure information on the allocation compilation and evaluation of the Y- and X-axis.</td><td valign="top" width="2%">&nbsp;</td><td valign="top" width="49%">[[Image:TableView.jpg|thumb|The Table View]];→ ''Table'':This visualization displays all nodes in a table with rows and columnsqueries.</td></tr><tr><td valign="top">[[Image:ExplorerView.jpg|thumb|Explorer View]];→ ''Explorer'':With this visualization you can explore the contents of your database via drop-down menus, search fields and some sliders.</td><td valign="top" width="2%">&nbsp;</td><td valign="top" width="4950%">[[Image:InfoViewMap.png|thumb|Info View200px]];→ ''Info'':This visualization gives details on the execution of database commands and XQuery expressions.</td></tr></table>

'''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= Querying =="50%">[[Image:Tree.png|thumb|200px]]

Apart from the basic search facilities, BaseX offers far more sophisticated processing options to query your documents'''Tree''':Displays all XML nodes in a top-down tree with edges and nodes. Below are You can change some examples you might give a try. This guide is far from being a comprehensive XQuery reference, but might point you settings of the Tree in the right directionMenu ''Options'' → ''Tree Options''.</td></tr><tr><td valign="top" width="50%">[[Image:Folder.png|thumb|200px]]

To execute the following queries, enter them '''Folder''':Displays all nodes in an Explorer-like folder view. Nodes can be expanded or closed by clicking on the XQuery Panel and hit the PLAY buttonarrows.</td><td valign="top" width="50%">[[Image:Scatterplot.png|thumb|200px]]

XPath provides an easy facility to query your documents '''Plot''':Displays all nodes in a navigational manner. It scatter plot, which is the basic tool of all node-related operations that particularly helpful if you encounter when using XQuerywant to explore analyze your data. We will start with a trivial example and extend it to our needsThree dropdown menus allow custom axis assignments.</td></tr><tr><td valign="top" width="50%">[[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== Example"50%">[[Image: Find Countries ===Explorer.png|thumb|200px]]

'''Explorer''':Can be used to explore the contents of your database via drop-down menus, search fields and double sliders.<code/td> <//countrytr></codetable>

As an exampleIn the ''Options'' menu, <code>//country</code> is equivalent to <code>/descendantyou can change how queries are executed and visualized::country</code>.

=== Example* '''Real-time Execution''': Find Cities 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''': 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 Switzerland ===the visualizations and can be explicitly filtered with the 'Filter' button.

<codetable> //country[name <tr> <td valign= "Switzerlandtop"]</code>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.

To return all cities of The [http://www.jtattoo.net/ScreenShots.html JTattoo library] offers some morelook and feels. If you download and copy the resulting element node, JTattoo jar file into the query can be extended {{Code|lib}}directory provided by a trailing the ZIP and EXE distribution of BaseX,13 additional themes will get available. </td> <td>[[Image:defaultlaf.png|thumb|Default Look & Feel]]</td> <codetd>[[Image:hifilaf.png|thumb|HiFi Look & Feel]]</td> </citytr></codetable> path:

<code> //country[name = "Switzerland"]//city</code>Changelog=

For more information on BaseX, XQuery and XPath;Version 9.1* Added: Project View, we invite you to..set XML document as context.

* check out more [[Getting_Started|Documentation]], and;Version 8.4* have a look at the [httpAdded://www.w3schools.com/xquery/ highlighting of erroneous XQuery Tutorial at W3Schools]modules in the project view.

[[Category:Beginner]][[Category:GUI]];Version 8.0[[Category* Updated:XQuery]]support for dark look and feels; support for JTattoo library