Difference between revisions of "Developing"

From BaseX Documentation
Jump to navigation Jump to search
 
(101 intermediate revisions by 6 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 provides useful information for developers. Here you can find information
 
It provides useful information for developers. Here you can find information
 
on various alternatives to integrate BaseX into your own project.
 
on various alternatives to integrate BaseX into your own project.
  
==Source Code and Integration==
+
<table><tr><td width='50%' valign='top'>
*[[Subversion Repository]]: Checkout the projects
+
;Integrate & Contribute
*[[Integrate]]: Integrate BaseX into your IDE
+
* [[Developing with Eclipse|Eclipse]]: Compile and run BaseX from within Eclipse
*[[Maven]]: Facilitate building our projects from source
+
* [[Git]]: Learn how to work with Git
 +
* [[Maven]]: Embed BaseX into your own projects
 +
* [[Releases]]: Official releases, snapshots, old versions
 +
* [[Translations]]: Contribute a new translation to BaseX!
  
==Coding Examples==
+
;Web Technology
*[[Code Examples]]: Examples for developing with the BaseX, JAX-RX (REST), XML:DB, and XQJ APIs
+
* [[RESTXQ]]: Write web services with XQuery
 +
* [[REST]]: Access and update databases via HTTP requests
 +
* [[WebDAV]]: Access databases from your filesystem
 +
</td><td width='50%' valign='top'>
  
==Client-Server Communication==
+
;APIs
*[[Language Bindings]]: Communicate with the BaseX server with bindings in different languages
+
* [[Clients]]: Communicate with BaseX using C#, PHP, Python, Perl, C, ...
*[[JAX-RX API]]: Details on the http-based JAX-RX (REST) API
+
* [[Java Examples]]: Code examples for developing with BaseX
 +
* [http://xqj.net/basex XQJ API]: Closed source, implemented by Charles Foster (restricted to XQuery 3.0)
 +
* [https://github.com/fancellu/xqs XQuery for Scala API], based on XQJ and written by Dino Fancellu
  
==JavaDoc==
+
;Extensions
The project's [http://docs.basex.org/javadoc JavaDoc] can be reviewed for further details.
+
* [[YAJSW|Service/daemon]]: Install BaseX server as a service
 +
* [[Android]]: Running BaseX with Android
 +
</td></tr>
 +
</table>
  
[[Category:Developer]]
+
;Code, Questions, Bugs
 +
* The [https://github.com/basexdb/basex Source Code] is available on GitHub.
 +
* For questions, bug reports and feature requests, please write to our [https://basex.org/open-source/ mailing list]
 +
* The [https://github.com/basexdb/basex/issues Issue Tracker] contains confirmed bugs and feature requests.
 +
__NOTOC__

Latest revision as of 11:18, 28 July 2022

This page is one of the Main Sections of the documentation. It provides useful information for developers. Here you can find information on various alternatives to integrate BaseX into your own project.

Integrate & Contribute
  • Eclipse: Compile and run BaseX from within Eclipse
  • Git: Learn how to work with Git
  • Maven: Embed BaseX into your own projects
  • Releases: Official releases, snapshots, old versions
  • Translations: Contribute a new translation to BaseX!
Web Technology
  • RESTXQ: Write web services with XQuery
  • REST: Access and update databases via HTTP requests
  • WebDAV: Access databases from your filesystem
APIs
  • Clients: Communicate with BaseX using C#, PHP, Python, Perl, C, ...
  • Java Examples: Code examples for developing with BaseX
  • XQJ API: Closed source, implemented by Charles Foster (restricted to XQuery 3.0)
  • XQuery for Scala API, based on XQJ and written by Dino Fancellu
Extensions
Code, Questions, Bugs
  • The Source Code is available on GitHub.
  • For questions, bug reports and feature requests, please write to our mailing list
  • The Issue Tracker contains confirmed bugs and feature requests.