API : Histoire

#Histoires Une histoire est constituée d'un ou plusieurs niveaux, lui-même constitué de 0, 1 ou plusieurs tests.

• History
  • Level(s)
    • Test(s)

La structure d'un test est définit par le plugin dont il st lié

histoire (plugin)

TODO

histoire (fichier)

Une histoire sous forme de fichier (forme simple) est un simple fichier ZIP dont l'extension à été modifier.
L'extension des fichiers est .history.
Les histoires doivent être placées dans le sous-dossier history de l'application (dans user home ou le dossier courant suivant les paramètres).

Structure / Contenu

Sa structure ressemble à ceci :

• /
  • index.xml
  • description.txt (facultatif) (nom changeable)
  • test (nom changeable) contenu dépendant du compilateur utilisé

description

La description est un simple fichier txt (ie. texte).

TODO: HTML/Markdown

test

Le contenu du fichier des tests est défini par le compilateur utilisé.
L'application le traite comme un simple fichier binaire qui sera transmis au compilateur.

index.xml

La structure du fichier index.xml est défini par un schéma (_TODO: lien).
Note: écriture = balise {attribut(s)}.

• history {compiler}
  • title
  • description {type} (optionnel)
  • levels
    • level {name} [1;[
      • description {type}
      • resume {type} (optionnel)
      • tests {file}
        • test {id, name, resume (optionnel)} [0;[

Valeurs possibles :

• <type>
  • text
  • file

Le fichier doit respecter le schéma sinon la validation échouera et ne sera pas lu/traiter.