Note
This page introduces the RobotML platform (see section below) as well as the the way to build the documentation you are reading (see Documentation How-to). There is, following, a section dedicated to indices and tables (see Indices and tables) and finally a list of websites linked to the platform (see Related websites).
In the robotic domain, academic as well as industry, there is nowadays a need to describe more formally the system developed whatever they are. This need arises from several different considerations such as:
In order to answer the need demonstrated above a project (see PROTEUS) allowed to create a modelling language and other associated toolings which this documentation is foccussing on. Thus RobotML is a language associated to a platform linked to PAPYRUS tool and build upon ECLIPSE framework. The goal of this language is to answer the above problematics and thus to ease development of robotics application and to facilitate exchanges between roboticians and end-users.
RobotML documentation is decomposed in many parts. A presentation of its rationale is done in its introduction, then, instructions are provided in order to install the platform followed by some hints of how to use it through some examples. The following sections are providing in-depth information on the underlying language (the so-called meta-model), the different choices done in order to present the user modelling capabilities and finally the different generators add-ons with example of use. The last section is dedicated to the web portal and its interactions with the RobotML platform.
The last bit of important information is that each time it is necessary, the documentation will separate the user point of view from the developper one trying to limit the amount of knowledge to what is strictly deemed necessary.
More information on RobotML are available through its dedicated portal that is accessible directly following http://rim.bourges.univ-orleans.fr/ .
Warning
Documentation is written solely in English due to lack of resources that would have allowed at least a French version. The reason for this choice is the importance of dissemination and cooperation at the European Level (see projects such as BRICS).
The documentation you are reading has been generated using the sphinx tool. It is a part of the development in itself and here follows tho sections that explicits how to install the sphinx tool, where to find its associated documentation and provides a list of known bugs and frequently asked questions.