Changes

Jump to navigation Jump to search
1,134 bytes added ,  16:41, 27 February 2020
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 visualising visualizing your (XML) dataand write complex applications in XQuery.
=Startup=
Depending on your operating system, you The graphical user interface can launch a GUI instance of BaseX by double-clicking on the '''BaseX GUI''' start icon (Windows only) or running the <code>basexgui</code> script. Additional startup options are listed in the [[Startup#Graphical User Interface|Startup]] article.be started as follows:
All important features * If you have installed BaseX on ''Windows'', click on the '''BaseX GUI''' 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 (this way, no libraries will be added).* For developers: type in {{Code|mvn exec:java}} in the main directory of the {{Code|basex}} project. Some additional [[Command-Line_Options#GUI can |command-line options]] are available. Please note that the standalone client must not be accessed from used if you perform parallel (concurrent) read and write operations on your databases. See [[Startup#Concurrent Operations|Concurrent Operations]] for more details. =Introduction= The BaseX GUI window is divided into various bars and panels. At the top of the BaseX window, the menu barresides. It houses all important features of the BaseX GUI. With Use the ''Database'' menu, you can to [[Graphical_User_Interface#Database Management|create and manage your XML databases]]. The ''Editor'' menu offers gives you access to a variety of tools and options for working with files. Toggle between various The ''ViewsView'' menu lets you toggle between the bars and panels described below. The ''VizualizationsVizualization'' menu offers you a comprehensive set of data representations that will help you to edit and explore understand your data or set further even better. Use the ''Options'' menu to set your preferences regarding realtime execution, colors, fonts and packages.
[[File:Basex-menu-bar.png|600px]]
The BaseX GUI window is divided into a number of additional bars and panels that can be displayed or hidden using the ''View'' or ''Visualization'' menu. On the upper border, right 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:Basex-buttons-input-bar.png]]
The ''Status Bar'' is situated at the lower border 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:Basex-editor-panel.png]]
In addition to that, there are the ''Result'' view, which displays the output of queries and database operations, and the ''Info'' view, which shows you information about database processes and query execution.
[[File:Basex-result-info-panel.png]]
You can also toggle between ''Editor'', ''Result'' and ''Info'' view using the ''Buttons'' bar.   To gain further insights into your data, you can choose from to display various [[Graphical_User_Interface#Visualizations|visualizations ]] such as ''Map'', ''Tree'', ''Folder'', ''Plot'', ''Table'' and ''Explorer''.
=Database Management=
'''Note:''' You can also access the menu options ''New'', ''Open & Manage'', ''Properties'' and ''Close'' from BaseX's Buttons bar.
 
[[File:Basex-buttons-bar-database.png]]
=Editor=
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:
* The editor offers '''Syntax highlighting''' for XML, XQuery, JSON and JavaScript files.
* Ctrl .: Jump to the next erroneous code in your project.
{{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:
[[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
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu