SPÉCIFICATION TECHNIQUE IMPORT XML UPMC

Transcription

1 SPÉCIFICATION TECHNIQUE IMPORT XML UPMC Rédigé par Examiné par Autorisé par Frederic Ravetier Gauthier Ubersfeld O.Prouvost Date 28/05/09 Identification AWT 09 UPMC WEB SPE 01 Version E

2 MODIFICATIONS Date Version Auteur Observations 02/06/09 A Frédéric Ravetier Création du document 05/06/09 B Frédéric Ravetier Ajout de l'id ddes étiquettes 25/06/09 C Frédéric Ravetier 27/10/2009 D/E Frédéric Ravetier Prise en compte des modification en cours d'implémentation et validation Divers corrections Mise à jour Ajout d'un nouveau gabarit TABLE DES MATIÈRES 1 INTRODUCTION OBJET DU DOCUMENT DÉFINITIONS, ACRONYMES ET ABRÉVIATIONS DOCUMENTS DE RÉFÉRENCES DESCRIPTION FORMAT DES DONNÉES FICHIER XML LES ÉTIQUETTES: CONTENT OU PAGE LES ÉTIQUETTES: IDENTIFIANT STOCKAGE EXPLORATEUR JCR EXEMPLE FICHIER XML ARBORESCENCE REMARQUES VERSIONS AFFECTATION DE CONTENU CONFIGURATION Evolutions 2009 UPMC AWT 09 UPMC WEB SPE 01 E Page 2 / 12

3 1 INTRODUCTION 1.1. Objet du document Ce document décrit le format de l'import et mise à jour de données à partir d'une source externe au format xml Définitions, acronymes et abréviations De nombreuses abréviations et acronymes sont utilisés dans le contenu de ce document : Sigle Définition XML Extensible Markup language 1.3. Documents de références ID Référence Titre document [DR1] PRC Evolutions 2009 UPMC AWT 09 UPMC WEB SPE 01 E Page 3 / 12

4 2 DESCRIPTION Cette fonctionnalité permet de : créer, mettre à jour et supprimer des pages de contenu d un site de manière externe. Ces pages doivent être complètes (contenu et métadonnées) et seront publiées directement (sans autre intervention). Ces pages sont disponibles via le moteur de recherche du site. La réalisation est : 1. Les fiches sont posées dans un répertoire prédéfini du CMS. 2. Les fiches sont des fichiers XML correspondant à un format de fichier définit dans le paragraphe suivant. Il contient une partie : métadonnées et contenu (correspond directement au format de stockage utilisé dans le CMS incluant des parties docbook ou XHTML directement utilisable pour affichage pour les champs libres) 3. Les fiches sont posées en suivant l arborescence désirée en sortie (des répertoires correspondent aux pages attendues ; des pages intermédiaires inexistantes donneront lieu à une erreur) 4. Une étape de synchronisation (exécutable manuellement ou automatisable dans le temps) supprime toutes les pages créées précédemment (repérées par une métadonnée spécifique) n ayant plus de fichier correspondant, crée les pages correspondant aux nouveaux fichiers, ou met à jour les pages correspondantes aux fichiers mis à jours. 5. Les pages gérées par synchronisation sont toutes marquées publiées dans le workflow. 6. Les pages gérées par ce système étant de vraies pages, elles sont normalement affichable dans le moteur de recherche. 7. Les erreurs sont loggués dans un fichier de log dédié à cette synchronisation. Par exemple : Dans un site où l arborescence est la suivante : Accueil Rubrique_1 Rubrique_2 Sous_rubrique_1_1 Sous_rubrique_1_2 Sous_rubrique_2_1 Le répertoire de synchronisation suivant : Synchro/default/fr/ Rubrique_1/ Sous_rubrique_1_1/ Mafiche1.xml Mafiche2.xml Donne après synchronisation l arborescence suivante : Accueil Rubrique_1 Rubrique_2 Sous_rubrique_1_1 Mafiche1 Mafiche2 Sous_rubrique_1_2 Evolutions 2009 UPMC AWT 09 UPMC WEB SPE 01 E Page 4 / 12

5 Sous_rubrique_2_1 Cette technique permet de synchroniser uniquement des types de contenus mode expert du CMS. La présentation est entièrement gérée par l UPMC. Il est nécessaire de lancer une génération pour que les nouveaux contenus soient affichés sur le site. 3 FORMAT DES DONNÉES 3.1. fichier XML Voici une description du format du fichier XML. Note sur l'encoding:?? <?xml version="1.0" encoding="utf-8"?> <xml> <!-- Contient les meta données tel que les étiquettes, l'auteur... --> <meta> <!--les meta du contenu--> <content> <!--login de l'auteur * --> <author></author> <!--Prénom et nom du rédacteur--> <redactor></redactor> <!--l'adresse du redacteur--> <redactormail></redactormail> <!--Le sujet * --> <subject></subject> <!--Le titre * --> <title></title> <!--Le titre long * --> <subtitle></subtitle> <!--Les mots-clés (séparés par des virgules) * --> <keywords></keywords> <!--La date de début de publication--> <startpublicationdate type="date"></startpublicationdate> <!--La date de fin de publication--> <endpublicationdate type="date"></endpublicationdate> <!--La date de dernière modification * --> <lastmodified type="date"></lastmodified> <!-- *--> <contenttype>com.anwrt.upmc.siteweb.plugins.experthtml.content</contenttype> <!-- Le text alternatif de l'image principale du contenu --> <alt-text></alt-text> <!--Les étiquettes--> </content> <!--Les metas de la page--> <page> <!--Le titre *--> <title></title> <!--Les étiquettes--> </page> Evolutions 2009 UPMC AWT 09 UPMC WEB SPE 01 E Page 5 / 12

6 <!--Les metas du lien entre une page et un contenu--> <pagecontent> <!--Le nom du template *--> <template></template> </pagecontent> <!-- Contient pour chaque langue la références vers la traduction de cette page. --> <translations> </translations> </meta> <!-- Contient le code XHTML du contenu de la page. Les références vers les images, l'explorateur de ressource doivent être correctement codés... --> <body> </body> </xml> Les dates sont données au format: yyyy-mm-dd't'hh:mm Exemple: T15:25 Les champs obligatoire sont marqués du caractère * dans les commentaires et surlignés en rouge. Si le champs n'est pas obligatoire, la balise doit être écrite mais le contenu peut-être vide Les étiquettes: content ou page Les étiquettes sont renseignés dans la partie meta et soit dans la partie page pour les étiquettes de type page soit dans la partie content pour les étiquettes de type content. Cette information peutêtre obtenue dans le module étiquette de l'espace de contribution, colonne Cible (ici le type d'étiquette est surlignée): Evolutions 2009 UPMC AWT 09 UPMC WEB SPE 01 E Page 6 / 12

7 La balise est formée par l'identifiant de l'étiquette, le contenu par la chaine empty. Exemple: <PLUGIN_TAGS_A_LA_UNE_RUBRIQUE>empty</PLUGIN_TAGS_A_LA_UNE_RUBRIQUE> Note: Les étiquettes sont stockés en base de données dans la table «Tags_Tag» et le type d'étiquette est dans la colonne «target» Les étiquettes: Identifiant Les étiquettes doivent être renseignés par leurs identifiants. Cette identifiant peut être récupéré à l'aide du module étiquette situé sur l'espace de contribution. Pour cela il suffit de cliquer sur une étiquette puis de cliquer sur modifier. L'identifiant est la chaine de caractères affiché a droite du mot «clé», entouré en jaune dans le screenshot suivant. Evolutions 2009 UPMC AWT 09 UPMC WEB SPE 01 E Page 7 / 12

8 Note: Les étiquettes sont stockés en base de données dans la table «Tags_Tag» et l'identifiant est dans la colonne «key_tag». Les catégories d'étiquettes sont stockés dans la tables «Tags_Category» Stockage Ce fichier sera stocké dans l'arborescence, le nom de fichier doit être composé de caractères compris dans [A-Z], [a-z], [0-9] et le caractère _ (une seule occurrence d'affilée). Au même niveau que ce fichier sera créé un répertoire portant le même nom que le fichier mais sans l'extension. Ce répertoire contient un répertoire _data, un répertoire _attachments, un répertoire _binary ainsi que les sous pages... Le répertoire _data contient les images, flash insérés dans la page. Le répertoire _attachments contient les pièces jointes. Le répertoire _binary contient un fichier nommé expert-image suivi de son extension dans le cas ou il y a une image principale pour ce contenu. Nous aurons ainsi MaFiche.xml MaFiche/ _data/ MonImage1.jpg MonFlash.swf _attachments _binary MaPieceJointe1.txt MaPieceJointe2.pdf expert-image.jpg Evolutions 2009 UPMC AWT 09 UPMC WEB SPE 01 E Page 8 / 12

9 3.5. Explorateur JCR L'explorateur JCR est un outil qui permet de parcourir la base de données JCR. Cette explorateur permet de voir en ligne le contenu de la partie <body> d'un contenu expert. Pour cela il suffit d'avoir créé une page avec un contenu expert et d'avoir inséré du contenu. URL: name>/_jcr, exemple: Il suffit de parcourir l'arborescence en commençant par «root» suivi du nom du site, de pages, de nom du site et de la langue, exemple: root > default > pages > default > fr, le tout suivi du chemin de la page dans l'arborescence. Le contenu est obtenu en cliquant sur le lien référencé par: anycontent-internal:pagecontent suivi de default suivi de anycontent:content. 4 EXEMPLE 4.1. Fichier XML <?xml version="1.0" encoding="utf-8"?> <xml> <meta> <content> <author>damioli</author> <redactor>cedric Damioli</redactor> <redactormail>cedric.damioli@anyware-tech.com</redactormail> <subject>la documentation scientifique</subject> <title>la documentation scientifique</title> <subtitle>la documentation scientifique</subtitle> <keywords>documentation,scientifique</keywords> <startpublicationdate type="date"> T10:33</startPublicationDate> <endpublicationdate type="date"> T10:00</endPublicationDate> <lastmodified type="date"> t15:35</lastmodified> <contenttype>com.anwrt.upmc.siteweb.plugins.experthtml.content</contenttype> <alt-text>vue de l'upmc depuis l'extèrieur</alt-text> <PLUGIN_TAGS_ACTUALITE_RUBRIQUE>empty</PLUGIN_TAGS_ACTUALITE_RUBRIQUE> </content> <page> <title>la documentation scientifique</title> <PLUGIN_TAGS_RUBRIQUE>empty</PLUGIN_TAGS_RUBRIQUE> </page> <!--Les metas du lien entre une page et un contenu--> <pagecontent> <!--Le nom du template--> <template>article</template> </pagecontent> <translations> <en>university/sciencedoc</en> </translations> </meta> <!-- Contient le code XHTML du contenu de la page. Evolutions 2009 UPMC AWT 09 UPMC WEB SPE 01 E Page 9 / 12

10 Les références vers les images, l'explorateur de ressource doivent être correctement codés... --> <body> <p>l'upmc propose désormais <a href=" ogrammes_internationaux_de_master.html">12 programmes internationaux de Master et 2 programmes internationaux de Licence</a>. </p> <p> </p> <p>les étudiants sélectionnés reçoivent une <strong>aide financière</strong> et une <strong>préparation linguistique</strong>. Les unités d enseignements (ECTS) que vous obtiendrez seront validées pour l obtention du diplôme que vous préparez à l UPMC. Vous serez <strong>exonéré des frais d inscription </strong>dans l université partenaire étrangère.</p> <p>je rajoute une image dans le texte: <img xmlns:i18n=" src="/editor_toureiffel.jpg" width="80" height="80" border="0" id="htmleditor-image-editor_toureiffel" ext=".jpg" type="img" alt="alt de l'image upmc atlantis"/></p> <p/> <p>je rajoute une image dans le texte à partir de l'explorateur de ressources: <img xmlns:i18n=" src="resources://images PAGE D'ACCUEIL/Images A LA UNE/13_simulation_numerique.gif" width="260" height="165" border="0" id="htmleditor-resourceimage " type="img" resource="images PAGE D'ACCUEIL/Images A LA UNE/13_simulation_numerique.gif"/></p> <p/> <p><a href="attachment://0/file/revuescientifique_ pdf">lien vers</a></p> <p></p> </body> </xml> Les images déposées dans le répertoire _data doivent respecter la nomenclature suivante: src= /editor_<nom de fichier>.<extension> Le fichier déposé dans data doit être <nom de fichier>.<extension> Remarque: il ne peut pas y avoir un fichier gif et un jpg qui ont le même nom de fichier dans le même répertoire _data. L'id de l'image doit avoir la nomenclature suivante: id="htmleditor-image-editor_<nom de fichier sans extension>" Les liens vers les pièces jointes doivent être de la forme : <a href="attachment://0/file/revuescientifique_ pdf"> Où RevueScientifique_ pdf est le nom du fichier dans le répertoire _attachments et 0 est le numéro de la pièce jointe dans le contenu, quand les fichiers de pièces jointes sont triés par ordre alphabétique. La numérotation commence à zéro. Par exemple, si le contenu possède trois pièces jointes, document.pdf est la pièce jointe numéro 0, revue.doc le numéro 1 et universite.xls le numéro 2. Note : le tri par ordre alphabétique utilisé est défini à l'adresse Evolutions 2009 UPMC AWT 09 UPMC WEB SPE 01 E Page 10 / 12

11 4.2. Arborescence Dans notre exemple, la page est situé sur le site default, dans la sitemap default, dans la langue Française et dans la rubrique Université. Ces fichiers sont situés dans le répertoire Synchro/default/default/fr/Université La_documentation_scientifique.xml La_documentation_scientifique/ _data/ toureiffel.jpg _attachments _binary RevueScientifique_ pdf expert-image.jpg 5 REMARQUES 5.1. Versions La synchronisation ne donnera pas lieu à la création d'une version sur un contenu. La version affichée pourra être différente de la version réelle si un utilisateur modifie un contenu et que le contenu à été synchronisé par la suite Affectation de contenu Un utilisateur ne doit pas changer l'affectation d'un contenu (fonction affecter un contenu du menu fichier) importé au risque d'avoir le contenu écrasé par la synchronisation Configuration Le chemin de dépôt est à configurer dans la configuration du CMS dans l'espace d'administration. Un droit à été ajouté pour lancer la synchronisation à l'aide d'une icône sur l'espace de contribution: «Synchronisation de contenus: Lancer la synchronisation». La synchronisation peut être lancée automatiquement pour chacun des sites. Cette option est configurable dans l'espace d'administration et dans la configuration de chaque site Gabarit Suite à la demande de la formation continue, Anyware à rajouté un nouveau gabarit «simple» pour les formations. Ce gabarit ne contient pas l'élément "Egalement dans la rubrique". Cette modification fait suite au JIRA UPMCSITE-953. Cela revient a mettre dans les fichiers XML: <xml> <meta>... <pagecontent> <template>simple</template> </pagecontent> </meta> Evolutions 2009 UPMC AWT 09 UPMC WEB SPE 01 E Page 11 / 12

12 ... </xml> Evolutions 2009 UPMC AWT 09 UPMC WEB SPE 01 E Page 12 / 12