Difference between revisions of "Developing"

From BaseX Documentation
Jump to navigation Jump to search
(48 intermediate revisions by 4 users not shown)
Line 3: Line 3:
 
on various alternatives to integrate BaseX into your own project.
 
on various alternatives to integrate BaseX into your own project.
  
==Source Code and Integration==
+
<div style="float:left; width:48%;">
* [[Integrate]]: Integrate BaseX into your IDE
+
;Integrate & Contribute
 +
* [[Developing with Eclipse|Eclipse]]: Compile and run BaseX from within Eclipse
 
* [[Git]]: Learn how to work with Git
 
* [[Git]]: Learn how to work with Git
* [[Maven]]: Embed BaseX into your own projects, or compile a development version of BaseX yourself
+
* [[Maven]]: Embed BaseX into your own projects
* [[Releases]]: Learn more about the locations where you find our releases, snapshots, and more
+
* [[Releases]]: Official releases, snapshots, old versions
* [[Translations]]: Contribute a new translation to BaseX
+
* [[Translations]]: Contribute a new translation to BaseX!
  
==HTTP Services==
+
;Project (Code, Features, Questions)
* [[REST]]: Details on the REST API
+
* The [https://github.com/basexdb/basex Source Code] can be browsed online
* [[RESTXQ]]: Details on the new RESTXQ API (introduced with {{Version|7.2}})
+
* The [https://github.com/basexdb/basex/issues Issue Tracker] contains feature requests and bug reports
* [[WebDAV]]: Details on the WebDAV Protocol
+
* For questions on the project, please write to our [http://basex.org/open-source/ mailing list]
  
==Client APIs==
+
</div><div style="float:left; width:4%;">&nbsp;
* [[Clients]]: Communicate with the BaseX server from different programming languages (C#, PHP, Python, Perl, C, etc.)
+
</div><div style="float:left; width:48%;">
* [[Java Examples]]: Code examples for developing with the BaseX, REST, XML:DB, and XQJ APIs
 
* [[PHP Example]]: PHP example for connecting to a database server
 
  
==JavaDoc==
+
;Web Technology
The project's [http://docs.basex.org/javadoc JavaDoc] can be explored online.
+
* [[RESTXQ]]: Write web services with XQuery
 +
* [[REST]]: Access and update databases via HTTP requests
 +
* [[WebDAV]]: Access databases from your filesystem
 +
* [[XForms]]: Build browser forms with XML technologies
  
[[Category:Developer]]
+
;APIs
 +
* [[Clients]]: Communicate with BaseX using C#, PHP, Python, Perl, C, ...
 +
* [[Java Examples]]: Code examples for developing with BaseX
 +
* [http://xqj.net/basex XQJ API], implemented by Charles Foster (closed source, restricted to XQuery 3.0)
 +
* [https://github.com/fancellu/xqs XQuery for Scala API], based on XQJ and written by Dino Fancellu
 +
 
 +
;Extensions
 +
* [[Docker]]: Isolate BaseX in a docker container
 +
* [[YAJSW|Service/daemon]]: Install BaseX server as a service
 +
 
 +
</div>
 +
__NOTOC__

Revision as of 14:39, 18 September 2017

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!
Project (Code, Features, Questions)
 
Web Technology
  • RESTXQ: Write web services with XQuery
  • REST: Access and update databases via HTTP requests
  • WebDAV: Access databases from your filesystem
  • XForms: Build browser forms with XML technologies
APIs
  • Clients: Communicate with BaseX using C#, PHP, Python, Perl, C, ...
  • Java Examples: Code examples for developing with BaseX
  • XQJ API, implemented by Charles Foster (closed source, restricted to XQuery 3.0)
  • XQuery for Scala API, based on XQJ and written by Dino Fancellu
Extensions