Changes

This page is part of the [[Getting Started]] Section.The 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 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 queriesvisualizing your data and write complex applications in XQuery.

==Startup==

Select ''Database'' → ''New'' and browse to an XML document of your choice. As an example, the {{MonoSome additional [[Command-Line_Options#GUI|factbook.xml}} document, which contains statistical information on the worlds' countries, is included in the official releases of BaseX, and it can also be [http://files.basex.org/xml/factbook.xml downloaded herecommand-line options]]are available.

Next, choose It is worth mentioning that the ''OK'' button, standalone client must not be used if you perform parallel (concurrent) read and BaseX will create a database that you can visually explorewrite operations on your databases. See [[Startup#Concurrent Operations|Concurrent Operations]] for more details.

==Realtime Options=Introduction=

Via 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'' menuto set your preferences regarding real-time execution, colors, fonts, you can change the way how queries are executed and visualized:packages.

* Right below the menu bar, you can find the ''Buttons'Realtime Execution'bar and just below that the '': If realtime execution is enabled, your searches and queries will be executed with each key click and the results will be instantly shown.* Input Bar''. The 'Realtime Filtering'Buttons'': If enabledbar offers you a wide range of shortcuts, all mostly for menu options, such as managing databases and displaying views and visualizations will be limited to the actual results in realtime, but also for navigating through your data. If this feature is disabled, the query results are highlighted in the visualizations and can be ecplicitly filtered with With the [[Graphical_User_Interface#Input Bar|''Input Bar'Filter' button.[[Category:GUI]], you can query your data using three different kinds of query syntax.

The Keyword Search 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''Searchview, 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'' mode 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 inthe 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 combo box 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. This options allows for a simpleIt offers you three different modes to query your XML databases: '''Find''','''XQuery''' and '''Command'''. keyword[[Image:GUI-based search 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:

|<code>worldcity</code>|Find tags and texts containing elements named {{MonoCode|worldcity}}, and texts containing this token.

|<code>=worldIndia</code>|Find texts matching the exact matching text nodesstring {{Code|India}}.

|<code>=world~Cingdom</code>|Find text nodes texts equal or similar to the token {{MonoCode|worldCingdom}}.

|<code>@worldid</code>|Find attributes named {{Code|id}} and attribute valuescontaining this token.

|<code>@=worldf0_119</code>|Find exact attribute valuesmatching 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).

=== XPath/XQuery ===

Apart from In the basic search facilities'''XQuery''' mode, BaseX offers far more sophisticated processing options to query your documents. Below are some examples you might give a try. This guide is far from being a comprehensive XPath and XQuery reference, but might point you expressions can be entered in the right directioninput bar.

To execute evaluate the following example queries, enter type them in the XQuery Panel input bar and press ENTER Enter or click on the START ''Run query'' button.(green triangle) adjacent to the input bar:

XPath provides an easy facility to query your documents in a navigational manner. It is the basic tool of all node-related operations that you encounter when using XQuery. We will start with a trivial example and extend it to our needs.{| class="wikitable"!Query''' Example: Find Countries '''!Description|-|<pre class="brush:xquery"code>//country</precode> tells BaseX to look for |Return all <code>country</code> elements in the document. The query is introduced by two slashes |-|<code>//country[name = "Switzerland"]</code>, which trigger |Return the traversal <code>country</code> element of all document nodes"Switzerland". The queries {{Mono|-|<code>for $city in //city<br/>where $city/country}} andd {{Mono|population > 1000000<br/>order by $city ascending<br/descendant::country}} will >return $city/name</code>|Return the names of all cities with a population larger than one million and order the same resultsby the name of the city. ''' Example: Find Cities in Switzerland '''|}

<pre class="brush:xquery">//countryIn the '''Command''' mode, BaseX [[name = "Switzerland"Commands|Commands]]</pre>can be entered and executed. Just try the following examples:

To return all cities of the resulting element node, the query can be extended by a trailing * <code>INFO</code>: Returns system information.* <code>CREATE DB TEST</citycode>: Creates an empty database named "TEST".* <code>LIST</code> path:Lists all databases.

<pre class="brush:xquery">//country[name = "Switzerland"]//city</pre> == Visualizations ==

<table cellpadding="0" cellspacing="010"><tr><td valign="top" width="4950%">[[Image:TextViewResult.jpgpng|thumb|Text View200px]]

'''TextResult'''(''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="250%">&nbsp;[[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="4950%">[[Image:MapViewMap.jpgpng|thumb|Map View200px]]

:This visualization represents 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:TreeViewTree.jpgpng|thumb|Tree View200px]]

:This visualization displays 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><td valign="top" width="2%"/tr>&nbsp;</tdtr><td valign="top" width="4950%">[[Image:FolderViewFolder.jpgpng|thumb|Folder View200px]]

:This visualization displays 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.jpgpng|thumb|Scatterplot View200px]]

:This visualization displays 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><td valign="top" width="2%"/tr>&nbsp;</tdtr><td valign="top" width="4950%">[[Image:TableViewTable.jpgpng|thumb|The Table View200px]]

:This visualization comes 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:ExplorerViewExplorer.jpgpng|thumb|Explorer View200px]]

:With this visualization you can Can be used to explore the contents of your database via drop-down menus, search fields and double sliders.</td><td valign="top" width="2%"/tr>&nbsp;</td><td valign="top" width="49%"table>[[Image:InfoView.png|thumb|Info View]]

=Real-time Options= In the ''Options'Info'menu, you can change how queries are executed and visualized: * '''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.* '''Real-time Filtering''':This view If enabled, all visualizations will be limited to the actual results in real-time. If this feature is helpful for analyzing disabled, the query plans results are highlighted in the visualizations and can be explicitly filtered with the 'Filter' button. =Look and Feel= <table> <tr> <td valign="top">By default, the Look and Feel of your XQuery expressionsoperating system will be used in the GUI.In the ''Preferences'' dialog, you can choose from additional window themes. The [http://www.jtattoo. It also displays information on net/ScreenShots.html JTattoo library] offers some morelook and feels. If you download and copy the JTattoo jar file into the {{Code|lib}}directory provided by the compilation ZIP and evaluation EXE distribution of queriesBaseX,13 additional themes will get available. </td> <td>[[Image:defaultlaf.png|thumb|Default Look & Feel]]</td> <td>[[Image:hifilaf.png|thumb|HiFi Look & Feel]]</td> </tr></table> =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