Métadonnées d'un élément Karuta

Les métadonnées d'un élément Karuta permettent de lui attribuer un identifiant unique et de spécifier son comportement.

L'identifiant unique de l'élément se nomme le Tag sémantique et permet de référencer cet élément à partir d'autres éléments. Il est de bonne pratique d'attribuer un identifiant unique à chaque élément ajouté à un portfolio.

On spécifie ensuite le comportement de chacun de ces éléments. Par exemple, dans le cas d'éléments de structure (Section, Page, Sous-section), on peut définir des menus qui permettent l'ajout d'éléments supplémentaires par le designer ou par l'utilisateur final. Dans le cas des éléments de ressource (éléments qui contiennent les données) on peut associer des rôles à chaque droit, définissant ainsi qui peut faire quoi sur l'élément.

C'est aussi dans les métadonnées qu'on spécifie quels sont les éléments qui vont peupler une boîte de choix, quels utilisateurs pourront partager leur portfolio avec une tierce partie (et sous quelles conditions de sécurité), spécifier le contenu des bulles d'aide, etc.

On accède aux métadonnées d'un élément via la boîte d'édition de celui-ci (bouton crayon).

Les métadonnées

Nœud

Droits utilisateurs

Nœud

Tag sémantique

Le tag sémantique d'un élément est son identifiant et devrait exprimer sa sémantique (exemple : page-profil-etudiant, nom-etudiant, etc). Le designer d'un portfolio devrait, pour chaque élément qu'il ajoute à un portfolio, remplacer le tag sémantique par défaut par quelque chose qui exprime la sémantique de l'élément.

C'est par le tag sémantique qu'on recherche des éléments dans un portfolio. Il est utilisé dans la métadonnée Recherche (voir ci-dessous) ainsi que dans les scripts de rapport et de batch.

ATTENTION : La recherche de tag sémantique se fait par inclusion. Par exemple, si on recherche les éléments avec le tag sémantique competence, les éléments avec le tag sémantique sous-competence seront également trouvés, car le mot competence est inclus dans le mot sous-competence.

Code

Le plus souvent attribué aux éléments Item et Sous-section pour ensuite être utilisé dans les listes déroulantes (éléments Get_Resource et Get_Get_Resource) et les boîtes de choix multiples (fonctions Get_Multiple et Import_Multiple). C'est lui qui permet d'identifier la sélection de l'utilisateur.

ATTENTION : Le code d'un élément de portfolio doit être unique à l'intérieur de ce portfolio.

Par défaut le code et le libellé de l'élément apparaissent dans la liste déroulante et seul le libellé de l'option sélectionnée par l'utilisateur est ensuite afffiché dans l'élément Get_Resource (ou Get_Get_Resource). Ce comportement peut être modifié par l'ajout d'un ou plusieurs des symboles suivants au code de l'élément :

  • @ rendra le code non visible dans la liste déroulante ;
  • # rendra le code visible dans l'élément Get_Resource ;
  • & rendra la valeur associée à l'élément visible dans l'élément Get_Resource (seul les éléments de type Item ont un champ pour indiquer une valeur) ;
  • ? rendra la valeur associée à l'élément visible dans la liste déroulante (seul les éléments de type Item ont un champ pour indiquer une valeur) ;
  • % rendra le libellé non visible dans l'élément Get_Resource ;
  • $ rendra le libellé non visible dans la liste déroulante ;
  • ! rendra le choix non sélectionnable dans la boîte de choix multiple (utile pour créer des titres de section dans la boîte de choix).

Nœud multilingue

Spécifie si le libellé du nœud prend une valeur différente pour chaque langue dans le cas où le portfolio est multilingue. Si Nœud multilingue n'est pas coché, il y aura une seule valeur pour toutes les langues et cette valeur sera stockée dans la langue par défaut définie dans le fichier de configuration _init.js.

ATTENTION : Le code n'est jamais multilingue. Il a la même valeur quelle que soit la langue active.

Ressource multilingue

Éléments ressource uniquement. Spécifie si les données entrées dans l'élément ressource prennent des valeurs différentes pour chaque langue dans le cas où le portfolio est multilingue. Si la Ressource multilingue n'est pas coché, il y aura une seule valeur pour toutes les langues et cette valeur sera stockée dans la langue par défaut définie dans le fichier de configuration _init.js

Par exemple, un nom ou une date de naissance ne sont habituellement pas dépendants de la langue, alors qu'un texte qui donne des instructions est définitivement différent dans chaque langue.

Encrypter la ressource

Spécifie si la ressource doit être encryptée. Dans le cas positif, une phrase-clé est demandée à l'utilisateur à l'ouverture du portfolio. Cette phrase-clé sert à encoder/décoder les données entrées dans la ressource. Cette phrase-clé n'est pas stockée dans Karuta et doit donc être mémorisée par l'utilisateur, car elle lui est demandée à chaque ouverture du portfolio.

Voir

Liste des rôles, séparés par un espace, ayant le droit de voir l'élément. Exemple : etudiant professeur.

Par défaut le droit de voir est attribué au rôle all, qui englobe tous les rôles. Il s'agit de l'unique droit à avoir une valeur par défaut.

Supprimer

Liste des rôles, séparés par un espace, ayant le droit de supprimer l'élément. Affiche le bouton X.

Modifier ressource

Éléments ressource uniquement. Liste des rôles, séparés par un espace, ayant le droit d'éditer la ressource (y enregistrer des données). Affiche le bouton crayon.

Ressource sans crayon

Éléments ressource uniquement. N'affiche pas le bouton crayon aux rôles ayant le droit de modifier la ressource. Utilisé pour les imports d'éléments multiples via la fonction Get_Multiple (voir section FONCTIONS MENU pour plus de détails).

Commenter

Liste des rôles, séparés par un espace, ayant le droit de commenter un élément ressource. Ce droit ajoute un éditeur de texte au bas de la boîte d'édition de la ressource. Le commentaire est daté et signé du nom de l'utilisateur qui l'a écrit. Pour pouvoir commenter un élément, l'utilisateur doit également avoir le droit de Modifier la ressource.

ASTUCE : Le designer peut s'attribuer le droit de commenter un élément de structure – cela lui permet d'ajouter l'équivalent d'un sous-titre au libellé de l'élément.

Soumettre

Liste des rôles, séparés par un espace, ayant le droit de soumettre l'élément. Lorsque l'utilisateur soumet un élément, ses droits d'édition et/ou de suppression sont retirés pour cet élément et tous ses enfants. Affiche le bouton Soumettre.

Éditer code

Liste des rôles, séparés par un espace, ayant le droit de modifier le code de l'élément.

Modifier nœud

Liste des rôles, séparés par un espace, ayant le droit de modifier le libellé de l'élément. Affiche le bouton crayon.

Nœud sans crayon

N'affiche pas le bouton crayon aux rôles ayant le droit de Modifier le nœud. Utilisé pour les imports de composantes via la fonction Get_Multiple (voir section FONCTIONS MENU pour plus de détails).

Dupliquer

Liste des rôles, séparés par un espace, ayant le droit de dupliquer l'élément. La copie de l'élément sera ajoutée à la fin de la liste d'éléments du même niveau hiérarchique dans l'arborescence. Affiche le bouton copie.

Modifier taille image

Éléments Image uniquement. Liste des rôles, séparés par un espace, ayant le droit de modifier la taille d'affichage de l'image. Affiche le bouton crayon.

Ordonner

Liste des rôles, séparés par un espace, ayant le droit modifier l'ordonnancement de l'élément parmis les éléments du même niveau hiérarchique dans l'arborescence. Affiche le bouton flèche vers le haut.

Déplacer

Liste des rôles, séparés par un espace, ayant le droit de déplacer l'élément vers une autre branche dans l'arborescence. Affiche le bouton flèches croisées.

Déplacer dans

Tag sémantique qui contraint les éléments vers lesquels les rôles ayant le droit de Déplacer peuvent déplacer l'élément courant. Par exemple, avoir le droit de déplacer un élément uniquement vers les sous-sections qui ont le tag sémantique spécifié.

Montrer/Cacher

Liste des rôles, séparés par un espace, ayant le droit de montrer/cacher l'élément et tous ses enfants à d'autres utilisateurs. Ce droit ajoute le bouton œil qui indique l'état (et non l'action) : lorsque l'œil est barré, l'élément est invisible aux autres utilisateurs ; lorsque l'œil n'est pas barré, l'élément est visible aux autres utilisateurs.

Montrer à

Liste des rôles, séparés par un espace, à qui l'élément est caché ou montré par les utilisateurs ayant le droit de Montrer/Cacher.

Imprimer

Liste des rôles, séparés par un espace, ayant le droit d'imprimer l'élément. Affiche le bouton imprimante.

Titre boîte d'édition

Spécifie un titre alternatif pour la boîte d'édition (par défaut le titre de la boîte d'édition est le libellé de l'élément). Utile pour les éléments ressource qui n'ont pas de libellé ou pour donner des instructions aux utilisateurs qui ont le droit de Modifier la ressource.

Max mots

Éléments Texte long uniquement. Spécifie le nombre maximal de mots que peut entrer l'utilisateur qui a le droit de Modifier la ressource.

Visible

Lorsque Visible n'est pas coché, l'élément n'est pas affiché (sauf au designer). Utile pour cacher aux utilisateurs du contenu nécéssaire à l'exécution d'un script de tableau. Tous les éléments sont visibles par défaut.

Édition en place

Éléments ressource uniquement. Lorsque Édition en place est coché, l'utilisateur n'a pas de bouton crayon et l'éditeur de la ressource est affiché directement dans la page du portfolio.

Repliable

Éléments Sous-section uniquement. Lorsque Repliable n'est pas coché, le bouton +/- à gauche qui permet de déplier/replier la sous-section n'est pas affiché. Les sous-sections sont repliables par défaut.

Recherche

Le champ Recherche est utilisé pour spécifier quels éléments doivent apparaître dans une liste déroulante (éléments Get_Resource et Get_Get_Resource) et pour choisir la cible d'un élément Proxy.

NOTE : voir section RESSOURCES pour plus de détails sur les éléments Get_Resource, Get_Get_Resource et Proxy.

Format de la recherche pour un élément Get_Resource

code_portfolio (ou self).tag_sémantique.label (ou text ou fileid ou resource)

  • code_portfolio Code du portfolio référentiel où chercher les éléments spécifiés par le tag sémantique. Le format est code du projet.code du portfolio référentiel. Si code du projet n'est pas présent, la recherche du portfolio référentiel se fait dans le projet courant (projet qui contient le portfolio dans lequel se trouve le Get_Resource).
  • tag_sémantique Tag sémantique des élements à afficher dans la liste déroulante.
  • label Mot réservé. Lorsque les éléments cherchés sont des Items ou des Sous-sections (voir autres options ci-dessous).

Option self
Peut remplacer code_portfolio. Dans ce cas la recherche se fait à l'intérieur du portfolio courant (portfolio qui contient l'élément Get_Resource).

Option text
Peut remplacer label et s'applique lorsque les éléments cherchés sont de type Texte court ou Texte long. Dans ce cas c'est le texte dans la Ressource et non le libellé qui sera affiché dans la liste déroulante puis dans le Get_Ressource.

Option fileid
Peut remplacer label et s'applique lorsque les éléments cherchés sont de type Image. Dans ce cas c'est l'image et non le libellé qui sera affiché dans la liste déroulante puis dans le Get_Ressource. Les éléments Image doivent être déclarés à même le portfolio où se trouve l'élément Get_Ressource et non pas dans un portfolio référentiel ; donc à utiliser en combinaison avec l'option self.

Option resource
Peut remplacer label et s'applique lorsque les éléments cherchés sont de type Item. Dans ce cas le Get_Resource sera mis à jour si l'élément Item sélectionné est modifié. Les éléments Item doivent être déclarés à même le portfolio où se trouve l'élément Get_Ressource et non pas dans un portfolio référentiel ; donc à utiliser en combinaison avec l'option self.

Format de la recherche pour un élément Get_Get_Resource

code_portfolio.position.tag_sémantique1.tag_sémantique2.label

  • code_portfolio Code du portfolio référentiel où chercher les éléments spécifiés par tag sémantique2. Le format est code du projet.code du portfolio référentiel. Si code du projet n'est pas présent, la recherche du portfolio référentiel se fait dans le projet courant (projet qui contient le portfolio dans lequel se trouve le Get_Get_Resource).
  • position Indique où chercher dans le portfolio courant le code de l'élément parent qui va permettre de restreindre la recherche dans le référentiel. Prend une des valeurs suivantes : child, sibling, parent, parent.parent, parent.parent.parent.
  • tag_sémantique1 Tag sémantique du parent (restreint la recherche aux enfants de ce parent).
  • tag_sémantique2 Tag sémantique des élements à afficher dans la liste déroulante.
  • label Mot réservé.

Format de la recherche pour un élément Proxy

code_portfolio.tag_sémantique.label

  • code_portfolio Code du portfolio dans lequel chercher la cible à afficher.
  • tag_sémantique Tag sémantique des élements parmis lesquels choisir la cible.
  • label Mot réservé.

Partager

La fonction Partager permet à l'utilisateur d'envoyer à un tiers un courriel avec un hyperlien qui partage, en tout ou en partie, son portfolio avec ce tiers.

Format

rôle qui partage,rôle visiteur,rôles et/ou courriels destinataires,niveau (0-4),durée de vie du lien (en heures),libellé du bouton@fr[,condition]

  • rôle qui partage Rôle de l'utilisateur qui peut faire le partage (qui aura le bouton pour partager).
  • rôle visiteur Rôle qu'aura le destinataire dans le portfolio.
  • rôles et/ou courriels destinataires Rôles et/ou courriels des destinataires. Si c'est un rôle, toutes les personnes ayant ce rôle dans le portfolio seront destinataires d'un courriel.
  • niveau (0-4) Niveau de sécurité pour le partage. Peut prendre les valeurs de 0 à 4 (voir description des niveaux ci-dessous).
  • durée de vie du lien En heure. Après ce temps, le lien qui se trouve dans le courriel est désactivé.
  • libellé du bouton Libellé qui apparaîtra à l'utilisateur qui peut faire le partage. Suffixer de @fr pour français.
  • condition Optionnel. Condition pour que le bouton de partage soit visible à l'utilisateur. Exemple : submitted=='Y'.

Niveaux de sécurité

Niveau 0 – utilisateur Karuta
Le destinataire du courriel possède un compte Karuta et le portfolio lui est déjà partagé, dans le bon rôle. Son mot de passe lui sera demandé si il n'est pas déjà logué dans Karuta.

Niveau 1
Le destinataire du courriel possède un compte Karuta et le portfolio lui est déjà partagé, dans le bon rôle. Son mot de passe ne lui sera pas demandé (si l'utilisateur n'est pas déjà logué dans Karuta, un login temporaire lui sera attribué). Par mesure de sécurité, il devrait y avoir un bouton Soumettre sur les éléments que le visiteur peut modifier.

Niveau 2
Le destinataire du courriel possède un compte Karuta mais le portfolio ne lui est pas partagé. Le système partage le portfolio avec l’utilisateur dans le bon rôle. (Si l'utilisateur n'est pas déjà logué dans Karuta, un login temporaire lui sera attribué.) Par mesure de sécurité, il devrait y avoir un bouton Soumettre sur les éléments que le visiteur peut modifier.

Niveau 3
Si le destinataire du courriel n'a pas de compte dans Karuta, un compte lui sera créé. Le système partage le portfolio avec l'utilisateur dans le bon rôle. (Si l'utilisateur n'est pas déjà logué dans Karuta, un login temporaire lui sera attribué.) Par mesure de sécurité, il devrait y avoir un bouton Soumettre sur les éléments que le visiteur peut modifier.

Niveau 4 - lien public
Si l'utilisateur n'est pas logué dans Karuta, un login temporaire lui sera attribué. Il a automatiquement (logué ou non) le rôle all (donc il peut voir mais ne peut rien modifier). Lors de l’instanciation, le rôle all doit être partagé avec l’utilisateur public.

Voir section PARTAGE PAR L'UTILISATEUR pour une documentation complète et des exemples d'utilisation.

Permet de composer des menus afin d'importer des composantes. En général, les composantes se trouvent dans un portfolio de composantes réutilisables et le menu s'adresse à un ou plusieurs utilisateurs, leur permettant d'ajouter des éléments à leur portfolio. Dans ce cas la composante importée est copiée puis collée dans le portfolio.

ASTUCE : Le designer peut se créer des menus à lui-même afin de copier des morceaux de portfolio d'un portfolio à un autre.

Il existe aussi dans Karuta plusieurs fonctions préprogrammées dont l'appel se fait à l'intérieur de la métadonnée Menus. Voir section FONCTIONS MENU pour la documentation de ces fonctions.

Format

code_portfolio,tag_sémantique,libellé@fr,rôles[; autres menus]

  • code_portfolio Code du portfolio duquel on importe la composante.
  • tag sémantique Tag sémantique de la composante à importer.
  • libellé Libellé de l'élément de menu. Suffixer de @fr pour français.
  • rôles Liste des rôles, séparés par un espace, voyant l'élément de menu.

ATTENTION : Il n'y a pas de point-virgule final.

Texte alternatif pour le libellé du bouton Menu lorsque plus d'un choix est offert à un rôle (par défaut Menu). Suffixer de @fr pour français. Par exemple : Ajouter un diplôme@fr si il y a plusieurs types de composantes de diplômes.

Bulle d'aide

Affiche de l'information supplémentaire dans une bulle pop-up à côté du libellé de l'élément. Suffixer de @fr pour français.