Difference between revisions of "Getting Started"

From BaseX Documentation
Jump to navigation Jump to search
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This page is one of the [[Main Page|Main Sections]] of the documentation.
+
This page is one of the [[Main Page|Main Sections]] of the documentation. It gives you a brief introduction on how to start, run, and use BaseX. After you have set up BaseX, we suggest that you should start with the [[Graphical User Interface]].
It gives a quick introduction on how to start, run, and use BaseX.
 
  
 
=Overview=
 
=Overview=
Line 7: Line 6:
  
 
* [[Startup]]: How to get BaseX running
 
* [[Startup]]: How to get BaseX running
* [[Command-Line Options]]
 
 
;User Interfaces
 
 
 
* [[Graphical User Interface]] (see available [[Shortcuts]])
 
* [[Graphical User Interface]] (see available [[Shortcuts]])
 +
* [[Command-Line Client]]: Use BaseX in your bash
 
* [[Database Server]]: The client/server architecture
 
* [[Database Server]]: The client/server architecture
* [[Standalone Mode]]: The comand-line interface
 
 
* [[Web Application]]: The HTTP server
 
* [[Web Application]]: The HTTP server
 
* [[DBA]]: Browser-based database administration
 
* [[DBA]]: Browser-based database administration
 +
 +
;Command Line
 +
 +
* [[Command-Line Options]]
 +
* [[Start Scripts]]
 +
 
</div><div style="float:left; width:4%;">&nbsp;
 
</div><div style="float:left; width:4%;">&nbsp;
 
</div><div style="float:left; width:48%;">
 
</div><div style="float:left; width:48%;">
Line 22: Line 23:
  
 
* [[Databases]]: How databases are created, populated and deleted
 
* [[Databases]]: How databases are created, populated and deleted
* [[Parsers]]: How different input formats can be converted to XML
 
 
* [[Commands]]: Full overview of all database commands
 
* [[Commands]]: Full overview of all database commands
 
* [[Options]]: Listing of all database options
 
* [[Options]]: Listing of all database options
 +
* [[Configuration]]: BaseX start files and directories
  
;Integration
+
;Editing XML and XQuery Files
  
 +
We strongly encourage you to use the [[Graphical_User_Interface#Editor|BaseX Editor]] to run your queries and edit your XML data.<br/>
 
* [[Integrating oXygen]]
 
* [[Integrating oXygen]]
 +
* [[Integrating Eclipse]]
 
* [[Integrating IntelliJ IDEA]]
 
* [[Integrating IntelliJ IDEA]]
* [[Integrating Eclipse]]
+
</div>
<br/></div>
 
  
 
<div style="float:left; width:100%;">
 
<div style="float:left; width:100%;">
Line 41: Line 43:
 
'''BaseX: Introduction'''
 
'''BaseX: Introduction'''
  
* BaseX for Dummies. Written by Paul Swennenhuis:<br/>[http://www.swennenhuis.nl/basexfordummies/BaseX_for_dummies.pdf Part I], [http://www.swennenhuis.nl/basexfordummies/basexfordummies.zip Part I (files)], [http://www.swennenhuis.nl/basexfordummies/BaseX_for_dummies_part_2.pdf Part II].
+
* Tamara Marnell: [https://files.basex.org/publications/tutorials/BaseX%20for%20Newbies.pdf BaseX for Newbies]
* [http://www.ffzg.unizg.hr/klafil/dokuwiki/doku.php/z:basex-adv BaseX Adventures]. Written by Neven Jovanović.
+
* Paul Swennenhuis: BaseX for Dummies: [https://www.swennenhuis.nl/basexfordummies/BaseX_for_dummies.pdf Part I], [https://www.swennenhuis.nl/basexfordummies/basexfordummies.zip Part I (files)], [https://www.swennenhuis.nl/basexfordummies/BaseX_for_dummies_part_2.pdf Part II]
* [http://www.learndb.com/databases/basex-tutorial-for-using-an-xml-native-database-management-system Tutorial]. Written by Imed Bouchrika.
+
* Neven Jovanović: [http://www.ffzg.unizg.hr/klafil/dokuwiki/doku.php/z:basex-adv BaseX Adventures]
* [http://files.basex.org/publications/dummies/XQuery%20pour%20les%20Humanit%e9s%20Num%e9riques.pdf XQuery pour les Humanités Numériques]. Written by Farid Djaïdja (French).
+
* Imed Bouchrika: [https://www.learndb.com/databases/basex-tutorial-for-using-an-xml-native-database-management-system Tutorial. Using a native XMLDBS]
 +
* Farid Djaïdja: [https://files.basex.org/publications/tutorials/XQuery%20pour%20les%20Humanit%e9s%20Num%e9riques.pdf XQuery pour les Humanités Numériques] (French)
  
 
</div><div style="float:left; width:4%;">&nbsp;
 
</div><div style="float:left; width:4%;">&nbsp;
Line 50: Line 53:
 
'''XML and XQuery'''
 
'''XML and XQuery'''
  
* [http://phobos103.inf.uni-konstanz.de/xml15/ XML Technologies]. Our university course on XML, XPath, XQuery, XSLT, Validation, Databases, etc.
+
* [https://files.basex.org/.xml15/ XML Technologies]. University course on XML, XPath, XQuery, XSLT, Validation, Databases, etc.
* [http://w3schools.com/xquery/default.asp XQuery Tutorial]. From W3 Schools.
+
* [https://www.progress.com/xquery/resources/tutorials/learning-xquery/xquery---a-guided-tour XQuery: A Guided Tour]. From the book "XQuery from the Experts".
* [http://www.progress.com/xquery/resources/tutorials/learning-xquery/xquery---a-guided-tour XQuery: A Guided Tour]. From the book "XQuery from the Experts".
 
 
* [https://github.com/XQueryInstitute/Course-Materials/tree/master/exercises XQuery Summer Institute]. Exercises and Answers.
 
* [https://github.com/XQueryInstitute/Course-Materials/tree/master/exercises XQuery Summer Institute]. Exercises and Answers.
 +
* [https://www.w3schools.com/xml/xquery_intro.asp W3 Schools XQuery Tutorial]. Not affiliated with W3C.
 
</div>
 
</div>
 
<div style="float:left; width:100%;">
 
<div style="float:left; width:100%;">
Line 59: Line 62:
 
'''BaseX: Talks, Questions'''
 
'''BaseX: Talks, Questions'''
  
* [http://files.basex.org/publications/xmlprague/ Our Annual User Meetings]. Slides and videos.
 
 
* [https://mailman.uni-konstanz.de/mailman/listinfo/basex-talk Our Mailing List]. Join and contribute.
 
* [https://mailman.uni-konstanz.de/mailman/listinfo/basex-talk Our Mailing List]. Join and contribute.
* [https://github.com/basexdb/basex/issues GitHub Issue Tracker]. Please use our mailing list before entering new issues.
+
* [https://stackoverflow.com/questions/tagged/basex Stack Overflow]. Questions on {{Code|basex}}.
* [http://stackoverflow.com/questions/tagged/basex Stack Overflow]. Questions on {{Code|basex}}.
+
* [https://github.com/basexdb/basex/issues GitHub Issue Tracker]. Confirmed bugs and feature requests.
 +
* [https://files.basex.org/publications/xmlprague/ XML Prague User Meetings]. Slides and videos.
 
</div>
 
</div>
 
__NOTOC__
 
__NOTOC__

Revision as of 16:57, 16 May 2022

This page is one of the Main Sections of the documentation. It gives you a brief introduction on how to start, run, and use BaseX. After you have set up BaseX, we suggest that you should start with the Graphical User Interface.

Overview

First Steps
Command Line
 
General Info
  • Databases: How databases are created, populated and deleted
  • Commands: Full overview of all database commands
  • Options: Listing of all database options
  • Configuration: BaseX start files and directories
Editing XML and XQuery Files

We strongly encourage you to use the BaseX Editor to run your queries and edit your XML data.

Tutorials and Slides

BaseX: Introduction

 

XML and XQuery

BaseX: Talks, Questions