MBUI Platform: wiki
Depending the access a user receives, it is possible to add models to an existing tree or to add a new tree with its own models. For each model added, an XML file is required. This wiki will explain how to add new models and how to fill in correctly the corresponding XML file.
Add a new tree:
To add a new tree, the user must respect the following constraints: each tree is responsible for a specific scenario (car renting, book research and so on) represented by a folder. For each scenario, they can be several versions represented by a subfolder. The user who wants to create a new scenario will use this architecture:
[Folder: Car renting]
[Folder: v1]
[Folder: v2]
[Folder: New Scenario]
[Folder: v1]
Inside the folder “v1” new models can be add. If the scenario already exists, create a folder with the latest version is enough.
Add a new model:
When a new scenario is created or when it is needed to complete a current one, it must be able to add models. A model contains the following files:
- A XML file that contains information about the model
- One or several images of the current model.
- A folder containing the source code or additional information.
To distinguish a sub node of the tree with another folder, each folder representing a node must start with the following code: $node$. The structure of a node with their two sub nodes is presented like this:
[Folder: $node$Name]
File: text.xml
File: image1.jpg
File: image2.jpg
[Folder: $node$NameSubNode1]
File: text.xml
File: image1.png
[Folder: $node$NameSubNode2]
File: text.xml
File: image1.png
Fill in the XML file:
Each model contains his appropriate XML file. The XML contains a list of mandatory information. The files are the same for each kind of node. Let us have a look into this XML file. We can find below the structure of a common XML file. All these markers have to be present. If there is no need, they can be leaved empty. The name of the marker may not be changed but well the information inside them. In Addition to these markers, a user may add extra markers for further information.
<information>
<title>Title of the model</title>
<undertitle>Subtitle of the model</undertitle>
<nodetitle>Title that will appears inside the tree</nodetitle>
<nodesubtitle>Subtitle that will appears inside the tree</nodesubtitle>
<text> Detailed information about the model</text>
<platform>Kind of platform that the model is designed for (if no platform defined, leave blank or write “Not defined”)</platform>
<environment> Kind of environment that the model will be used (if no environment defined, leave blank or write “Not defined”)</environment>
<user> Kind of user that will use the model (if no user defined, leave blank or write “Not defined”)</user>
<rules>
List of rules used for the model
<rule link="http://www.w3C.org">First rule used to achieve this model. This rule has a link towards another site</rule>
<rule>Second rule used to achieve this model. This rule has no link towards another site</rule>
</rules>
<model>Name of the model [DT|AUI|CUI|FUI]</model>
</information>
Join a graphical schema:
In addition to the XML file, the user can join a set of graphical files. It can be schema of a model, image, screenshot and so on. They may not be in any file format. The platform takes into account only JPG, PNG and GIF file. These file will be displayed each time a node is selected. If there is more file, they will all be displayed and the user can select the wanted file.