Manuel du composant CKForms Version 1.3.2

Transcription

1 Manuel du composant CKForms Version Ce manuel vous présente les principales fonctionnalités du composant CKForms y compris le module et le plug-in CKForms 1.3 est la nouvelle version du composant pour Joomla 1.5. Ce composant génère des formulaires et ses champs sans aucune connaissance en programmation. Outre sa simplicité, il offre la possibilité de sauver les données dans une base de données et de les exporter au format CVS. Les champs peuvent être validés comme texte, nombre, date et courriel. Un «File upload» est disponible. Les formulaires créés peuvent être sauvegardés et récupérés sans connaissances sur les bases de données. Un éditeur HTML est disponible et un code de sécurité Captcha peut être utilisé pour sécuriser les formulaires. Un plug-in et un module sont disponibles pour afficher des formulaires dans les articles ou à certains emplacements de l'écran. CKForms est compatible avec Joomfish. Remarque : le générateur de formulaire CKForms n'est disponible que pour la version 1.5 de Joomla! Page 1

2 Table des matières 1. Installation / désintallation...3 A - Installation...3 B - Désinstallation Les formulaires...6 A - L onglet «Général»...6 B - L onglet «Envois»...7 C - L onglet « »...8 D - L onglet «Avancé»...9 E Liste des formulaires Les champs...10 A - Champs commun à tous les types de champ...10 B - Ajout d un champ «Texte» Ajout d un champ «Mot de passe» Ajout d un champ « » Ajout d un champ «Date» Ajout d un champ «Nombre»...11 C - Ajout d un champ «Hidden»...11 D - Ajout d un champ «Textarea»...12 E - Ajout d une «Checkbox»...12 F - Ajout de «Radio Button»...13 G - Ajout d un «Select»...13 H - Ajout d un «Fichier transféré»...14 I - Ajout d un «Bouton»...14 J - Ajout d un «Séparateur de champs»...15 K - Liste des champs du formulaire Les Données...16 A Afficher le détail...16 B - Supprimer des enregistrements...17 C Exporter les données Edition de la feuille de styles CSS Sauvegarder/restaurer des formulaires et leurs données...19 A Sauvegarder des formulaires et leurs données...19 B - Restaurer des formulaires et leurs données Affichage des formulaires...20 A Menu avec un lien sur un formulaire...20 B Insérer un formulaire dans un article...21 C Utilisation d'un formulaire comme module Affichage du formulaire...23 Pour toutes informations complémentaires :...24 Page 2

3 1. Installation / désinstallation ATTENTION : Si vous avez une version de CKForms déjà installée et que vous voulez garder les formulaires créés et les données, vous devez faire une sauvegarde avant de désinstaller le composant et restaurer les données une fois l'installation effectuée. Ces opérations s'effectuent depuis l'interface d'administration du composant CKForms en cliquant sur le bouton «Backup» pour sauvegarder et sur le bouton «Restaurer» pour récupérer les données. Si vous avez modifié le fichier de style CSS, vous devez le sauvegarder manuellement avant de désinstaller le composant. Ce fichier se trouve à l'emplacement suivant : <joomla root>/components/com_ckforms/css/ckforms.css Cette sauvegarde sera intégrée dans le «backup» dans un version future. A - Installation L installation du composant, du plug-in et du module CKForms s effectue depuis l interface d installation de Joomla! Une confirmation d installation est affichée pour le composant, le module et le plug-in (à partir de la version de Joomla!). Page 3

4 Vous pouvez afficher le texte d installation du plug-in en l éditant dans la gestion des plug-ins de Joomla!. B - Désinstallation La désinstallation du composant, du plugin et du module CKForms s effectue depuis l interface d installation de Joomla! : dans l'onglet «Composants» pour désinstaller le composant CKForms dans l'onglet «Modules» pour désinstaller le module CKForms dans l'onglet «Plugins» pour désinstaller le plug-in CKForms ATTENTION : Si vous voulez garder les formulaires créés et les données, vous devez faire une sauvegarde avant de désinstaller le composant. Page 4

5 Page 5

6 2. Les formulaires Dans la liste des composants, sélectionnez «CK Forms» Cliquez ensuite sur «Nouveau» pour afficher l'écran de création de formulaire, qui est composé des onglets suivants : A - L onglet «Général» B - L onglet «Résultat» C - L onglet « » D - L onglet «Avancé» Page 6

7 A - L onglet «Général» L onglet «Général» concerne : Le nom du formulaire dans la base de données (pas de caractères spéciaux ni d espace) Le titre du formulaire La publication du formulaire La description affichée au-dessus du formulaire Page 7

8 B - L onglet «Résultat» L onglet «Résultat» concerne : L enregistrement dans la base de données du contenus des formulaires envoyés Le texte affiché à l utilisateur après son envoi L URL permettant de rediriger l utilisateur après son envoi, vers une adresse spécifique Page 8

9 C - L onglet « » L onglet « » concerne : l envoi ou non du formulaire a une ou des adresses s le nom de l expéditeur par défaut les adresses s des destinataires les adresses s des destinataires en copie les adresses s des destinataires en copie cachée le sujet de l l'attachement des fichiers envoyés l'envoie d'un de confirmation à l'utilisateur qui a rempli le formulaire le sujet de l' de confirmation le texte de l' de confirmation la reprise des données sauvegardées dans l' de confirmation l'attachement des fichiers envoyés dans l' de confirmation Page 9

10 D - L onglet «Avancé» L onglet «Avancé» concerne : l activation du système antispam l'information contextuelle de l'antispam le texte personnalisé pour l'erreur de l'antispam la classe CSS spécifique à ce formulaire le chemin de sauvegarde des fichiers envoyés par le formulaire la taille maximale des fichiers joints l affichage ou non de la signature de CKForms ATTENTION : Si vous voulez utiliser l'antispam (Captcha), la librairie PHP «GD» doit être installé sur votre serveur PHP. Si vous avez un doute, il faut le demander à votre hébergeur. Page 10

11 E Liste des formulaires A partir de cette liste, vous pouvez : publier ou dé-publier des formulaires supprimer des formulaires éditer les formulaires en cliquant sur leur «Titre» ou leur «Nom»; créer un nouveau formulaire dupliquer un formulaire existant éditer la feuille de style associées aux formulaires faire un backup ou une restauration éditer les champs pour les réorganiser ou les modifier afficher les données sauvegardées Page 11

12 3. Les champs Pour afficher la liste des champs, il faut cliquer sur l'icône représentant les champs du formulaire dans la listes des formulaires. A - Propriétés communes à tous les types de champ Tous les types de champs du formulaires ont les propriétés suivantes qui doivent obligatoirement être complétés : un nom unique par formulaire, sans caractères spéciaux ni espaces. Vous ne pouvez pas utiliser des mots réservés de MySQL comme nom de champ. La liste de ces mots est disponible à l'adresse : un titre décrivant la fonction du champ à remplir choisir s il est publié ou non la classe CSS spécifique au libellé du champ la classe CSS spécifique au champ choisir le type de champ dans la liste déroulante le texte personnalisé associé au champ la classe CSS spécifique au texte personnalisé Page 12

13 B - Ajout d un champ «Texte» Le champ «Texte» consiste en un simple champ à remplir. Vous devez : choisir si son remplissage est obligatoire choisir si le champ est en lecture seule définir un texte pour la bulle d information (facultatif) définir un message d erreur personnalisé si le champ n est pas ou mal rempli (facultatif) définir le nombre de caractères maximum autorisés à être insérés dans le champ (facultatif) définir le nombre de caractères minimum devant être insérés dans le champ (facultatif) définir une valeur initiale qui remplira le champ (facultatif) choisir le type de données devant être inséré dans le champ (voir image ci-dessous). Ce choix conditionne la vérification du type de contenu 1 - Ajout d un champ «Mot de passe» Le champ «Mot de passe» est un champ «Texte» dont les caractères sont cachés lors de l'affichage du formulaire. 2 - Ajout d un champ « » Le champ « » est un champ «Texte» avec vérification d une écriture d (...@...). 3 - Ajout d un champ «Date» Le champ «Date» est un champ «Texte» avec vérification de la validité de la date ainsi que l'affichage d'un calendrier pour aider à la saisie de la date. 4 - Ajout d un champ «Nombre» Le champ «Nombre» est un champ «Texte» avec vérification que les données sont numériques. Page 13

14 C - Ajout d un champ «Hidden» Le champ «Hidden» n est pas visible dans le formulaire. Il permet de communiquer des informations particulières sur le formulaire ou un champ. Il peut être ajouté à différents endroits dans le formulaire et à plusieurs reprises, mais avec un nom unique. Vous pouvez choir de remplir automatiquement le champ «Hidden» avec un identifiant unique avec comme préfixe la valeur que vous avez indiqué dans «valeur». Page 14

15 D - Ajout d un champ «Textarea» Le champ «Textarea» est un champ destiné à accueillir un long texte, d où son nom. Il est possible d ajouter l éditeur activé par défaut dans Joomla!. Si vous n utilisez pas l éditeur, vous pouvez attribuer les éléments suivants : Colonnes, représentant le nombre de caractères avant un retour à la ligne si celui-ci est activé Lignes, représentant le nombre de lignes (hauteur affichée) du champ Activation du retour à la ligne (Wrap) o Défaut Identique à «Virtuel» o Désactivé Aucun retour à la ligne o Virtuel Retour automatique à la ligne en fin de largeur de l espace d affichage o Physique Enregistre en dur les retours à la ligne effectué par l utilisateur E - Ajout d une «Checkbox» Page 15

16 Le champ «Checkbox» permet à l utilisateur de cocher une option proposée. Vous pouvez l afficher cochée par défaut. F - Ajout de «Radio Button» Le champ «Radio Button» consiste en une série de boutons à sélectionner pour une question à choix. Vous pouvez : ajouter le nombre de boutons radio que vous souhaitez ; définir un bouton sélectionné par défaut. choisir l'affichage : en ligne ou dans une liste Page 16

17 G - Ajout d un «Select» Le champ «Select» fonctionne sur le même principe que les «Radio Button». Vous pouvez : afficher plusieurs lignes ; définir une ligne sélectionnée par défaut ; autoriser la sélection multiple. H - Ajout d un «Fichier transféré» Le champ «Fichier transféré» permet d envoyer un fichier avec le formulaire. Le fichier sera sauvé dans le répertoire qui a été défini dans les paramètres du formulaire créé. Page 17

18 I - Ajout d un «Bouton» Votre formulaire rempli, l utilisateur doit pouvoir le transmettre en utilisant le bouton «Submit». Il peut aussi effacer les champs par un bouton «Reset» si vous l ajouter. J - Ajout d un «Séparateur de champs» Le séparateur de champ permet de séparer des groupes de champs lors de l'affichage du formulaire. Vous pouvez afficher ou non la ligne du séparateur en utilisant la propriété : «Ligne invisible» Page 18

19 K - Liste des champs du formulaire Voici une liste des différents champs de formulaires que vous venez de découvrir. Vous pouvez en tout temps les réorganiser dans l ordre que vous souhaitez. Vous pouvez aussi dupliquer les champs que vous sélectionner dans la liste. Page 19

20 4. Les Données Si vous avez activé l enregistrement des données envoyées par les formulaires dans la configuration de vos formulaires, vous pouvez afficher et exporter ces données. Dans la liste des formulaires, vous pouvez afficher la liste des données sauvegardées en cliquant sur «Afficher les données». Vous pouvez : afficher le détail de chaque enregistrement supprimer des enregistrements exporter les données en format «csv» (lisible par les tableurs de type «Excel») A Afficher le détail En cliquant sur n importe quelle ligne, vous pouvez afficher les détails de l envoi. Page 20

21 B - Supprimer des enregistrements Vous pouvez supprimer des enregistrements en les sélectionnant dans la liste et en cliquant sur le bouton supprimer C Exporter les données Vous pouvez exporter les données en cliquant sur le bouton «Exporter». Le format des données est le «CSV» qui est compatible avec tout les tableurs et lisible par un éditeur de texte. Page 21

22 5. Édition de la feuille de styles CSS Vous pouvez personnaliser l'affichage de vos formulaire en éditant la feuille de styles CSS en cliquant sur le bouton «Edit CSS» dans la liste des formulaires. ATTENTION : Si vous avez modifié le fichier de style CSS, vous devez le sauvegarder manuellement avant de désinstaller le composant. Ce fichier se trouve à l'emplacement suivant : <joomla root>/components/com_ckforms/css/ckforms.css Cette sauvegarde sera intégrée dans le «backup» dans un version future. Page 22

23 6. Sauvegarder/restaurer des formulaires et leurs données A Sauvegarder des formulaires et leurs données CKForms propose une fonction de sauvegarde de vos formulaires, de leurs champs et des informations envoyées (si l option de leur enregistrement a été activée). Cette fonction sauvegarde, depuis la base de données, toutes les tables de CKForms dans un fichier au format «sql» qui peut être éditer avec n'importe quel éditeur de texte. B - Restaurer des formulaires et leurs données CKForms propose une fonction de restauration de vos sauvegardes de formulaires. Tous les éléments compris dans la sauvegarde seront restaurés (les formulaires, les champs et les éventuelles informations envoyées). ATTENTION : Lors d'une restauration des données à partir d'un fichier externe, les données existantes seront écrasées. Page 23

24 7. Affichage des formulaires Les formulaires peuvent s'afficher des façons suivantes : dans une page spécifique (dans un menu avec un lien) dans le contenu d'une page existante (comme plug-in) dans une partie particulière de la page (comme module) A Menu avec un lien sur un formulaire Dans le gestionnaire des menus de Joomla, choisissez le menu dans lequel vous voulez faire un lien vers un formulaire. Ensuite cliquez sur «Nouveau» pour ajouter un nouveau lien de menu. Vous pouvez choisir la position de votre lien dans le menu. Pour de plus amples informations concernant la gestion des menu dans Joomla, référez vous au manuel de Joomla. Choisissez «CK Forms» comme type d'élément du menu. Page 24

25 Choisissez le titre du menu et le formulaire dans la liste déroulante (pour les autres options, référez vous au manuel de Joomla). B Insérer un formulaire dans un article Pour insérer un formulaire dans un article vous devez avoir installé le plug-in «CKForms». Il doit être activé dans la gestion des plug-ins de Joomla! Choisissez si les titres des formulaires insérés doivent être affichés. N'oubliez d'activer le plug-in! Page 25

26 Si le nom du formulaire que vous voulez insérer dans l'article est «contact», alors la balise d'insertion sera : {ckform contact} C Utilisation d'un formulaire comme module Pour afficher un formulaire en tant que module vous devez créer un nouveau de type "CKForms form display" dans le gestionnaire de modules de JOOMLA. Choisissez le titre du module et le formulaire dans la liste déroulante (pour les autres options, référez vous au manuel de Joomla). Page 26

27 8. Affichage du formulaire Le formulaire affiché en frontal aura l'aspect suivant : Page 27

28 Pour toutes informations complémentaires : CKForms est une réalisation : Vous trouverez des informations supplémentaires sur le site du projet CKFORMS : Sur ce site vous pourrez remonter les bogues et vos suggestions. Ce document a été réalisé avec l'aide de Sarki Multimédia, son utilisation est libre, mais sa commercialisation est strictement interdite! Édition du La copie de texte et d image et verrouillée. Page 28