Wiki code for Online Documentation

Hide Line numbers
1: 1 Documentation
2: 
3: ~~Note:~~ Some Wikis are not yet finished and PDF generation is still work in progress.\\
4: \\
5: 
6: <table cellspacing="0">
7:   <tr>
8:     <th style="background-color: #fff2cc; color: black; font-weight: normal">Category</th>
9:     <th style="background-color: #fff2cc; color: black; font-weight: normal">Title</th>
10:     <th style="background-color: #fff2cc; color: black; font-weight: normal">Type</th>
11:     <th style="background-color: #fff2cc; color: black; font-weight: normal">Current (Wiki)</th>
12:     <th style="background-color: #fff2cc; color: black; font-weight: normal">Current (PDF)</th>
13:     <th style="background-color: #fff2cc; color: black; font-weight: normal">Release 0.96 (PDF)</th>
14:   </tr>
15: 
16:   <tr style="background-color: #f9f9f9; height: 50px">
17:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" rowspan="2">Platform</td>
18:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">Standalone</td>
19:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">User Guide</td>
20:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center"><a href="$xwiki.getURL("Standalone Platform Guide.01 Introduction")">{image:xwikiiconlarge.png|alt=Standalone User Guide}</a></td>
21:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px; padding-left: 10px; padding-right: 10px" align="center"><a href="/bin/export/Standalone+Platform+Guide/01+Introduction?format=pdf#foreach($page in $xwiki.searchDocuments("doc.space=’Standalone Platform Guide’ order by doc.fullName"))&pages=$page#end">{image:pdficonlarge.png|alt=Standalone User Guide}</a></td>
22:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">n/a</td>
23:   </tr>
24: 
25:   <tr style="background-color: #f9f9f9; height: 50px">
26:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">JADE</td>
27:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">User Guide</td>
28:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">todo</td>
29:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">n/a</td>
30:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">n/a</td>
31:   </tr>
32: 
33:   <tr style="background-color: #f0f4fa; height: 50px">
34:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" rowspan="2">Application</td>
35:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" rowspan="2">Application</td>
36:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">User Guide</td>
37:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center"><a href="$xwiki.getURL("Application Guide.01 Introduction")">{image:xwikiiconlarge.png|alt=Application User Guide}</a></td>
38:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center"><a href="/bin/export/Application+Guide/Jadex+Application+Guide?format=pdf#foreach($page in $xwiki.searchDocuments("doc.space=’Application Guide’ order by doc.fullName"))&pages=$page#end">{image:pdficonlarge.png|alt=Application User Guide}</a></td>
39:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">n/a</td>
40:   </tr>
41: 
42:   <tr style="background-color: #f0f4fa; height: 50px">
43:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">Schema Doc</td>
44:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center"><a href="/docs/jadex-2.0x/application/schema/jadex-application-2.0.html">{image:htmliconlarge.png|alt=Application Schema Doc}</a></td>
45:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">n/a</td>
46:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">n/a</td>
47:   </tr>
48: 
49:   <tr style="background-color: #f9f9f9; height: 50px">
50:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">Space</td>
51:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">Environment (2D)</td>
52:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">User Guide</td>
53:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">todo</td>
54:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">n/a</td>
55:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">n/a</td>
56:   </tr>
57: 
58:   <tr style="background-color: #f0f4fa; height: 50px">
59:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" rowspan="4">Kernel</td>
60:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" rowspan="3">BDI</td>
61:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">User Guide</td>
62:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center"><a href="$xwiki.getURL("BDI User Guide.01 Introduction (old)")">{image:xwikiiconlarge.png|alt=BDI User Guide}</a></td>
63:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center"><a href="/bin/export/BDI+User+Guide/01+Introduction+(old)?format=pdf#foreach($page in $xwiki.searchDocuments("doc.space=’BDI User Guide’ order by doc.fullName"))&pages=$page#end">{image:pdficonlarge.png|alt=BDI User Guide}</a></td>
64:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center"><a href="/docs/jadex-0.96x/userguide/userguide.pdf">{image:pdficonlarge.png|alt=BDI User Guide}</a></td>
65:   </tr>
66: 
67:   <tr style="background-color: #f0f4fa; height: 50px">
68:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">Tutorial</td>
69:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center"><a href="$xwiki.getURL("BDI Tutorial.01 Introduction")">{image:xwikiiconlarge.png|alt=BDI Tutorial}</a></td>
70:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center"><a href="/bin/export/BDI+Tutorial/01+Introduction?format=pdf#foreach($page in $xwiki.searchDocuments("doc.space=’BDI Tutorial’ order by doc.fullName"))&pages=$page#end">{image:pdficonlarge.png|alt=BDI Tutorial}</a></td>
71:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center"><a href="/docs/jadex-0.96x/tutorial/tutorial.pdf">{image:pdficonlarge.png|alt=BDI Tutorial}</a></td>
72:   </tr>
73: 
74:   <tr style="background-color: #f0f4fa; height: 50px">
75:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">Schema Doc</td>
76:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center"><a href="/docs/jadex-2.0x/kernel-bdi/schema/jadex-bdi-2.0.html">{image:htmliconlarge.png|alt=BDI Schema Doc}</a></td>
77:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">n/a</td>
78:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">n/a</td>
79:   </tr>
80: 
81:   <tr style="background-color: #f0f4fa; height: 50px">
82:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">Micro Agents</td>
83:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">User Guide</td>
84:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">todo</td>
85:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">n/a</td>
86:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">n/a</td>
87:   </tr>
88: 
89:   <tr style="background-color: #f9f9f9; height: 50px">
90:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">Development</td>
91:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">Build Process</td>
92:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">User Guide</td>
93:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center"><a href="$xwiki.getURL("Resources.Build Process")">{image:xwikiiconlarge.png|alt=Build Process User Guide}</a></td>
94:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center"><a href="/bin/export/Resources/Build+Process?format=pdf">{image:pdficonlarge.png|alt=Build Process User Guide}</a></td>
95:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">n/a</td>
96:   </tr>
97: 
98:   <tr style="background-color: #f0f4fa; height: 50px">
99:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">Tools</td>
100:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">Tools</td>
101:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px">User Guide</td>
102:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">todo</td>
103:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center">n/a</td>
104:     <td style="border-top: 1px solid #cccccc; padding-left: 10px; padding-right: 10px" align="center"><a href="/docs/jadex-0.96x/toolguide/toolguide.pdf">{image:pdficonlarge.png|alt=Tools User Guide}</a></td>
105:   </tr>
106: </table>
107: 
108: 1.1 Guide to the Documentation
109: 
110: 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.
111: 
112: 1.1.1 Documentation Categories
113: 
114: 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:
115: * *Platform:* Describes details of starting a specific platform and unique features of the given platform.
116: * *Application:* Documentation on defining, starting and managing agent applications.
117: * *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).
118: * *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.
119: * *Development:* Documentation that is helpful, if you want to build (and maybe change) Jadex itself.
120: * *Tools:* Descriptions of the tools that are available for running and debugging your agents.
121: 
122: 1.1.1 Documentation Types
123: 
124: Depending on the type of the document, it is useful for different purposes:
125: * *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.
126: * *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.
127: * *Schema Doc:* A reference documentation, which is directly generated from the .xsd schema definition file. Thus this document describes all tags and attributes, but in a somewhat isolated manner without usage examples. Schema docs are available for all XML schemas.
128: 
129: 1.1.1 Documentation Versions
130: 
131: 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.
132: * *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.
133: * *Current (PDF):* For easier printing, a download link is provided that generates a complete PDF document of the current state of all pages, belonging to the selected document.
134: * *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.
135: 
136: 1.1.1 Legacy Documentation
137: 
138: * Legacy documentation for Jadex 0.96x and Jadex 0.94x can be found [here>Legacy+Documentation]
Online Documentation

Top Menu

Wiki code for Online Documentation

Search

Navigation

About

Download

Internal

Usages

Resources

Links

Quick Links

Users Currently Online
