µ2w!ki :: code

µ²wiki v.20110221 | liste | ----

le code

contenu du dossier wiki

Télécharger l'archive, la décompresser et analyser le contenu du dossier :

1. fichier index.php
2. dossier meca
1. fichier index.php
2. fichier PHP.php
3. fichier PARSER.php
4. fichier JS.js
3. dossier skins
1. dossier fixed
1. fichier HTML.html
2. fichier CSS.css
3. fichier copyleft.png
4. fichier diag_tore.jpg
2. dossier elastic
1. fichier HTML.html
2. fichier CSS.css
4. dossier pages
1. fichier index.php
2. fichier start.txt
3. fichier ...
5. dossier history
1. fichier index.php
2. dossier start
1. fichier index.php
2. fichier 20110212-221617.txt
3. fichier 20110212-221610.txt
4. fichier ...
3. dossier ...
6. dossier data
1. fichier index.php
2. ...

fonctions du fichier PHP.php

1. function view ( $page )
2. function edit ( $page )
3. function save ( $page, $content )
4. function history ( $page, $content )
5. function liste ()
6. function doBody ()
7. function doHTML ()
8. function doUpdate ()
9. function doTheJob ()

fonctions du fichier PARSER.php

1. function doControlName ( $chaine )
2. function doControlContent ( $chaine )
3. function doWikisyntax ( $chaine )

Fonctions du fichier JS.js

1. function doPreview ( )
2. function doSave ( )
3. function doCancel ( )
4. function doQuit ( )
5. function doFlip ( id )

fonctionnement

Quelques commentaires pour accompagner la lecture du code.

• Tout commence ... et finit dans le fichier index.php ;
• le nom du wiki et le skin sont notés, puis le contenu du fichier PHP.php est inséré dans index.php ;
• la fonction doTheJob() est appelée pour traiter deux cas : construire la page HTML (do_HTML()) ou rafraichir le contenu du cadre de prévisualisation (do_Update()), si on est en mode édition. On se placera d'abord dans le premier cas.
• La fonction do_HTML() repère le skin choisi, lit le contenu du fichier modèle HTML.html et construit son contenu avec la fonction doBody() ;
• La fonction doBody() est le coeur du moteur wiki, dispatchant les taches en fonction des contextes ;
  • la fonction view() construit la page en mode visualisation,
  • la fonction liste() construit une page listant les pages du wiki,
  • la fonction save() enregistre sur le serveur le contenu de la page.
  • la fonction history() enregistre sur le serveur dans un dossier history une copie conforme de la page.
  • la fonction edit() construit la page en mode édition, c'est à dire :
    • un cadre de visualisation temps réel,
    • un cadre contenant deux contrôles : save et cancel,
    • un cadre d'édition du code.
• Dans le cas où la fonction doTheJob() appelle la fonction do_Update(), on souhaite le rafraichissement du cadre de prévisualisation, en temps réel et sans reconstruction de la totalité de la page. En fait le déclenchement est fait à chaque entrée clavier dans le cadre éditeur (textarea) par l'intermédiaire de la fonction Javascript doPreview() contenue dans le fichier JS.js. Celle-ci lance une requête au fichier index.php sur le serveur avec le contenu du code de l'éditeur et injecte la réponse dans le cadre de prévisualisation. La requête (XMLHttpRequest) est asynchrone, ne bloque donc pas le fonctionnement de l'éditeur côté client et le retour peut se faire attendre ... ou ne jamais venir !

A suivre dans un prochain épisode ...