Changes

The BaseX homepage gives you a [http://basex.org/products/gui visual impression] of the graphical user interface (GUI) of BaseX,and the an [http://www.youtube.com/watch?v=xILHKGPGaJ4&hd=1 introductory video] is available, which presents some of the its interactive features that the BaseX GUI provides. This small tutorial demonstrates how easy it is to perform simple XPath queries.

==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. Beside that, some more [[Startup#BaseX GUI|startup options]] are available.

== Create Database ==

Select ''Database'' → ''New'' and browse to an XML document of your choice. As an example, you can start with the {{MonoCode|factbook.xml}} document, which contains statistical information on the worlds' countries. It is included in our official releases and can also be [http://files.basex.org/xml/factbook.xml downloaded] (1.3 MB). If you type nothing in the input field, an empty database will be created. Next, choose the ''OK'' button, and BaseX will create a database that you can visually explore and query.

NextIf no XML document is available, choose the ''OK'' button[[#Text Editor|Text Editor]] can also be used to create an initial XML document. After saving the entered XML document to harddisk, and BaseX will create a it can be supplied as database that you can visually exploreinput in the above dialog.

==Realtime Options=Input Bar=

Via On top of the main window, you can find an input bar. The attached dropdown menu provides three modes: ''Options'Find''' menu, you can change the way how queries are executed '''XQuery''' and visualized'''Command''':

* '''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 ecplicitly filtered with the 'Filter' button.[[CategoryImage:GUIInputBar.png|Input Bar]]

=== Keyword Search =Find==

The Keyword Search can be executed in In the '''SearchFind''' mode in, the combo box of the main window. This options allows for a simple,keyword-based search 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>~worldCing</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>"united worldEuropean Chinese"</code>|Find tags and texts containing the phrase {{MonoCode|"united worldEuropean 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 them in the XQuery Panel input bar, and press ENTER or click on the START button: {| 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.|}

In the ''' Example: Find Countries Command'''mode, [[Commands|BaseX Commands]] can be entered and executed. Just try the following examples:

* <pre class=code>INFO</code>: Returns system information.* <code>CREATE DB TEST</code>: Creates an empty database named "brush:xqueryTEST".* <code>//countryLIST</precode>: Lists all databases.

''' ExampleThe powerful text editor can be used to write and edit [[XQuery]] code (simple queries, modules), XML documents, [[Commands#Basics|Command Scripts]], and any other textual files: Find Cities in Switzerland '''

The following query uses a * XQuery and command scripts can be '''predicateexecuted''' <code>[by clicking on the green triangle.* XQuery, XML and JavaScript will be '''syntax highlighted'''.* XQuery and XML will automatically '''parsed''' with each key click, and '''errors''' will be highlighted.]</code> to filter all <code>country</code> nodes which have a <code>name</code> child, the string value of which is "Switzerland":

<pre class="brush:xquery">//countryNumerous [name = "Switzerland"[Shortcuts|keyboard shortcuts]]</pre>are available to speed up editing and debugging.

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-clicks on the files. The project directory can be changed by clicking on the button with the three dots <pre class="brush:xquery"code>//country[name = "Switzerland"]//city...</precode>in the upper left corner of the project view panel.

Erroneous XQuery modules, and all queries importing these modules, will be highlighted. Highlighting can be disabled in the GUI preferences dialog. =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 ==

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

'''TextResult'''

</td><td valign="top" width="2%">&nbsp;</td><td valign="top" width="49%">[[Image:MapViewMap.jpgpng|thumb|Map View]]

:This visualization represents Displays all data in a [http://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''.

[[Image:TreeViewTree.jpgpng|thumb|Tree View]]

: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%">&nbsp;</td><td valign="top" width="49%">[[Image:FolderViewFolder.jpgpng|thumb|Folder View]]

:This visualization displays Displays all nodes in an Explorer-like folder view. Nodes can be expanded or closed by clicking on the arrows.

[[Image:Scatterplot.jpgpng|thumb|Scatterplot View]]

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

: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.

[[Image:ExplorerViewExplorer.jpgpng|thumb|Explorer View]]

: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%">&nbsp;</td><td valign="top" width="49%">

:This view is helpful Helpful for analyzing the query plans of your XQuery expressions. It also displays information on the compilation and evaluation of queries.

=Look and Feels= What <table> <tr> <td>By default, the Look and Feel of your operating system will be used in the GUI.In the 's Next? 'Preferences'' dialog, you can choose among some more window themes. The [http://www.jtattoo.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 ZIP and EXE distribution of BaseX,13 additional looks and feels 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= ;Version 8.4

For more information on BaseX, * Added: highlighting of erroneous XQuery and XPath, we invite you to..modules in the project view.

* check out more [[Getting_Started|Documentation]], and* have a look at the [http://www.w3schools.com/xquery/ XQuery Tutorial at W3Schools];Version 8.0

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