How to use vitefait - Comment utiliser vitefait

VITEFAIT - beta 0.9.4

Description

L'objet de "Vitefait" est de fournir un générateur ultra rapide pour petites applications de saisie et modif de formulaires. Ces petites applications, très simples peuvent ensuite être modifiées si nécessaire. Vitefait a aussi un but didactique, par l'examen du code généré, il sera facile de comprendre DTML.

Installation

Vitefait est une simple application exportée, il suffit de la placer dans le dossier "import" de zope, d'aller sur l'interface web de zope et demander un import de "vitefait.zexp". Pas besoin de redémarrer Zope.

Premier pas

Pour notre première application vitefait, on va créer un simple formulaire de type annuaire, qui contiendra nom, prénom et téléphone.

tapez : http://localhost:8080/vitefait/ et voilà le résultat:

Pour notre exemple nous allons remplir :
nom de sauvegarde de l'image : annuaire (ce nom servira de préfixe à tout le code généré)
mode html : o (pour générer du code html plutôt que du code à interpréter par vitefait). Ce mode sera pris par défaut.
générer gestion fiches : o (pour avoir la totalité de la gestion VAMSL (voir, ajouter, modifier, supprimer,lister). Par défaut cette gestion ne sera pas générée.
touches à ajouter : voir,ajouter,modifier,supprimer,lister(afin que la gestion soit accessible par touches)
champs de l'image : nom,prenom,telephone,msg_erreur (le nom des champs qui serviront de champs SQL - attention pas d'accentués ni de caractères spéciaux - msg_erreur est un nom de champs spécial qui ne génèrera pas de champs SQL et sera remplit par les fonctions VAMSL - le premier champs servira comme index sauf si un ou plusieurs champs commencent par les 2 caractères k_ k étant en minuscule dans cette hyppothèse ce sont ces champs qui serviront de clé pour les fonctions voir modifier et supprimer)
puis dessinez l'image :
les carctères $ servent à délimiter les zones variables, les £ les zones mot de passe,
les § les zones non modifiables.
# sert pour les cases à cocher et ^ pour les boutons radio
[ et ] servent à délimiter un champ de texte large, ce point sera abordé plus loin
~ sert à insérer un champ de type menu déroulant, ce point sera abordé plus loin

Dessin non formate : par défaut votre généré reprendra tel que le dessin fait à l'écran mais il vous est possible de choisir de disposer vous même les balises HTML dans ce cas mettez un o dans cette option.

C'est tout il suffit maintenant de cliquer sur le bouton générer le code et votre appli est faite !

l'image suivante vous donne le nom de tous les objets générés:
dans notre cas:
annuaire, annuaire_prog, annuaire_html, annuaire_sql_cretab, annuaire_sql _ajouter, annuaire_sql _modifier, annuaire_sql _supprimer, annuaire_sql _voir, annuaire_sql_lister annuaire_prog_ajouter, annuaire_prog_modifier, annuaire_prog_supprimer, annuaire_prog_voir, annuaire_prog_lister, annuaire_prog_rab.
Ces objets se trouvent dans le sous dossier "vitefait_prog".
Allons créer la table SQL nécessaire en cliquant sur le bouton "générer la table SQL"
Vous pouvez d'ores et déjà tester l'application réalisée, soit en cliquant sur le bouton "tester", soit en tapant l'adresse:
http://localhost:9673/vitefait/vitefait_prog/annuaire_prog
Le premier champ sert de champs de référence pour les fonctions voir, modifier et supprimer.

Modification

Le principe de base de vitefait est de générer un modèle type et de vous permettre de le modifier facilement. Néanmoins, vous avez la possibilité de refaire une génération à partir de l'image. Pour cela, il suffit de supprimer tous les objets avec le bouton "supprimer le généré". Vous pouvez aller modifier si vous voulez l'image avec le bouton "mise à jour" qui vous donne l'interface Zope (vous pouvez changer les noms de touches et les noms de champs dans l'onglet "properties" et ensuite repasser par la génération normale, sans avoir à redessiner l'image. Pour regénérer une nouvelle version, il suffit de donner le nom de l'image de base et de cliquer sur le bouton générer le code.

Touche

Vous pouvez mettre autant de touches que vous voulez, les touches nommées voir, ajouter, modifier, supprimer,lister verront leur code généré par l'option "générer gestion fiches", mais rien ne vous oblige à les insérer. Si vous ajoutez une touche nommée "aide" par exemple pour l'application annuaire, il faudra prévoir un objet annuaire_prog_aide

Code html

Après avoir dessiné votre image, vous pouvez ajouter du code HTML pour la rendre plus agréable. La feuille css se trouve dans le dossier vitefait et s'appelle vitefait_css. Elle comporte des modèles pour les champs fixes et variables, la forme et les boutons.

Code SQL

Par défaut tous les champs SQL sont définis en type Varchar. Vous pouvez modifier les objets SQL pour les adapter à vos besoins. La base SQL est par défaut GADFLY, vous pouvez choisir POSTGRES, MySQL ou autre il suffit de créer une connexion nommée vitefait_base.

Détail du code généré

annuaire

Cet objet n'est qu'un dessin d'écran, vous pouvez le modifier, supprimer les autres objets et refaire une génération. Si vous n'avez pas pris l'option HTML, vous pouvez le modifier sans avoir à refaire une génération car cet objet sera interprété.

annuaire_html

cet objet est le code html généré, avec pour chacun des champs renseigné une DTML-VAR

annuaire_prog

Le programme principal qui va appeler chacun des programmes "touches de fonction".
Ce programme teste si une touche a été tapée, dans ce cas il va tester quelle est la touche et appeler le programme adéquat, sinon il envoie l'image (éventuellement initialisée par "annuaire_prog_init")

Notez que le sous-programme "annuaire_prog_init" n'a pas été créé. Si vous voulez initialiser certains champs lors du premier envoi, allez créer ce programme et pour chaque champs insérer l'instruction :
<dtml-call "REQUEST.set('nom du champs','valeur')>"

annuaire_prog_ajouter, annuaire_prog_modifier, annuaire_prog_supprimer

Ces trois programmes sont très ressemblant, ils appellent la fonction SQL correspondante et en cas d'erreur remplissent la zone message.

annuaire_prog_voir

Ce programme appelle sa fonction SQL et remplit les champs en conséquence. en cas d'erreur, il remplit la zone message.

annuaire_prog_lister

Ce programme appleele sa méthode SQL et à partir de celle-ci crée un tableau. Il met les noms des champs dans l'entête (sequence-start) et à partir du premier champs de chaque ligne il permet par la fonction href d'appeler le programme voir pour la fiche choisie. L'affichage du tableau se fait par 10 ligne mais il est très simple de changer ce nombre (en gras sur le tableau). Les instructions "if previous-sequence" et if '"next-sequence" servent à créer des liens vers les lignes précédentes ou suivantes si elles existent.

annuaire_prog_rab

Ce progrmme exécute la remise à blanc de l'image. Il est livré pour être appelé par vous mais n'est pas utilisé sinon

Différentes méthodes SQL

Vous pouvez remarquer que les méthodes utilisent "nom" comme clé.

Méthode SQL_lister

Cette méthode liste par défaut toute la table mais il est possible de lui rajouter un ou plusieurs critères de sélection. Ceci se fait en général au niveau du point d'entrée annuaire_prog_lister_trait. Exemple pour ajouter un sélection sur "nom contient 'ab'" il suffit de créer un objet dtml method nommé annuaire_prog_lister_trait et d'y mettre une instruction :

Mais vous pouvez aussi créer vos propre recherches, exemple :
Vous ajouter un bouton recherche.
vous ajoutez une dtml method nommée annuaire_prog_recherche qui contient

et vous aurez une recherche sur les noms contenant ce que vous avez tapé dans la zone nom de l'image.

Les critères sont notés sous la forme like_column (SQL like), eq_column (=) , ne_column(non =), gt_column(>), ge_column(>=), lt_column(<), le_column(<=). exemples: ge_tel ephone, gt_nom ... (NB : like n'est pas utilisable en Gadfly).

types de champs

Par défaut les champs SQL sont de type varchar(255), néanmoins il est possible de suffixer le champs par une lettre pour avoir un autre type. Le caractère $ donnera un champ de type integer (ex: numero$), un £ donnera un champ de type float (ex: montant£), un / donnera un champ de type date (ex: dnaiss/ ce type n'est pas supporté sur Gadfly), un @ donnera un champs de type blob (ce type n'est pas supporté sur Gadfly) un # permettra au champs de ne pas être repris dans les ordres SQL(ex : djour#). Le suffixe est juste une instruction et ne servira pas à former le nom du champ.

Variables spéciales

En plus de la variable msg_erreur précédemment décrite, une variable nommée nomimage_affiche_pas permet de ne pas afficher le formulaire nommé nomimage lors du prochain passage (une fois uniquement). Il suffit de mettre un ordre <dtml-var "REQUEST.set('nomimage_affiche_pas','x')> pour que le prochain affichage formulaire ne soit pas fait. Pour remplir le message d'erreur il suffit de mettre <dtml-var "REQUEST.set('msg_erreur','mon message')>. Vous avez déjà pu le voir, toutes les communication entre objets se font avec REQUEST.

Début et fin d'image

Les objets vitefait_debut et vitefait_fin seront incorporés respectivement en début ou en fin d'image si ils existent.

Feuille de style

la feuille de style vitefait_css sera utilisée. elle comprend 3 styles, un style form pour le fond d'image, un stype champs pour les champs non protégés et un style prot pour les champs protégés, un style bouton pour les boutons.

boutons radio

Cas des boutons radios: contrairement à toutes les autres zones les boutons radios représentent des choix exclusifs sur un seul champs: exemple

Cette image aura 4 champs nommés respectivement nom, prenom, sexe, sexe. Le champs bouton radio aura pour réponse le numéro du choix coché (. Dans notre exemple, homme est le 1er choix de sexe champs et femme le 2ème , donc sexe contiendra 1 pour homme et 2 pour femme.

boutons case à cocher

La gestion de ces types de champs est proche de la gestion des boutons radios, à la différence qu'ils peuvent avoir des choix multiples. Si le premier choix est coché le champs contiendra 1, si le premier et le 2ème choix sont cochés le champs contiendra la liste [1,2]

Points d'entrée