JavaScool:DocumentsHml

Rédiger les documents des «proglets» en HTML minimal

Afin que la documentation des «proglets» soit homogène, facile à maintenir et surtout que le lecteur se retrouve d'une «proglet» à une autre, les pages sont écrites en utilisant un sous ensemble minimal d'HTML le format HML en syntaxe XML, en clair: un documentstructuré en division, le texte étant enrichi pour qualifier son contenu, tout en intégrant des liens hyper-texte.

Structure d'une documentation de «proglet»

Typiquement une documentation précise les objectifs de l'activité, donne des éléments introductifs pour faire connaître le contexte, rappeler les prérequis, puis propose un travail de programmation qui va permettre de vérifier que les concepts sont compris, les éléments complémentaires étant données en note à la fin du document.

Celà s'implémente à travers le squelette suivant:

<div title="La «proglet» @name">
  <div class="objectif">
  </div>
  <div class="intros">
    <div title="item 1">
    </div>
  etc..
  </div>
  <div class="works">
    <div title="item 1">
    </div>
  etc..
  </div>
  <div class="notes">
   <!-- référencées par des tags de la forme <l class="note" link="1"/> -->
    <div title="item 1">
    </div>
  etc..
  </div>
</div>

Apprendre par l'exemple: des bouts de codes à réutiliser

Pour permettre à l'apprenant d'obtenir rapidement un premier résultat à partir duquel il va réfléchir et aller plus loin, il est conseiller de proposer des bouts de codes exemples qui seront naturellement copiés/collés pour initier le travail.

La balise <code>permet de spécifier ces exemples qui seront présentés en couleur à l'utilisateur:

<code>

void main() {

}

</code>

Interagir de la documentation avec la plateforme Java's Cool

Pour aider à l'interaction avec l'apprenant