Cadoles
/
formations
20
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Mise à jour de la documentation de la commande setup_main_tex_file.py

This commit is contained in:
Benjamin Bohard 2021-02-01 13:57:52 +01:00
parent 2d620e845d
commit 9b9cbf2aae
1 changed files with 21 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -48,14 +48,15 @@ Les figures sont placées à part dans le répertoire _figures_.
Ces éléments de contenu sont inclus dans des fichiers principaux placés dans le répertoire _presentations_. Ces éléments de contenu sont inclus dans des fichiers principaux placés dans le répertoire _presentations_.
Le répertoire _template_ contient des modèles de document au format jinja utilisés par le script _setup_main_tex_file.py_. Le répertoire _templates_ contient des modèles de document au format jinja utilisés par le script _setup_main_tex_file.py_.
## setup_main_tex_file.py ## setup_main_tex_file.py
Le script setup_main_tex_file.py permet d’organiser la procédure en proposant : Le script setup_main_tex_file.py permet d’organiser la procédure en proposant :
- la création du fichier maître pour une formation - la création des fichiers maîtres pour une formation ;
- la création des fichiers de contenu à inclure si nécessaire - la création des fichiers de contenu à inclure si nécessaire ;
- la mise à jour du plan de formation en fonction des éléments inclus. - la mise à jour du plan de formation en fonction des éléments inclus ;
- la compilation des trois documents (diaporama, support de cours et programme) si l’application rubber est installée.
Pour chacune de ses sous-étapes, le script propose une sous-commande. Pour chacune de ses sous-étapes, le script propose une sous-commande.
@ -79,7 +80,7 @@ Les autres options prendront des valeurs par défaut si elles ne sont pas fourni
À noter, pour la licence, que seule la CC-BY-SA v2 est disponible dans les contenus à inclure pour l’instant. À noter, pour la licence, que seule la CC-BY-SA v2 est disponible dans les contenus à inclure pour l’instant.
L’exécution de la commande précédente produit le fichier presentations/modules_EOLE_envole/Conseil_Départemental/CD_Formation_Scribe.tex L’exécution de la commande précédente produit le fichier presentations/modules_EOLE_envole/Conseil_Départemental/diaporama.tex.
### Construire le contenu d’une formation ### Construire le contenu d’une formation
@ -155,16 +156,16 @@ Seule la dernière inclusion poserait problème lors de la compilation.
Pour permettre de lancer des compilations sans attendre que tout le contenu soit prêt, le script propose une sous commande qui prépare le terrain en créant les fichiers de contenu manquant. Pour permettre de lancer des compilations sans attendre que tout le contenu soit prêt, le script propose une sous commande qui prépare le terrain en créant les fichiers de contenu manquant.
``` ```
./setup_main_tex_file.py update -m presentations/modules_EOLE_envole/Conseil_Départemental/CD_Formation_Scribe.tex ./setup_main_tex_file.py update -d modules_EOLE_envole/Conseil_Départemental
``` ```
Le seul argument de cette sous-commande _update_ permet d’identifier le fichier maître. Le seul argument de cette sous-commande _update_ permet d’identifier le sous-répertoire de _presentations_ contenant le fichier maître _diaporama.tex_.
Cette commande traiter toutes les directives skbinput et créer le fichier à inclure si il n’existe pas déjà. Cette commande traite toutes les directives skbinput et créer le fichier à inclure s’il n’existe pas déjà.
Elle affiche la liste des fichiers créés en retour de commande. Elle affiche la liste des fichiers créés en retour de commande.
``` ```
$ ./setup_main_tex_file.py update -m presentations/modules_EOLE_envole/Conseil_Départemental/CD_Formation_Scribe.tex $ ./setup_main_tex_file.py update -d modules_EOLE_envole/Conseil_Départemental/
slides/modules_EOLE_envole/commun/du-contenu-inexistant.tex slides/modules_EOLE_envole/commun/du-contenu-inexistant.tex
``` ```
@ -179,7 +180,10 @@ Ce fichier contient du texte permettant de le repérer facilement dans le docume
### Affichage du plan (sous-commande outline) ### Affichage du plan (sous-commande outline)
À ce stade, le script propose un simple affichage sur la sortie standard du plan déduit du contenu La sous-commande _outline_ permet de créer un sommaire du diaporama sous la forme de listes imbriquées et de l’inclure dans le programme.
```
./setup_main_tex_file.py outline -d modules_EOLE_envole/Conseil_Départemental
```
``` ```
Introduction Introduction
EOLE EOLE
@ -228,7 +232,13 @@ Les quatre phases
### Génération du document ### Génération du document
En alternative à la recette Makefile pas encore adaptée pour la compilation de ce nouveau format, on peut utiliser la commande rubber (paquet supplémentaire à installer) Comme alternative à la recette Makefile pas encore adaptée pour la compilation de ce nouveau format, on peut utiliser la commande rubber (paquet supplémentaire à installer)
``` ```
rubber --inplace --module=xelatex presentations/modules_EOLE_envole/Conseil_Départemental/CD_Formation_Scribe.tex rubber --inplace --module=xelatex presentations/modules_EOLE_envole/Conseil_Départemental/CD_Formation_Scribe.tex
``` ```
La sous-commande _compile_ appelle rubber pour compiler les trois documents : diaporama, support et programme.
```
./setup_main_tex_file.py compile -d modules_EOLE_envole/Conseil_Départemental
```
Cette sous-commande n’est disponible que si la commande rubber est installé et accessible (test du retour rubber --version).