Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
Depending The graphical user interface can be started as follows: * If you have installed BaseX on your operating system''Windows'', you can launch a GUI instance of BaseX by double-clicking click on the '''BaseX GUI''' start 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 (Windows onlythis way, no libraries will be added) or running .* For developers: type in {{Code|mvn exec:java}} in the main directory of the <code>basexgui</code> script{{Code|basex}} project. Additional startup Some additional [[Command-Line_Options#GUI|command-line options ]] are listed in available. Please note that the standalone client must not be used if you perform parallel (concurrent) read and write operations on your databases. See [[Startup#Graphical User InterfaceConcurrent Operations|StartupConcurrent Operations]] articlefor more details. =Introduction=
BaseX's The built-in editor of BaseX is a powerful tool which allows you to create and 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:
{{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:
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 marvellous tools for managing, querying and visualizing your (XML) dataand write complex applications in XQuery.
=Startup=
The BaseX GUI window is divided into various bars and panels.
=Editor=
* The editor offers '''Syntax highlighting''' for XML, XQuery, JSON and JavaScript files.
* Ctrl .: Jump to the next erroneous code in your project.
[[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.
{{Mark|Updated with Version 9.3:}} If a directory contains a {{Code|.ignore}} file, its files and contents will be ignored.
=Input Bar=
<table cellpadding="0" cellspacing="10"><tr><td valign="top" width="50%">
[[Image:Result.png|thumb|200px|Result View]]
'''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]]
'''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|200px|Map View]]
'''Map'''
: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''.
</td><td valign="top" width="50%">
[[Image:Tree.png|thumb|200px|Tree View]]
'''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 View]]
'''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|Scatterplot View]]
'''Plot'''
: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></tr><tr><td valign="top" width="50%">
[[Image:Table.png|thumb|200px|The Table View]]
'''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 View]]
'''Explorer'''
<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 from additional window themes.
=Changelog=
;Version 9.3
* Updated: Project View: ignore directories with {{Code|.ignore}} file
;Version 9.1
