JavaScool:DocumentsHml : Différence entre versions
m |
m |
||
| Ligne 1 : | Ligne 1 : | ||
<div class="label1">'''Rédiger les documents des «proglets» en HTML minimal'''</div> | <div class="label1">'''Rédiger les documents des «proglets» en HTML minimal'''</div> | ||
| − | 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 [[JavaScool:DocFormatHml|format HML]] en syntaxe XML. | + | 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 [[JavaScool:DocFormatHml|format HML]] en syntaxe XML, en clair: un document[[#Structurer_le_texte_en_divisions.|structuré en division]], le texte étant [[#Enrichir_le_texte_en_modifiant_son_aspect.| enrichi pour qualifier son contenu]], tout en [[#Cr.C3.A9er_de_l.27.C2.ABhyper-texte.C2.BB_en_ajoutant_des_objets_et_des_liens.|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: | ||
<pre> | <pre> | ||
<div title="La «proglet» @name"> | <div title="La «proglet» @name"> | ||
| Ligne 24 : | Ligne 30 : | ||
</div> | </div> | ||
</pre> | </pre> | ||
| + | |||
| + | == Apprendre par l'exemple: des bouts de codes à réutiliser == | ||
| + | |||
| + | Il est très important de pouvoir | ||
| + | |||
| + | la balise <tt><code> .. </code></tt> permet de donner en exemple des | ||
Version du 19 août 2011 à 23:38
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
Il est très important de pouvoir
la balise <code> .. </code> permet de donner en exemple des
