Changes

* First of all, download the latest version of [http://cms.basex.org/?id=44 BaseX].* Next, download an <span classStartup="caps">XML</span> document: [http://files.basex.org/xml/factbook.xml factbook.xml] (1.2 MB) contains statistical information on the worlds' countries. This file is also included in the Windows and ZIP distribution of BaseX.

Select ''Database'' →’ ''New'' and browse to the factbook.xml documentSome additional [[Command-Line_Options#GUI|command-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.<br /> The See [http://www.youtube.com/watch?v=xILHKGPGaJ4&hd=1 introductory video[Startup#Concurrent Operations|Concurrent Operations]] gives you a glimpse of some features that the BaseX GUI providesfor more details.

Apart from Right below the basic search facilitiesmenu bar, BaseX you can find the ''Buttons'' bar and just below that the ''Input Bar''. The ''Buttons'' bar offers far more sophisticated processing you a wide range of shortcuts, mostly for menu options to query , such as managing databases and displaying views and visualizations, but also for navigating through your documentsdata. Below are some examples you might give a try. This guide is far from being a comprehensive XQuery referenceWith the [[Graphical_User_Interface#Input Bar|''Input Bar'']], but might point you in the right directioncan query your data using three different kinds of query syntax.

To execute the following queries, enter them in the XQuery Panel and hit the PLAY button[[File:GUI-Header.png|600px]]

XPath provides an easy facility to query your documents in The BaseX [[Graphical_User_Interface#Editor|editor]] consists of the ''Project'' view, a navigational manner. It is file browser with optional input fields for searching files, and the basic tool of all node-related operations that you encounter when using XQuery. We will start actual ''Editor'' panel with a trivial example buttons for creating, opening, saving, searching, executing and extend it to our needsdebugging your files.

tells BaseX to look for all <code>country</code> elements in the document. The query is introduced by two slashes <code>//</code>, which trigger the traversal of all document nodes. XPath knows several '''location steps''' that determine which nodes to consider next for evaluation[[File:GUI-ResultInfo.png|600px]]

As an exampleTo gain further insights into your data, <code>//country</code> is equivalent you can choose to <code>/descendant::country</code>display various [[Graphical_User_Interface#Visualizations|visualizations]] such as ''Map'', ''Tree'', ''Folder'', ''Plot'', ''Table'' and ''Explorer''.

==== Find the Names of all Countries ===Database Management=

This query returns To '''create a new database''', select ''Database'' → ''New'' from the <code>name<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:/code> children of all <code>country</code> elementsbasex. The result looks as followsorg/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.

<code> <name>Albania</name><br /> <name>Andorra</name><br /> '''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..</code>

==== Find To '''open, rename, copy or drop a database''', choose ''Database'' → ''Open & Manage...'' from the Names menu. Select one of all Cities in Switzerland ====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.

The following query uses Opening a database activates three more options in the ''Database'predicate''' <code>[...]</code> to filter all <code>country</code> nodes which have a <code>name</code> child, the string value of which is "Switzerland"menu:

<code> * The ''Properties'' item gives you access to a variety of database options and information:** Add resources and//country[name = "Switzerland"]</code>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.

To return all cities of '''Note:''' You can also access the resulting element nodemenu options ''New'', ''Open & Manage'', the query can be extended by a trailing <code>//city</code> path:''Properties'' and ''Close'' from BaseX's Buttons bar.

<code> //country[name = "Switzerland"[File:GUI-Menu.png|600px]]//city</code>

For more information on BaseX* The editor offers native '''syntax highlighting''' for XQuery, XML, JSON and JavaScript.* XQuery , XML and JSON files will be '''parsed''' in real time and XPath, we invite you to.'''errors''' will be highlighted.* XQuery code and command scripts can be '''executed''' (via Ctrl Enter or by clicking on the green triangle).

* check out our Numerous [[DocumentationShortcuts|keyboard shortcuts]], are available to speed up editing and* have a look at the [httpdebugging. Some examples://www.w3schools.com/xquery/ XQuery Tutorial at W3Schools].

* 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: [[CategoryFile:BeginnerGUI-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 [[CategoryCommands|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= The BaseX GUIoffers various 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|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%">[[CategoryImage:InfoView.png|thumb|200px]] '''Info''' (''View'' menu):Helpful for analyzing the query plans of your XQueryexpressions. 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''':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''':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''':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]] '''Plot''':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]] '''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''':Can be used to explore the contents of your database via drop-down menus, search fields and double sliders.</td></tr></table> =Real-time Options= In the ''Options'' 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''': 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= <table> <tr> <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. 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 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= ;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 JTattoo library