Les Ressources : 4D 2004 versus 4D v11 SQL Par Jesse PINA, Membre des Services techniques, 4D Inc. Note technique 4D-200810-21-FR Version 1 - Date 1 octobre 2008 Résumé Traduite de l'anglais par Rolande Courté, Chef de projet marketing, 4D SAS. 4D v11 SQL introduit une nouvelle architecture des ressources. Les ressources dans 4D v11 SQL utilisent un système basé sur des fichiers, ce qui diffère considérablement des versions précédentes versions de 4D qui utilisaient un système basé sur des "resources fork". Le système basé sur des "resources fork" étant progressivement abandonné, il est recommandé de mettre à jour toutes les ressources pour utiliser la nouvelle architecture. Des mécanismes de compatibilité ont été implémentés pour permettre aux ressources basées sur l'ancien système de continuer de fonctionner en 4D v11 SQL. Cette note technique traite de l'architecture en 2004 et en 4D v11 SQL. 4D Notes techniques Copyright 1985-2009 4D SAS - Tous droits réservés Tous les efforts ont été faits pour que le contenu de cette note technique présente le maximum de fiabilité possible. Néanmoins, les différents éléments composant cette note technique, et le cas échéant, le code, sont fournis sans garantie d'aucune sorte. L'auteur et 4D S.A. déclinent donc toute responsabilité quant à l'utilisation qui pourrait être faite de ces éléments, tant à l'égard de leurs utilisateurs que des tiers. Les informations contenues dans ce document peuvent faire l'objet de modifications sans préavis et ne sauraient en aucune manière engager 4D SA. La fourniture du logiciel décrit dans ce document est régie par un octroi de licence dont les termes sont précisés par ailleurs dans la licence électronique figurant sur le support du Logiciel et de la Documentation afférente. Le logiciel et sa documentation ne peuvent être utilisés, copiés ou reproduits sur quelque support que ce soit et de quelque manière que ce soit, que conformément aux termes de cette licence. Aucune partie de ce document ne peut être reproduite ou recopiée de quelque manière que ce soit, électronique ou mécanique, y compris par photocopie, enregistrement, archivage ou tout autre procédé de stockage, de traitement et de récupération d'informations, pour d'autres buts que l'usage personnel de l'acheteur, et ce exclusivement aux conditions contractuelles, sans la permission explicite de 4D SA. 4D, 4D Calc, 4D Draw, 4D Write, 4D Insider, 4ème Dimension, 4D Server, 4D Compiler ainsi que les logos 4e Dimension, sont des marques enregistrées de 4D SA. Windows,Windows NT,Win 32s et Microsoft sont des marques enregistrées de Microsoft Corporation. Apple, Macintosh, Power Macintosh, LaserWriter, ImageWriter, QuickTime sont des marques enregistrées ou des noms commerciaux de Apple Computer,Inc. Mac2Win Software Copyright 1990-2002 est un produit de Altura Software,Inc. 4D Write contient des éléments de "MacLink Plus file translation", un produit de DataViz, Inc,55 Corporate drive,trumbull,ct,usa. XTND Copyright 1992-2002 4D SA. Tous droits réservés. XTND Technology Copyright 1989-2002 Claris Corporation.. Tous droits réservés ACROBAT Copyright 1987-2002, Secret Commercial Adobe Systems Inc.Tous droits réservés. ACROBAT est une marque enregistrée d'adobe Systems Inc. Tous les autres noms de produits ou appellations sont des marques déposées ou des noms commerciaux appartenant à leurs propriétaires respectifs. 1 / 14
Les Ressources : 4D 2004 versus 4D v11 SQL Résumé 4D v11 SQL introduit une nouvelle architecture de ressources. Les ressources dans 4D v11 SQL utilisent un système basé sur des fichiers, ce qui diffère considérablement des versions précédentes de 4D qui utilisaient un système basé sur des "resources fork". Le système basé sur des "resources fork" étant progressivement abandonné, il est recommandé de mettre à jour toutes les ressources pour utiliser la nouvelle architecture. Des mécanismes de compatibilité ont été implémentés pour permettre aux ressources basées sur l'ancien système de continuer de fonctionner en 4D v11 SQL. Cette note technique traite de l'architecture en 2004 et en 4D v11 SQL. Une base de données exemple est incluse. Introduction Dans les précédentes versions de 4D, les ressources étaient définies en tant que «données de tout type stockées dans un format défini dans un fichier séparé ou dans une "resources fork" d'un fichier Macintosh». En 4D v11 SQL, les ressources sont à présent définies en tant que «fichiers nécessaires pour la traduction d'interfaces d'application». Ce changement se reflète dans la nouvelle architecture des ressources. Les ressources sont donc à présent basées sur des fichiers et non plus sur des "resources fork". Ce qui signifie que des ressources telles que des chaines, des images ou des icônes seront à présent stockées en tant que fichiers externes. Ce changement a été réalisé conformément aux standards Mac OS X. Pour Apple, l'ancien concept de ressources est obsolète et sera abandonné dans les futures versions de Mac OS X. Ressources dans 4D 2004 "resources fork" Dans 4D 2004, les ressources peuvent être stockées dans la "resources fork" du fichier de Données, la "resources fork" du fichier Structure ou dans la "data fork" d'un fichier distinct doté d'une extension.rsr (.4DR pour les fichiers de données). Par fichier distinct, on entend un fichier distinct du fichier de structure (.4DB) et du fichier de données (.4DD). Pour rappeler le contexte sur les "resources fork", dans de précédentes versions de 4D, les fichiers Macintosh étaient constitués d'une "data fork" contenant la donnée utilisateur et la "resources fork" contenant les ressources. Les "data fork" sont l'équivalent des fichiers Windows, mais les "resources fork" n'ont pas d'équivalent et généreraient des problèmes lors de transferts de va-et-vient entre les deux systèmes d'exploitation. Pour résoudre ce conflit, 4D 2004 stocke les ressources dans un fichier.rsr qui contient les données dans un format structuré. Depuis que ce fichier.rsr est en "data fork", il peut être transféré d'un système Macintosh à Windows et vice-versa sans souci. Ressources communes Voici une liste des ressources les plus courantes et comment on peut les utiliser : Type STR# STR TEXT PICT Cicn Définition Liste de chaines contient une liste de chaines Chaine- contient une chaine individuelle Texte contient une chaine texte sans longueur Image contient une image Quick Draw Mac Icône couleur contient une icône couleur Mac 2 / 14
Snd CURS WEDD 4DK# Son contient un son Curseur - contient la forme d'un curseur monochrome WEDD («Wedding») - contient la signature qui relie un fichier de données à un fichier de structure Constante personnalisée une expression avec une valeur fixe Note : Les types des ressources sont désignés par une chaine de quatre caractères. Si la ressource ne dispose que de trois lettres, un espace doit être ajouté à la fin du nom. Par exemple, la ressource STR est représentée par «STR». Par ailleurs, les types de ressources sont sensibles à la casse; text, Text et TEXT sont considérées comme des ressources différentes. Utilisation des ressources Dans 4D 2004, les ressources sont accessibles depuis des commandes du thème Ressources ou directement depuis un Menu, une Liste, une variable, un bouton, etc. Commandes Voici les commandes du thème Ressources qui sont utilisées pour obtenir le contenu des différentes ressources : Commande Lire ressource chaine Lire chaine dans liste Lire ressource texte LIRE RESSOURCE IMAGE LIRE RESSOURCE ICONE LIRE RESSOURCE Description Retourne la chaîne stockée dans la ressource chaîne ("STR") dont vous avez passé le numéro ID Retourne l'une des chaines stockées dans la liste de ressources de chaines ("STR#") dont vous avez passé le numéro ID et le numéro d'index Retourne le texte stocké dans la ressource texte («TEXTE») dont vous avez passé le numéro ID Retourne l'image stockée dans la ressource image («PICT») dont vous avez passé le numéro ID Retourne l'icône stockée dans la ressource icône couleur ("cicn") dont vous avez passé le numéro ID Retourne un blob contenant le contenu de la ressource dont le type et le numéro ont été passés Pour disposer de la liste complète des commandes sur le thème des Ressources, merci de consulter le manuel de Langage 4D 2004. L'utilisation de ces commandes est relativement simple. Par exemple, la ligne de code suivante retourne la chaine stockée dans la ressource 15000 : C_ALPHA(80;$maRessource) $maressource:=lire ressource chaine (15000) 3 / 14
Ces commandes sont communément utilisées pour remplacer les contenus de texte ou d'images, mais peuvent être également utilisées à d autres fins, tels que fixer un curseur ou jouer un son. Utilisation directe La syntaxe pour utiliser une ressource dans un objet formulaire est : ":Numéro Ressource, Numéro Elément". Par exemple, pour utiliser l'élément 5 de la ressource chaine 15000, vous utiliserez la syntaxe : ":15000,5". Cette syntaxe peut être utilisée dans n'importe quelle zone de texte. Ceci inclut les éléments suivants : Objets textes Noms de bouton Titres de fenêtres Menus (et lignes de menu) Eléments de listes Bulles d'aide Ressources dans 4D v11 SQL Dans 4D v11 SQL, les ressources sont donc à présent basées sur des fichiers. Plutôt que de stocker les ressources dans des fichiers.rsr, elles sont à présent stockées dans des fichiers individuels. Voici un résumé rapide sur la façon dont sont stockés les différents types de ressources : Type STR# STR TEXT Nouvel emplacement Toutes les chaînes sont à présent stockées dans des fichiers XLIFF placés dans le dossier Resources. PICT cicn CURS Toutes les images sont à présent stockées en tant que fichiers indépendants et placées dans le dossier Resources. 4DK# Toutes les constantes personnalisées doivent être stockées dans des plug-ins Chaines Toutes les ressources chaînes devraient à présent être stockées dans des fichiers XLIFF. XLIFF est un format basé sur du XML qui a été développé pour standardiser la localisation. Pour les développeurs du site web Sun, le format XLIFF aide à : Séparer le texte localisable du format ; Permettre à de multiples outils de travailler sur des chaines sources et cibles ; Stocke l'information qui est utile dans une gestion de processus de localisation. 4 / 14
Plus d'informations sur les XLIFF sont disponibles à l'adresse suivante : http://developers.sun.com/dev/gadc/technicalpublications/articles/xliff.html Voici un exemple basique d'un fichier XLIFF : <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE xliff PUBLIC "-//XLIFF//DTD XLIFF//EN" "http://www.oasis-open.org/committees/xliff/documents/xliff.dtd"> <xliff version="1.0"> <file datatype="x-str#" original="undefined" source-language="en" targetlanguage="fr"> <body> <group id="1000" resname="interface"> <trans-unit id="1" resname="button_ok"> <source>ok</source> <target>valider</target> </trans-unit> <trans-unit id="2" resname="button_cancel"> <source>cancel</source> <target>annuler</target> </trans-unit> </group> </body> </file> </xliff> Pour mieux comprendre ce fichier, voici une description des éléments importants au sein d'un fichier XLIFF : Balise : <file> Cet élément correspond à un simple extrait d'un document original. Cette balise spécifie le début du contenu utilisable. Attributes: source-language - La langue pour les éléments <source> dans l'élément <file> donné. target-language - La langue pour les éléments <target> dans l'élément <file> donné. Balise : <group> Cet élément spécifie un ensemble d éléments qui devraient être gérés ensemble. Attributes: ID Utilisé pour identifier de façon unique le <group> au sein du même <file>. resname Nom de la ressource ou identifiant d'un item. Balise : <trans-unit> Cet élément contient une <source>, <target> et des éléments associés. Attributes: ID Utilisé pour identifier de façon unique le <trans-unit> au sein de tous les éléments <trans-unit> au sein du même <file>. resname Nom de ressource ou identifiant d'un item. Balise : <source> Utilisé pour délimiter une unité de texte qui peut être un paragraphe, un titre, un élément de menu, une légende, etc. Balise : <target> Cet élément contient la traduction du contenu de l'élément <source>. 5 / 14
Images Toutes les images seront à présent stockées dans des fichiers individuels et placés dans le dossier Resources. Les fichiers image peuvent être placés dans le dossier Resources ou dans un autre dossier au sein du dossier Resources. Par ailleurs, ces fichiers peuvent être ajoutés au dossier Resources via le nouvel Explorateur de Ressources dans la Boite à outils : Depuis ce nouvel Explorateur de Ressources, vous pouvez procéder aux actions suivantes : ajouter des ressources supprimer des ressources créer des dossiers renommer des ressources mettre à jour des ressources locales* notifier des clients* *ces actions sont des opérations réalisées en mode client-serveur Voici un exemple d'un dossier "Resources" contenant deux autres dossiers, chacun avec leur propre définition de fichiers image : Fichier système : 6 / 14
Explorateur de ressources : 7 / 14
Ce nouvel Explorateur de Ressources supporte aussi le glisser-déposer. Pour ajouter un fichier image ou plusieurs fichiers image, glissez-les simplement dans l'explorateur de Ressources. Si vous avez créé des dossiers au sein de l'explorateur de Ressources, vous pouvez déposer les images dans un dossier spécifique. Les fichiers peuvent aussi être ajoutés dans le dossier de destination sur le disque. N'importe quel fichier peut être ajouté, modifié, ou enlevé simplement en travaillant sur le fichier sur le disque. Voici un exemple dans lequel un dossier nommé "MenuImage" a été créé dans le dossier Resources et ce dossier contient un fichier image, flags.jpg : Après avoir ajouté le dossier et l'image dans le dossier "Resources", vous pouvez constater ces changements dans l'explorateur de Ressources : 8 / 14
Note : Les fichiers peuvent être ajoutés dans le dossier Resources situé sur le disque pendant que l'application fonctionne. Si votre base est en fonctionnement et que l'explorateur de Ressources est affiché, vous devrez recharger l'explorateur de Ressources pour visualiser la modification. Soit vous fermez et vous réouvrez la boite à outils, soit vous vous déplacez sur un onglet différent et retournez ensuite sur l'explorateur de Ressources. Constantes Tout comme en 2004, les constantes personnalisées seront stockées dans des "data.fork" dans un fichier.rsr. En revanche, en 4D V11 SQL, les fichiers.rsr contenant les constantes personnalisées doivent à présent être stockés dans des plug-ins. Un plug-in, «User Constants.bundle», a été mis à disposition pour faciliter la création de constantes personnalisées dans 4D v11 SQL (un plug-in est également inclus dans cette Note Technique). Voici les étapes pour déplacer une constante personnalisée de 4D 2004 à 4D v11 SQL : 1. Ouvrir votre fichier de ressources 4D 2004 qui contient vos ressources 4DK# avec un éditeur de ressources, tel que Rezilla ou Resorcerer. 2. Ouvrir les fichiers ressources User Constant.bundle qui se trouve dans le plug-in. Ces fichiers se trouvent dans les endroits suivants : - Mac OS - User Constants.bundle\Contents\Resources\User Constants.rsrc - Windows - User Constants.bundle\Contents\Windows\User Constants.rsr 3. Copier les ressources 4DK# depuis le fichier de ressources 2004 dans les fichiers User Constants. 4. Déplacer le User Constants.bundle dans le dossier Plugins au sein de votre base de données. Une autre option consiste à utiliser le composant 4D Pop Migration incluant une option permettant de faire migrer les constantes. Il y a également le 4D Pop Constants Editor qui fournit un éditeur pour créer des constantes dans 4D v11 SQL. 9 / 14
Compatibilité des ressources dans 4D V11 SQL A des fins de compatibilité et pour permettre progressivement l'adaptation d'applications existantes, les précédents mécanismes continueront de fonctionner en 4D v11 SQL, avec les exceptions suivantes : Les ressources personnalisées dans les fichiers.rsr sont toujours accessibles tout comme en 4D 2004, mais les fichiers.rsr doivent être déplacés dans un dossier Resources au sein de la base de données. Aussi la structure du fichier de ressources ne sera pas créée automatiquement pour des bases de données créées en 4D v11 SQL. Cependant, si la structure d'un fichier de ressources (mabasededonnées.rsr) est manuellement créé et présente à côté du fichier de structure (mabasededonnées.4db), il sera automatiquement chargé, tout comme en 4D 2004. Les ressources de 4D et les ressources système ne sont plus accessibles Note : Alors que la plupart des fonctionnalités liées aux ressources sont toujours disponibles dans 4D v11 SQL, nous recommandons de migrer vers la nouvelle architecture. Base de données exemple 4D 2004 La base de données incluse est un exemple d'application localisée. La localisation est définie comme l'adaptation des applications en différentes langues. Une base de données localisée fournit un bon exemple pour l'utilisation de ressources, car cela requiert que tous les objets au sein d'une interface d'application soient dynamiques. Structure Cette base de données est constituée d'une fenêtre contenant 2 onglets et la totalité du contenu des formulaires, des listes, et des menus est constituée de ressources. Ces ressources sont toutes contenues dans 2 fichiers de ressources : autresressources.rsr et mesresources.rsr. Il y a 4 différents fichiers mesresources.rsr ; chacun contenant du texte dans une langue différente. Les 4 fichiers ressources ont tous le même nom et sont inclus dans des dossiers séparés. Si cette base de données doit être déployée en différentes langues, le développeur inclura le fichier mesresources.rsr correspondant à chaque langue spécifique. Note : Il y a différentes options pour localiser une application. La méthode utilisée dans la base exemple constitue juste une de ces options. Utilisation La base de données se lance en version anglaise avec le fichier mesresources.rsr contenu dans le dossier Extras. Si la base de données est ouverte dans ces conditions, vous constaterez que tous les éléments d'interface sont en anglais. Par exemple : 10 / 14
Onglet 2 Mode menu 11 / 14
Pour passer en langue anglaise, remplacer le fichier mesresources.rsr par une copie de la version anglaise. Une fois ceci fait, tous les éléments d'interface seront visibles en anglais. Onglet 1 Onglet 2 Mode menu 12 / 14
Cet exemple ne produit rien de fonctionnel ; il démontre simplement comment tous les éléments d'interface peuvent être remplacés par des ressources avec le minimum de code. Base de données exemple 4D v11 SQL convertie Cette base de données a été convertie depuis une version 4D 2004. Aucun autre changement n'a été effectué dans cette base de données. Cet exemple a été fourni pour démontrer ce qui se produit dans des bases de données 4D 2004 qui contiennent des ressources, les fonctions ayant été converties en 4D v11 SQL. Du fait des fonctionnalités de compatibilité apportées en 4D v11 SQL, les fonctions de la base de données sont les mêmes qu'en version 2004. Les ressources utilisées dans l'interface sont utilisées et affichées exactement comme en 2004. Base de données exemple 4D v11 SQL mise à jour Cette base de données a été convertie en 4D 2004 et intègre la nouvelle architecture de ressources. Au-delà de l'actuelle conversion de 4D 2004 en 4D v11 SQL, voici les étapes suivies lors de la mise à jour de la base de données : Tous les fichiers de ressources ont été déplacés dans le dossier Resources au sein du dossier database. Toute la liste de ressources chaînes et les ressources texte ont été déplacées dans des fichiers XLIFF. Ceci peut être effectué de différentes façons : 1/ Par programmation : Ce qui signifie par extraction des anciennes chaines grâce à la commande LISTE DE CHAINES VERS TABLEAU et ensuite par utilisation des commandes XML 4D pour créer des fichiers XLIFF. 2/ En utilisant le composant 4D Pop XLIFF pour transférer des listes de chaines dans des fichiers XLIFF. Cette méthode a été utilisée pour mettre à jour cette base de données exemple. Ce composant et les instructions pour savoir comment l'utiliser sont disponibles ici : http://www.4d.fr/products/4dpop.html Toutes les ressources texte ont été déplacées dans un document XLIFF dédié à cette langue. Toutes les images ont été remplacées par les fichiers image actuels placés dans le dossier Resources. Le code a été modifié de façon à ouvrir les fichiers du dossier Resources, au lieu du dossier Extras. Les objets d'interface n'ont en aucun cas été modifiés. Des modifications ont été réalisées sur les ressources actuelles en elles-mêmes. Quelques modifications mineures de programmation ont été également apportées. Aussi, avec la nouvelle architecture, tous les fichiers ressources peuvent coexister dans le dossier Resources. En version 2004, les fichiers.rsr nécessitent d'être copiés manuellement de façon à changer la langue. Avec la version mise à jour, la base de données choisira automatiquement le fichier XLIFF approprié basé 13 / 14
sur la langue du système d'exploitation. Par exemple, dans Mac OSX, de façon à voir cette version de la base de données en français, accédez aux Préférences Systèmes - > International et changez la langue en «Francais». Pour plus d'information concernant cette fonctionnalité, merci de consulter le manuel Référence 4D v11 SQL. Conclusion Les ressources permettent aux développeurs de créer des interfaces d'application dynamiques, ce qui est extrêmement utile lorsque l'on gère des sujets tels que la localisation. Le système basé sur des fichiers 4D v11 SQL est une solution plus rapide pour stocker des ressources. Ce système fournit plus de contrôle sur les ressources et leur contenu et aussi s'aligne sur les standards. A présent que vous connaissez les différences entre les ressources en 4D 2004 et 4D v11 SQL, vous pourrez prendre une décision plus avisée pour savoir quand et comment mettre à jour vos ressources avec le nouveau système de ressources. Ressources liées Manuel de référence 4D v11 SQL : http://www.4d.fr/support/docs.html Composants 4D Pop : http://www.4d.fr/products/4dpop.html Spécification XLIFF Version 1.2 : http://docs.oasis-open.org/xliff/xliff-core/xliff-core.html 14 / 14