Online Documentation

This page provides pointers to all available Jadex documentation

API Reference

The API reference documentation is automatically generated from the latest source files.

• Javadoc API documents important Java classes, interfaces of Jadex and their methods.
• Jadexdoc API documents important Jadex components and their arguments.
• Schemadoc APIs document the XML structure of Components, Applications and BDI Agents as well as the EnvSupport and AGR extensions.

Documents

If you are new to Jadex you probably want to start with the Active Components Tutorial, which gives a fast step-by-step introduction to the concepts of Jadex. If you are interested in BPMN processes, you can also start with the BPMN Workflows Tutorial instead. Further information on how to find the desired documentation is given below the table.

Note: The Wikis are constantly improved. If you find errors or passages that are poorly described please let us know, such that we can improve the documentation. PDFs are automatically generated from the Wikis. Thus, please excuse the sometimes limited layout of the PDFs.

Category	Title	Type	Current (Wiki)	Current (PDF)	Release 0.96 (PDF)
Platform	Standalone	User Guide			n/a
	Android	User Guide			n/a
Kernel	Active Components	Tutorial			n/a
		User Guide			n/a
	Application	User Guide			n/a
	BDI	User Guide		n/a
		Tutorial
	Micro Agents	User Guide			n/a
	BPMN Workflows	Tutorial			n/a
Space	Environment (2D)	User Guide			n/a
Development	Build Process	User Guide			n/a
Tools	Tools	User Guide	todo	n/a
Libraries	Jadex Rules	User Guide			n/a
	Jadex XML	User Guide			n/a

Guide to the Documentation

As Jadex has a modular architecture, many different documents are available describing the different aspects of the system. This section gives you an overview of the available documents such that you should be able to quickly find the information you are interested in.

Documentation Categories

Documentation for different types of modules is grouped into categories. Usually, one would only be interested in one document of a category (e.g. a specific kernel or specific platform). The categories are:

• Platform: Describes details of starting a specific platform and unique features of the given platform.
• Kernel: A kernel provides mechanisms for programming the behavior of a single agent. For each agent architecture (e.g. BDI) a specific kernel is available. Note that applications are also realized via specific application kernel.
• Space: A space is a component that can be shared by agents belonging to the same application. Different kinds of spaces are available for different purposes (e.g. simulation or coordination).
• Development: Documentation that is helpful, if you want to build (and maybe change) Jadex itself.
• Tools: Descriptions of the tools that are available for running and debugging your agents and components.
• Libraries: Documentation for libraries, which are developed as part of the Jadex project and are used by some other modules.

Documentation Types

Depending on the type of the document, it is useful for different purposes:

• User Guide: Most documentation belongs to the user guide type, which is written in reference style. These documents try to cover all features of a given component in a systematic way and are useful for looking up a specific feature or for learning about all features. Additionally, user guides try to include (or refer to) usage examples, and sometimes even provide code-snippets for copy-paste.
• Tutorial: Tutorials cover the commonly used features and are written as a step-by-step introduction. Thus, tutorials are useful for getting starting with the covered aspects of Jadex. Tutorial documents are provided in addition to user guides and are not available for all components.

Documentation Versions

The documentation is created and edited in the Jadex Wiki space. Thus any Jadex user can participate in updating and expanding the documentation. For convenience, other versions can be accessed from the above table.

• Current (Wiki): The link will take you directly to the online version of the document. You can read and also alter (if you are logged in) the pages directly in you web browser.
• Current (PDF): For easier printing, a download link is provided that generates a complete PDF document of the current state of all wiki pages belonging to the selected document.
• Release X.YZ (PDF): As the usage of Jadex changes from release to release, we also provide the frozen state of the documentation of the latest release. For convenience, you can also find links to the old (pre 2.0) style documentation below.

Legacy Documentation

• Legacy documentation for Jadex 0.96x and Jadex 0.94x can be found here

XML Hints for eclipse

Jadex makes extensive use of XML files and provides XML schemas for all of the different file types such as application files, environment support space definitions and BDI agent definition files. eclipse downloads these schema definitions automatically what is annoying when you updated the Jadex version and want eclipse to reload these schema definitions. To achieve such a reload you should manually delete the following folder in your eclipse workbench:

• eclipse_workspace/.metadata/.plugins/org.eclipse.wst.internet.cache