Création de contenus avec WebJaxe


Introduction

Le CMS WebJaxe est inclu dans PAELLOS, et permet la création collaborative de documents XML avec le langage XPAGES. Une transformation automatique permet de transformer ces documents en site web. Cette transformation peut s'effectuer directement dans WebJaxe pour obtenir un aperçu destiné aux auteurs, ou avec l'interface d'administration de la plateforme pour générer le site de formation des étudiants et le site des tuteurs.


Guide administrateur

Auteurs: Damien Guillaume, Konstantin Tcholokachvili, Soufiane Ayadi

Le compte administrateur

Le compte de l'administrateur est créé au moment de l'initialisation. Il est possible de modifier les champs de ce compte avec la gestion des utilisateurs.

Par la suite, on supposera que vous êtes connectés au site comme administrateur, ce qui permet d'atteindre des fonctions d'administration.


Paramètres et désinstallation

ecrans_webjaxe/parametres.png
Paramètres du site

La page des paramètres permet de modifier les paramètres suivants :

remarqueAstuce

Il est possible d'utiliser "../.." au lieu de "sites" pour le nom du dossier des sites, afin de générer les sites directement à la racine du serveur web (en supposant que le dossier webjaxe se trouve à la racine). Attention cependant aux conflits possibles avec les noms de dossiers.

Désinstallation

Pour supprimer la base de données et les contributions, il suffit de cliquer sur le bouton "Désinstaller WebJaxe". Attention, l'effet est immédiat !

Une fois ceci fait, il ne reste plus qu'à jeter le dossier de WebJaxe sur le serveur pour s'en débarasser complètement.


Validation des demandes de compte et gestion des utilisateurs

ecrans_webjaxe/utilisateurs.png
Gestion des utilisateurs

Chaque demande d'inscription est enregistrée dans la base de données, mais les utilisateurs ainsi inscrits ne peuvent pas se connecter avant que l'administrateur ne valide l'inscription. Si l'administrateur refuse l'inscription, celle-ci est effacée.

Le tableau "Demandes d'inscriptions" de la page "Gestion des utilisateurs" donne la liste des utilisateurs ayant demandé une inscription, et permet d'autoriser ou non chaque inscription.

A partir de la page de gestion des utilisateurs, il est aussi possible de :


Gestion des projets

ecrans_webjaxe/projets.png
Gestion des projets

La page de gestion des projets permet de créer de nouveaux projets, importer, exporter un projet, et de modifier la liste de contributions et de participants pour chaque projet. Il n'y a pas de lien direct entre les contributions et les utilisateurs: les liens passent par les projets.

L'administrateur peut organiser les projets sous forme d'un arbre, ce qui est pratique quand il y a un grand nombre de contributions. Pour changer l'arborescence, il faut cliquer sur le bouton "Sous-projets" du projet parent dans la page de gestion des projets. On peut alors changer la liste des sous-projets pour ce projet. Un utilisateur associé à un projet est implicitement associé à tous les projets descendants. Un export du projet parent contiendra l'ensemble des contributions du projet parent et des projets descendants.


Gestion des contributions

ecrans_webjaxe/contributions.png
Gestion des contributions

Chaque contribution est associée à un projet et un seul.

La page de gestion des contributions liste chaque contribution, et permet pour chacune de changer le projet associé, de l'éditer, de la supprimer, de la renommer, et de l'exporter.

Des formulaires en bas de la page permet de créer ou d'importer une contribution.

Cette page permet aussi d'éditer une contribution (en redirigeant vers la partie "utilisateur" de WebJaxe), et de supprimer une contribution.


Ajouter une nouvelle configuration

WebJaxe est livré avec une configuration pour le langage XML "XPAGES", et une autre pour le langage XML "XHTML strict 1.0". Il est possible d'ajouter de nouvelles configurations pour éditer des documents dans d'autres langages XML, et générer des sites correspondants.

Pour ajouter une nouvelle configuration, qu'on appelera par exemple "MACONFIG", il faut :


Guide utilisateur

Auteurs: Damien Guillaume, Soufiane Ayadi

Inscription au site

ecrans_webjaxe/inscription.png
Inscription sur un site WebJaxe

Pour participer à la réalisation d'un site avec WebJaxe, il est d'abord nécessaire de s'inscrire. Il suffit pour cela d'aller à la page d'inscription (il existe un lien à partir de la page d'entrée), et de remplir les différents champs.

Le login est un identifiant vous identifiant de façon unique. On choisit son login, mais (contrairement à l'entrée du prénom et du nom) on ne peut utiliser pour le login que des lettres de a à z, sans espace ni caractère spécial.

Choisissez un mot de passe original, mais ne le perdez pas ! Au pire on peut demander de l'aide à l'administrateur en cas de perte, mais ce n'est pas instantané.

Une fois l'inscription soumise, l'administrateur du site pourra valider (ou non) votre inscription. C'est seulement une fois que l'inscription est validée par l'administrateur que l'on peut se connecter, en utilisant le login et le mot de passe choisis.


Connexion

connexion.png
Connexion à un site WebJaxe

Pour la connexion, il suffit d'entrer le login et le mot de passe choisis au moment de l'inscription.


Les contributions

ecrans_webjaxe/liste_contribs.png
Liste des contributions

La création d'un site se fait avec un ensemble de contributions. Une contribution correspond à un ensemble de pages sur un sujet donné (en général moins de 10 pages). Une contribution comprend un fichier XML avec le texte des pages, et des fichiers d'images utilisées dans les pages.

Certaines contributions servent juste à lier d'autres contributions entre elles. Par exemple, on peut créer une contribution correspondant au site que l'on veut créer, et cette contribution ne contiendra que des liens vers d'autres contributions.

Les contributions sont organisées en projets. Un projet regroupe des contributions et des auteurs sur un même sujet. Tous les auteurs du projet peuvent éditer toutes les contributions du projet.

En tant qu'utilisateur, vous pouvez créer un nouveau projet, une nouvelle contribution, et éditer les contributions créées par d'autres utilisateurs si ces contributions sont dans un projet dont vous êtes auteur. L'administrateur peut ajouter des auteurs ou des contributions à un projet.

Il est possible d'exporter un projet à partir de la liste des contributions. Cette opération permet de télécharger un fichier ZIP contenant une copie de l'ensemble des contributions du projet.


Nouvelle contribution

ecrans_webjaxe/nouvelle-contribution.png
Nouvelle contribution

Il existe deux méthodes de création d'une nouvelle contribution dans WebJaxe: la création d'une contribution vide, et l'import d'une contribution existante. Dans les deux cas, il faut préciser le projet associé et la configuration Jaxe utilisée (qui correspond au langage XML).

Dans le cas d'un import, le fichier envoyé doit être un fichier ZIP avec le nom de la contribution. Ce fichier ZIP doit contenir un dossier avec le nom de la contribution, contenant un fichier XML avec le nom de la contribution. On peut par exemple avoir un fichier "ma-contribution.zip" contenant un dossier "ma-contribution" avec un fichier "ma-contribution.xml" à l'intérieur.

Comme l'export de contributions utilise la même organisation, il est facile d'exporter une contribution à partir d'un site WebJaxe et de l'importer dans un autre site.


Opérations sur une contribution

ecrans_webjaxe/operations_contrib.png
Opérations possibles sur une contribution

Il y a 10 opérations possibles sur une contribution :


Edition d'une contribution

ecrans_webjaxe/jaxe.png
L'édition avec Jaxe

L'éditeur de WebJaxe nécessite Java 1.6 ou ultérieur. Il peut donc être nécessaire d'installer Java si ce n'est pas déjà fait. L'éditeur s'ouvre dans une nouvelle fenêtre. Il faut faire attention à ne pas fermer la fenêtre d'origine dans le navigateur, car cela ferait disparaître la fenêtre d'édition sans possibilité de sauvegarde.

remarqueRemarque

Il existe un bug dans Firefox et certains autres navigateurs qui empêche la lecture des fichiers XML si l'option "Accepter les cookies tiers" est désactivée. Avec ces navigateurs, il faut donc activer cette option dans les préférences pour pouvoir utiliser l'éditeur. Une autre solution consiste à ajouter une "exception" dans la gestion des cookies pour toujours autoriser les cookies venant du serveur de WebJaxe.

L'éditeur fonctionne avec le méta-langage XML, et les textes entrés sont donc organisés avec des balises de début et de fin. Chaque bout de texte est encadré par des balises qui lui donnent du sens. On peut insérer de nouveaux éléments avec les menus, ou avec le panneau d'insertion à gauche de la fenêtre. Le panneau d'insertion n'affiche que les éléments autorisés à l'emplacement du curseur, ce qui permet d'éviter de créer un document invalide, c'est à dire ne respectant pas les règles du langage XML choisi.

Les éléments disponibles, ainsi que les règles d'arborescence des éléments, sont définis par le langage XML choisi par l'administrateur. Il est important de connaître le langage que l'on utilise pour bien utiliser l'éditeur. Une documentation spécifique existe pour le langage XPAGES, dont la configuration WebJaxe est fournie avec WebJaxe.

Il existe une documentation utilisateur pour l'application Jaxe, qui s'applique aussi à l'éditeur de WebJaxe. Il y a cependant certaines fonctions qui n'existent pas dans WebJaxe. D'autres fonctionnalités sont désactivées à cause des restrictions de sécurité que les navigateurs imposent aux applets Java. En particulier le copier-coller, comme expliqué ci-dessous.

Effectuer des copier-coller

Par défaut, les applets Java n'ont pas le droit de lire le presse-papier du système. Cela signifie en général que l'on ne peut pas faire de copier-coller depuis une autre application. Il existe deux méthodes pour contourner ce problème :


Les fichiers associés

ecrans_webjaxe/fichiers_associes.png
Gestion des fichiers associés

Cette page permet de gérer les fichiers associés d'une contribution, c'est à dire en général les fichiers des images que l'on utilise lors de l'édition de la contribution. Il est possible d'organiser ces fichiers avec des répertoires. Pour ajouter un nouveau fichier, il suffit de cliquer sur le bouton correspondant, de choisir le fichier sur son disque local, et de cliquer sur le bouton "Ajouter". Il s'affiche alors dans la liste des fichiers du répertoire courant.

Une fois un fichier d'image ajouté, il est possible de l'utiliser au moment de l'édition. Par exemple, avec le langage XPAGES, on ajoute une image en créant d'abord un "Environnement d'image", puis en mettant un "Fichier" dedans. Comme nom du fichier, on indique le chemin vers le fichier de l'image dans la contribution, par exemple "logo.png". L'image s'affiche alors dans l'éditeur.


Historique des modifications

ecrans_webjaxe/historique1.png
Opérations sur une contribution:Historique des modifications

Le bouton Historique des modifications s'affiche quand le document XML est modifié.

ecrans_webjaxe/historique2.png
Historique des modifications

Chaque historique est suivi par le login de l'auteur qui l'a modifié.

ecrans_webjaxe/historique3.png
Comparaison avec la dernière version

Vous pouvez comparer les versions du document XML, et de visualiser les différences entre chaque version du document et la dernière version.

ecrans_webjaxe/historique4.png
Différences entre chaque version du document et la dernière version

Préférences

ecrans_webjaxe/preferences.png
Préférences d'utilisateur: Changer la langue, le mot de passe ou l'email

Cette page permet de:


Recherche

ecrans_webjaxe/recherche.png
Faire une recherche

Cette page permet à l'utilisateur de rechercher un mot-clé dans toutes les contributions d'un projet


Le langage XPAGES

Auteur: Damien Guillaume

Introduction

introductionIntroduction

XPAGES permet de créer rapidement et facilement des sites web. Le principe sur lequel repose XPAGES est la séparation du contenu et de la forme : avec XPAGES, on spécifie un contenu (texte, images, animations), et on le structure en donnant un sens à chaque partie. A l'édition, on ne préoccupe absolument pas de la façon dont le contenu sera affiché plus tard, ce qui permet de gagner du temps et de ne pas mélanger le sens avec la forme. La façon dont le contenu sera affiché est spécifié séparément, par des feuilles de style. Il est ainsi possible de changer l'affichage indépendamment de l'édition.

XPAGES est un langage XML, c'est à dire un ensemble d'éléments et de règles permettant de structurer un texte. Des feuilles de style associées permettent de transformer automatiquement des documents XPAGES en fichiers HTML pour qu'ils puissent être consultés sur le web. Les documents XPAGES peuvent être édités avec Jaxe et WebJaxe grâce à un fichier de configuration décrivant une interface d'édition.

XPAGES est un langage très simple, et facile à apprendre : il ne comporte que 59 éléments (46 sans les exercices), à comparer par exemple aux 91 éléments de HTML, aux 390 éléments de DocBook, ou aux 526 éléments de OpenDocument.


La structure des documents

Organisation
org_xpages.png

Les documents XPAGES comportent un élément racine, Ensemble XPAGES, qui est utilisé dans tous les documents comme élément de premier niveau. Sous cet élément, on trouve les éléments Informations, Page, Réf. document XPAGES et Ensemble XPAGES.

A l'intérieur d'une page, il est possible de créer des sections avec l'élément Section. Cet élément comporte un titre, un rôle qui spécifie le sens de la section et peut permettre un affichage différent en fonction, et une importance qui permet de mettre en valeur la section si celle-ci est importante.

Le texte est ajouté à l'intérieur de paragraphes, avec l'élément Paragraphe. Il est facile d'insérer un nouveau paragraphe avec le raccourci-clavier commande-P ou contrôle-P dans Jaxe.

Il possible de créer plusieurs contributions, chacune comprenant un fichier XML XPAGES et les fichiers attachés (images, applets Java, ...). Chaque contribution doit alors correspondre à un dossier dont le nom est égal au label donné dans le bloc Informations du fichier XML. Ce dossier contient le fichier XML et les fichiers associés.


Informations

bloc_informations.png

Le bloc d'informations renseigne sur le document, et permet aussi de choisir un habillage pour les pages qui seront générées. Il est obligatoire, et se place au début du document. Il comporte les éléments suivants :


Eléments de bloc

Les éléments de bloc sont les éléments XML que l'on peut insérer directement à l'intérieur d'un élément PAGE. Ils permettent de structurer le document, mais ne sont pas mélangés à du texte : il est ainsi impossible d'insérer du texte directement sous PAGE, le texte devant être placé à l'intérieur d'un élément de bloc.

XPAGES comporte les éléments de bloc suivants :


Eléments mélangés au texte

Certains éléments de XPAGES peuvent être mélangés avec du texte, par exemple à l'intérieur d'un paragraphe. Ce sont les éléments suivants :


Exercices

XPAGES peut être utilisé pour de nombreuses applications, mais il est en particulier pratique pour créer un cours en ligne, et a été créé dans ce contexte. Pour ces raisons, le langage contient des éléments spécifiques à la définition d'exercices, même si ces éléments ne seront pas forcément utiles en-dehors du contexte des cours en ligne.

Il existe deux types d'exercices : les exercices de type question-réponse, et les QCM. Dans les deux cas, un exercice peut avoir un titre (attribut titre), un énoncé (élement Enoncé), une indication de la difficulté (élément Difficulté), une indication du temps nécessaire (élément Temps), et des questions (élements Question et Question de QCM).

Chaque question peut avoir un énoncé et une ou plusieurs aides (élement Aide). Les questions des exercices de type question-réponses ont une solution (élément Solution) et un nombre de points qui peuvent être accordés si la réponse est correcte (élément Points). Les questions de QCM ont des réponses possibles (élément Réponse de QCM), chaque réponse pouvant être bonne ou pas (attribut bonne), avec à chaque fois le texte de la réponse (élément Texte de réponse) et un commentaire qui sera affiché si l'utilisateur choisit cette réponse, par exemple pour lui expliquer en quoi la réponse est fausse (élément Commentaire de réponse).

Dans Jaxe, les réponses des exercices d'évaluations ne sont pas ajoutées aux fichiers HTML quand on génère le "site public". Elles ne sont ajoutées que lorsque l'on génère le "site de production". Dans WebJaxe, c'est toujours le site de production qui est généré; il faut donc exporter la contribution et l'ouvrir dans Jaxe pour générer le site public. On peut ainsi, à partir des mêmes fichiers XML, générer un site pour les étudiants, et un site pour les tuteurs d'une formation à distance.


Référence du langage

Le document suivant présente l'ensemble des éléments du langage XPAGES, avec un index et un arbre des éléments. Il a été généré automatiquement à partir du schéma XML de XPAGES.