Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

Guide de création de formulaires XML Conception réalisée pour le ministère du R

Guide de création de formulaires XML Conception réalisée pour le ministère du Revenu du Québec par Christian Rémillard, M.S.I. Yves Marcoux, Ph.D. <GRDS> - EBSI Groupe départemental de Recherche sur les Documents Structurés École de Bibliothéconomie et des Sciences de l'Information Université de Montréal 21 décembre 2001 Ce document est identifié par cet espace nominatif: http://grds.ebsi.umontreal.ca/2001/mrq/guide-creation-formulaires Guide de création de formulaires XML Table des matières 1 GÉNÉRALITÉS...............................................................................................................................................6 1.1 NORMES PRÉCONISÉES..........................................................................................................................6 1.2 GESTION ET NOMENCLATURE DES FICHIERS.........................................................................................6 Radical...................................................................................................................................................6 Suffixe....................................................................................................................................................7 2 MODÉLISATION............................................................................................................................................9 2.1 GÉNÉRALITÉS........................................................................................................................................9 2.1.1 Documentation..........................................................................................................................9 2.1.2 Entités générales (externes ou internes)...................................................................................9 2.2 ESPACES NOMINATIFS (NAMESPACE).....................................................................................................9 2.3 NOMENCLATURE DES COMPOSANTS DE SCHÉMAS..............................................................................10 2.3.1 Composants nommés..............................................................................................................10 2.3.2 Niveau lexical.........................................................................................................................10 2.3.3 Niveau sémantique..................................................................................................................11 2.3.4 Emploi d'abréviations.............................................................................................................12 2.4 MODÈLES DE CONTENU.......................................................................................................................13 2.4.1 Méta-schéma...........................................................................................................................13 2.4.2 Questions / Réponses..............................................................................................................13 2.4.3 Attributs..................................................................................................................................14 2.4.4 Modèles de contenu mixte......................................................................................................14 3 INFOGRAPHIE.............................................................................................................................................15 3.1 GÉNÉRALITÉS......................................................................................................................................15 3.2 STYLAGE CSS.....................................................................................................................................15 4 PROGRAMMATION WEB..........................................................................................................................17 4.1 FONCTIONNEMENT GÉNÉRAL..............................................................................................................17 4.1.1 Navigation...............................................................................................................................17 Navigation interne................................................................................................................................17 Navigation externe...............................................................................................................................17 4.1.2 Gestionnaire de la langue d'affichage.....................................................................................19 Marche à suivre...................................................................................................................................20 Exemple HTML de gestion de la langue d'affichage............................................................................20 4.1.3 Textes d'aide à la saisie...........................................................................................................21 Marche à suivre...................................................................................................................................21 Exemple HTML d'affichage de texte d'aide à la saisie.........................................................................21 4.2 VALIDATION........................................................................................................................................22 4.2.1 Gestionnaires de validation.....................................................................................................22 4.2.2 Scripts de validation...............................................................................................................22 4.2.3 Contrôles obligatoires.............................................................................................................23 Marche à suivre...................................................................................................................................23 Exemple HTML de contrôle obligatoire avec validation......................................................................24 4.3 LISTES OUVERTES................................................................................................................................24 4.3.1 Marche à suivre.......................................................................................................................25 Script JavaScript..................................................................................................................................25 Liste ouverte.........................................................................................................................................27 4.3.2 Exemple HTML de liste ouverte............................................................................................28 4.4 ZONES CONDITIONNELLES...................................................................................................................29 4.4.1 Marche à suivre.......................................................................................................................30 Feuille de style CSS..............................................................................................................................30 Script JavaScript..................................................................................................................................31 Zone conditionnelle..............................................................................................................................31 Page 2 sur 100 Guide de création de formulaires XML 4.4.2 Exemple HTML de zone conditionnelle.................................................................................33 4.5 ZONES RÉPÉTABLES.............................................................................................................................34 4.5.1 Marche à suivre.......................................................................................................................35 Script JavaScript..................................................................................................................................35 Zone répétable.....................................................................................................................................36 Section répétable..................................................................................................................................37 Contrôles de formulaire.......................................................................................................................37 Boutons associés à la zone...................................................................................................................38 4.5.2 Exemple HTML de zone répétable.........................................................................................40 5 CRÉATION DES FEUILLES XSLT............................................................................................................42 5.1 TRANSFORMATION D'INSTANCES XML...............................................................................................42 5.2 PARAMÉTRAGE DES FONCTIONS GÉNÉRALES......................................................................................42 Marche à suivre...................................................................................................................................42 5.3 CONTRÔLES DE FORMULAIRE..............................................................................................................44 5.3.1 La filiation..............................................................................................................................44 Marche à suivre...................................................................................................................................45 Exemple de traitement d'un contrôle....................................................................................................45 5.3.2 Les zones répétables...............................................................................................................46 Exemple de stylage XSLT d'une zone répétable....................................................................................47 5.3.3 Les éléments vides..................................................................................................................48 Marche à suivre...................................................................................................................................48 Exemple XSLT de contrôle pour un élément vide.................................................................................48 5.3.4 Contrôles obligatoires.............................................................................................................49 Marche à suivre...................................................................................................................................49 Exemple de stylage XSLT de contrôle obligatoire................................................................................49 5.3.5 Contrôles facultatifs................................................................................................................49 Marche à suivre...................................................................................................................................49 Exemple de stylage XSLT d'un contrôle facultatif................................................................................49 ANNEXE I. LISTE DES ABRÉVIATIONS...............................................................................................51 ANNEXE II. LISTES DES SÉLECTEURS CSS RÉSERVÉS...................................................................52 1. SÉLECTEURS UTILISÉS POUR LA NAVIGATION.....................................................................................52 2. SÉLECTEURS UTILISÉS POUR LA VALIDATION.....................................................................................52 3. SÉLECTEURS ASSOCIÉS À LA LANGUE D'AFFICHAGE...........................................................................53 4. SÉLECTEURS CSS ASSOCIÉS AU MODE D'AFFICHAGE..........................................................................54 5. SÉLECTEURS CSS ASSOCIÉS À L'ÉTAT DU FORMULAIRE.....................................................................54 6. SÉLECTEURS CSS ASSOCIÉS AU MÉDIA EMPLOYÉ...............................................................................54 ANNEXE III. LISTE COMPLÈTE DES LIVRABLES...............................................................................55 ANNEXE IV. LISTE DES SCHÉMAS XML................................................................................................56 1. REGISTRE/GOUV-QC/ADRESSE/_SCHEMA.............................................................................................56 2. REGISTRE/GOUV-QC/METADONNEE/_SCHEMA.....................................................................................58 3. REGISTRE/GOUV-QC/MRQ/EDI-ADE/PRODUCTION-DONNEE/FORMULAIRE-OPR-400-2000-09/_SCHEMA 72 4. REGISTRE/GOUV-QC/MRQ/EDI-ADE/PRODUCTION-DONNEE/_SCHEMA.................................................73 5. REGISTRE/GOUV-QC/MRQ/EDI-ADE/_SCHEMA......................................................................................73 6. REGISTRE/GOUV-QC/MRQ/_SCHEMA....................................................................................................75 7. REGISTRE/GOUV-QC/NOM/_SCHEMA....................................................................................................75 8. REGISTRE/GOUV-QC/SIGNATURE/_SCHEMA.........................................................................................76 9. REGISTRE/GOUV-QC/TELEPHONE/_SCHEMA.........................................................................................77 10. REGISTRE/GOUV-QC/_SCHEMA............................................................................................................77 ANNEXE V. LISTE DES COMPOSANTS DE STYLAGE.......................................................................79 1. REGISTRE/GOUV-QC/ADRESSE/_STYLAGE-ECRAN................................................................................79 Page 3 sur 100 Guide de création de formulaires XML 2. REGISTRE/GOUV-QC/MRQ/EDI-ADE/PRODUCTION-DONNEE/FORMULAIRE-OPR-400-2000- 09/_STYLAGE-ECRAN..................................................................................................................................79 3. REGISTRE/GOUV-QC/MRQ/EDI-ADE/PRODUCTION-DONNEE/_STYLAGE-ECRAN....................................80 4. REGISTRE/GOUV-QC/MRQ/EDI-ADE/_STYLAGE-ECRAN........................................................................80 5. REGISTRE/GOUV-QC/MRQ/_STYLAGE-ECRAN.......................................................................................81 6. REGISTRE/GOUV-QC/NOM/_STYLAGE-ECRAN......................................................................................81 7. REGISTRE/GOUV-QC/SIGNATURE/_STYLAGE-ECRAN............................................................................81 8. REGISTRE/GOUV-QC/TELEPHONE/_STYLAGE-ECRAN...........................................................................81 9. REGISTRE/GOUV-QC/_STYLAGE-ECRAN...............................................................................................82 ANNEXE VI. LISTE DES DOCUMENTS DE RÉFÉRENCE....................................................................84 1. REGISTRE/GOUV-QC/ADRESSE/_DOC-REFERENCE................................................................................84 2. REGISTRE/GOUV-QC/MRQ/EDI-ADE/PRODUCTION-DONNEE/FORMULAIRE-OPR-400-2000-09/_DOC- REFERENCE 84 3. REGISTRE/GOUV-QC/MRQ/_DOC-REFERENCE.......................................................................................84 ANNEXE VII. LISTE DES TYPES SIMPLES DU REGISTRE-RÉFÉRENTIEL DE DÉVELOPPEMENT LIVRÉ...........................................................................................................................85 1. HTTP://GRDS.EBSI.UMONTREAL.CA/REGISTRE/GOUV-QC.....................................................................85 2. HTTP://GRDS.EBSI.UMONTREAL.CA/REGISTRE/GOUV-QC/ADRESSE......................................................88 3. HTTP://GRDS.EBSI.UMONTREAL.CA/REGISTRE/GOUV-QC/METADONNEE..............................................92 4. HTTP://GRDS.EBSI.UMONTREAL.CA/REGISTRE/GOUV-QC/MRQ.............................................................95 5. HTTP://GRDS.EBSI.UMONTREAL.CA/REGISTRE/GOUV-QC/MRQ/EDI-ADE...............................................95 6. HTTP://GRDS.EBSI.UMONTREAL.CA/REGISTRE/GOUV-QC/MRQ/EDI-ADE/PRODUCTION-DONNEE..........97 7. HTTP://GRDS.EBSI.UMONTREAL.CA/REGISTRE/GOUV-QC/MRQ/EDI-ADE/PRODUCTION- DONNEE/FORMULAIRE-OPR-400-2000-09...................................................................................................97 8. http://grds.ebsi.umontreal.ca/registre/gouv-qc/nom...........................................................................97 Liste des tableaux Tableau 1 - Liste des sélecteurs CSS associés à un élément obligatoire............................................23 Tableau 2 - Liste des sélecteurs CSS associées à une liste ouverte...................................................28 Tableau 3 - Composants de stylage associées à une zone conditionnelle..........................................33 Tableau 4 - Valeur de l'ID selon le type de bouton d'une zone répétable..........................................39 Tableau 5 - Composants de stylage associés à une zone répétable....................................................40 Tableau 6- Exemple de codage de filiation d'une zone répétable......................................................47 Tableau 7 - Codes de positionnement pour un noeud XML..............................................................50 Tableau 8 - Liste des sélecteurs CSS utilisés pour la navigation.......................................................52 Tableau 9 - Liste des sélecteurs CSS utilisés pour la validation........................................................53 Tableau 10 - Liste des sélecteurs CSS associés à la langue d'affichage.............................................53 Tableau 11 - Liste des sélecteurs CSS associés au mode d'affichage................................................54 Tableau 12 - Liste des sélecteurs CSS associés à l'état du formulaire...............................................54 Tableau 13 - Liste des sélecteurs CSS associés au média employé...................................................54 Page 4 sur 100 Guide de création de formulaires XML Liste des figures Figure 1 - Diagramme du méta-schéma de formulaire......................................................................13 Figure 2 - Architecture des fichiers pour l'affichage avec cadres......................................................18 Figure 3 - Disposition des cadres......................................................................................................19 Figure 4 - Diagramme d'une structure de liste ouverte......................................................................25 Figure 5 - Stylage HTML d'une liste ouverte....................................................................................25 Figure 6 - Diagramme d'une structure de zone conditionnelle...........................................................29 Figure 7 - Stylage HTML d'une zone conditionnelle.........................................................................30 Figure 8 - Diagramme d'une structure de zone répétable...................................................................34 Figure 9 - Stylage HTML d'une zone répétable.................................................................................35 Page 5 sur 100 Guide de création de formulaires XML 1 Généralités1 1.1 Normes préconisées Utiliser la saveur XHTML 1.0 Transitional2 du World Wide Web Consortium (W3C) pour la création des gabarits. Utiliser la spécification CSS 23 du W3C pour le stylage des gabarits. Les fonctionnalités DHTML doivent être exprimées par le biais du modèle normalisé Document Object Model4 (DOM) du W3C et du langage de scriptage JavaScript. Les fichiers doivent utiliser le jeu de caractères ISO-8859-1. 1.2 Gestion et nomenclature des fichiers Les fichiers générés par le processus de création d'un formulaire sont versés dans le registre- référentiel de développement. Le lecteur voudra consulter le chapitre 5 Registre-référentiel XML du rapport XML en route au gouvernement du Québec5 à propos de l'architecture de registre-référentiel employée. Le nom de fichier d’un schéma est constitué d’un radical suivi d’un point, suivi d’un suffixe (voir ci-après). La forme générale d'un nom de fichier est: [nom composant de schéma].[indicateur de type].[add].[no version].[type fichier] radical suffixe RADICAL Le radical consiste en un nom d'un seul composant de schéma; Le radical est égal au nom du composant de schéma de plus haut niveau défini dans le schéma auquel s'adresse le fichier. Ce fichier peut contenir: 1 Les sections Généralités et Modélisation du présent guide constituent une mise à jour du Protocole de création de schémas v1.3 développé au Groupe départemental de Recherche sur les Documents Structurés (GRDS) de l'École de bibliothéconomie et des Sciences de l'Information (EBSI) durant l'année 2000 dans le cadre du projet « XML en route au Gouvernement du Québec ». 2 XHTML™ 1.0: The Extensible HyperText Markup Language est accessible à l'adresse suivante: http://www.w3.org/TR/2000/REC-xhtml1-20000126 3 Cascading Style Sheets, level 2 CSS2 Specification : http://www.w3.org/TR/1998/REC-CSS2-19980512 4 Document Object Model (DOM): http://www.w3.org/DOM 5 Ce document est accessible à partir du site du Conseil du trésor du Québec à l'adresse http://www.autoroute.gouv.qc.ca/publica/xml.pdf. Une version Word est également disponible à l'adresse: http://www.autoroute.gouv.qc.ca/publica/xml.doc. Généralités Guide de création de formulaires XML  un composant de schéma  un composant de stylage  un document de référence SUFFIXE Le suffixe est constitué d’un indicateur de type de schéma, suivi d’un point, suivi d'un additif facultatif, suivi d’un numéro de version, suivi de l’extension de fichier. Indicateur de type L'indicateur de type est requis.  Dans le cas d’un schéma définissant un « élément racine » (i.e., qui correspond à un document complet) dont l’identificateur générique contient déjà un numéro de version strictement contrôlé, le numéro de version et le point qui précède sont omis. Par exemple: formulaire-opr-400-2000-09.ct.xsd  L’indicateur de type est « st » lorsque le fichier contient un schéma dont la composante de plus haut niveau consiste en une définition de type simple (Simple Type) global. Par exemple: code-postal.st.1.xsd  L’indicateur de type est « el » lorsque le fichier contient un schéma dont le composant de plus haut niveau consiste en une définition d’élément. Par exemple: code-postal.el.1.xsd L’indicateur de type de schéma est « ct » lorsque le fichier contient un schéma dont le composant de plus haut niveau consiste en une définition d'un type complexe (Complex Type) global. Par exemple: adresse.ct.1.xsd L'indicatif de type est « aux » lorsque le fichier ne peut être associé à un composant de schéma. Par exemple: Page 7 sur 100 Généralités Guide de création de formulaires XML genererGenID.aux.1.xsl Additif L'additif est facultatif. L'additif est « val » lorsque le fichier contient un script de validation d'un type simple; L'additif est « tr » lorsque le fichier contient un script de transformation associé à un type simple. Numéro de version Le numéro de version est requis dans tous les cas à l'exception du fichier qui contient l'élément de plus haut niveau d'un formulaire. Ce numéro est celui de la version du fichier dans le registre-référentiel de développement. Extension de fichier L'extension de fichier est requise. Les extensions de fichiers utilisés dans le registre-référentiel de développement, au moment de sa livraison, sont: Extension de fichier Description bmp Image bitmap css Feuille de style CSS doc Document Microsoft Word gif Image GIF htm Instance HTML js Script JavaScript pdf Document Adobe Acrobat xml Instance XML xsd Schéma XML xsl Feuille de style XSLT Page 8 sur 100 Guide de création de formulaires XML 2 Modélisation 2.1 Généralités Les choix de modélisation doivent répondre aux besoins d'affaires pour lesquels le formulaire est créé. La modélisation à utiliser est de type « documentaire » et uploads/s1/ guide 7 .pdf