Projet:Laboratoire/Index vocabulaire/Aide

En raison de limitations techniques, la typographie souhaitable du titre, « Aide de la commande vcb pour l'outil vocabulary-index », n'a pu être restituée correctement ci-dessus.

Cette documentation concerne un outil disponible sur wmflabs dont le code est publié sur Gerrit vocabulary-index.

... (synthèse des définitions, du serveur web, de la page du bot et de la page projet:labo)

Documentation révision 0.2

La commande vcb.py

~/vocabulary-index/vcb/vcb.py Portugais/Grammaire/Nom
La commande ci-dessus, produit la page suivante: Portugais/Index vocabulaire/vcb Nom.

L'option -t --test

L'option -t (ou --test) permet d'enregistrer la nouvelle page dans le laboratoire:
~/vocabulary-index/vcb/vcb.py -t Grec/Vocabulaire
La commande ci-dessus, produit la page suivante: Projet:Laboratoire/Propositions/Index vocabulaire/vcb Vocabulaire Cette option ne créé pas la page dans le département d'origine, elle est utile dans le cadre de tests.

Tester la commande sur une leçon avant de scanner tout le département

Attention si vous exécutez le programme sur un département (sans préciser de leçon), le temps de réponse est proportionnel au nombre de pages et de modèles correspondants. Actuellement le script restitue un index global contenant les trois listes...

Le processus

Le programme détermine le nom du département, et reconnait le code langue associé (ex: pt). Le script scanne les pages de l'espace dont le titre est donné en argument:

Si l'argument est une leçon, scanne les fichiers dans l'espace et les dossiers des leçons(exo, quiz...).
Si l'argument est un chapitre, scanne la page uniquement.
Si l'argument est indéfini devrait se comporter comme une leçon, scanner l'espace de nom et uniquement les dossiers spéciaux des leçons.

Les 3 listes sont formatées dans des sections successives de la même page: "variable_département"/Index Vocabulaire/vcb_Nom_de_la_leçon

Le programme créé la nouvelle page puis ajoute un lien sur la dernière ligne du sommaire (section à réviser l'édition du sommaire est semi-automatique :( Sommaire des fiches de vocabulaire, exemple: Portugais/Index vocabulaire).

Si l'argument est un département

Si l'argument est un département, créé une nouvelle page sous forme d'index global (il faudra proposer des options avec argparse (-g --global) pour générer 3 ou 4 pages distinctes pour les listes de mots, locutions, phrases et fichiers audio). Il faut scanner tout le département et restituer "l'index global" (Cette commande est gourmande en temps processeur).
Département/Index Vocabulaire/vcb Global

Exemple: La commande ./vcb.py Portugais reconnait un nom de Département et va créer une liste exhaustive du vocabulaire pour l’ensemble du département ex: Portugais/Index vocabulaire/Index global

Minimum requis

Le programme refusera de créer une nouvelle page si le nombre de lignes de la liste produite est inférieur à cinq.