Pour les intervenants
Cette page s’adresse aux intervenants de l’Action Nationale de Formation organisée par Mathrice en septembre 2014. Elle décrit la marche à suivre, pour que les intervenants rédigent les énoncés des TP et déposent les supports de leurs exposés/cours.
Afin de faciliter sa diffusion et sa consultation par les participants, ce wiki est construit avec l’outil WebGen. Ainsi, il ne nécessite pas de serveur web pour être consulté. Le tout est placé dans un dépôt subversion (travail collaboratif).
Le fonctionnement de ce wiki est le suivant :
- Les contenus sont écrits dans des fichiers textes.
- Des documents supplémentaires (PDF, schémas, images…) sont accessibles directement depuis les pages du wiki avec des liens hypertextes.
- L’outil WebGen construit un ensemble de pages HTML statiques (sans PHP).
- Les pages sont déposées sur un serveur web ou consultées avec un navigateur directement sur le système de fichier local.
Pré-requis
Pour écrire du contenu sur ce wiki, il est donc nécessaire de disposer :
- d’un client SVN
- d’un editeur de texte (Emacs, vi…)
- d’un interpréteur Ruby
- de l’outil WebGen
Créer une copie de travail SVN
Dans son répertoire de travail, créer une copie de travail du wiki avec la commande suivante (à adapter selon le client utilisé). L’exemple donné utilise la commande svn d’un système GNU/Linux Debian (paquet subversion).
svn co https://svn.math.cnrs.fr/anf2014-org/Wiki
Le répertoire Wiki obtenu s’organise comme décrit ci-dessous.
| Sous répertoire | Description |
|---|---|
| ext | Extensions pour WebGen |
| out | Fichiers HTML produits par WebGen |
| src | Fichiers sources (source path) et modèles (template) utilisés pour la création des pages HTML. C’est ici qu’il faudra deposer ses fichiers PDF et écrire les pages de wiki |
| tmp | Fichiers temporaires utilisés par WebGen |
| doc | Documents LibreOffice, codes Latex pour la création des PDF du répertoire src |
Installation de WebGen
Il reste à installer l’outil WebGen. Voici la marche à suivre pour un système GNU/Linux Debian. Commençons par installer Ruby et les outils associés (en tant que root) :
$ apt-get install ruby1.9.1
$ apt-get install rubygems rubygems-doc
WebGen est distribué sous forme de GEM Ruby. Continuons avec l’installation du GEM correspondant. Afin de pouvoir exécuter cette commande en tant qu’utilisateur sans privilèges, le GEM sera installé dans le répertoire utilisateur.
$ gem1.9.1 install webgen --user-install
Enfin, il faut modifier sa variable d’environnement PATH (dans le fichier ~/.bashrc) de façon à rendre les commandes associées aux gems Ruby accessibles :
export PATH=$PATH:~/.gem/ruby/1.9.1/bin
Rédaction
Dans le répertoire src, pour faire simple, chaque fichier .page correspond à une page HTML générée par WebGen. Le contenu d’un fichier .page suit le formattage Kramdown.
Le wiki est organisé selon le programme de la semaine. Il existe donc un fichier par jour (lundi.page, mardi.page…). Le support de cours (ou TP) est soit un fichier PDF, soit une nouvelle page. Dans les deux cas, le fichier PDF ou la nouvelle page seront rendus accessibles par un lien hypertexte sur le programme.
Avec un document PDF
- Dans le répertoire doc, déposer le fichier LibreOffice, ou le code source Latex (avec les figures associées). Ne pas oublier d’ajouter ces fichiers dans le dépot SVN.
- Utiliser la fonctionnalité d’exportation (LibreOffice) ou le compilateur Latex pour produire le document PDF.
- Copier le fichier PDF produit dans le dossier src.
- Dans la page du programme correspondante, faire un lien hypertexte vers ce PDF.
[Mon TP](mon-fichier.pdf)
Avec une nouvelle page
- Dans le répertoire src, ajouter un nouveau fichier .page
- Commencer ce fichier par les méta-données en spécifiant au minimum le titre et le template à utiliser.
- Le template définit la façon dont seront agencées les informations dans la page HTML produite. Le modèle tp.template est fait pour cela.
- Dans la page du programme correspondante, faire un lien hypertexte vers cette page.
Génération du Wiki
La construction des pages HTML s’effectue simplement en invoquant la commande WebGen depuis le répertoire Wiki.
$ cd Wiki
$ webgen
Les fichiers HTML générés se trouvent dans le dossier Wiki/out.