Qu'est ce que le format JSON
La configuration de la vue météo des services doit être écrite au format JSON.
Le format JSON est un format qui permet de stocker des données de façon organisées et lisible par un humain. Plusieurs règles s'appliquent à ce format :
- Il ne peut y avoir qu'un élément racine, c'est à dire un élément qui va contenir toutes les données.
- Les données peuvent être organisés soit dans un objet soit dans un tableaux.
- Un objet commence par "{" et finie par "}" et
- Un tableaux commence par "[" et termine par "]"
- Les propriétés sont formées d'un couple clé/valeurs que l'on affiche sous forme ( clé : "valeurs").
- Le séparateur de chaque propriété est la virgule. Les propriétés qui sont définies en dernier d'un objet ou d'une liste ne DOIVENT PAS se terminer avec une virgule.
- L'imbrication de deux même types de bloque est possible par exemple : Un objet dans un objet ou un tableau dans un tableau
Valeurs possibles :
- Les propriétés : un nombre, un booléen, une chaine de caractères, un tableau, un objet ou bien null
- Les tableaux : des tableaux, des objets ou une propriété séparées par des virgules.
- Les objets : des propriétés séparées par des virgules
Affichage de configuration de la formulaire
Dans le formulaire de configuration de la météo des services, la colorisation syntaxique est la suivante :
- Le nom des propriétés sont affichés en : bleu
- Les valeurs apparaissent :
- en blanc quand l'utilisateur a éditer un valeur
- en violet quand c'est la valeur par défaut
| Panel | ||
|---|---|---|
| ||
Indentation
Le format JSON étant un format où les propriétés sont imbriquées les unes par rapport aux autres, cela se matérialise en JSON par une indentation entre les bloques, cet indentation est visualiser à l'aide de trait verticaux dans le formulaire de configuration.
Cela permet aux utilisateurs de mieux visualiser la fin de chaque indentation.
| Panel |
|---|
Actions possibles dans la zone d'édition
Comportement du copier/coller
Vous pouvez dans le formulaire effectuer des copier/coller à l'aide de la souris ou en passant par les raccourcis clavier CTRL+ C et CTRL+ V.
Si vous souhaitez copier toute la configuration sans passer par le bouton de copie du formulaire , nous vous conseillons de faire les raccourcis clavier suivant : CTRL+ A puis CTRL+ C
Si vous souhaitez coller une configuration éditée depuis un éditeur externe, le texte apparaitra sans la coloration syntaxique et sans indentation. Pour retrouver un affichage correct, nous vous invitons à cliquer le bouton
| Panel | ||
|---|---|---|
| ||
Barre de défilement
Les barres de défilement verticale et horizontale sont en permanence affichées afin de permettre à l'utilisateur de pouvoir continuer de configurer même si la configuration prend plus de place sur la largueur ou la hauteur.
| Panel |
|---|
Affichages des erreurs de Syntaxe du JSON
Colorisations syntaxique
Couleur rouge Une clé ou une valeur avec une couleur de fond rouge indique que la clé ou la valeur est en erreur. Pour connaitre la nature de l'erreur
Bulle d'information
Localiser les erreurs
Description
Le formulaire vous permet de visualiser et d'éditer la configuration JSON de la vue météo.
Dans ce formulaire, les clés apparaissent en bleu claire et les valeurs en blancs.
| Panel |
|---|
Afficher ou cacher un niveau d'indentation (optionnel)
Il est possible de cacher ou d'afficher les niveaux d'indentation (tableaux, dictionnaire) en cliquant sur l'icône TODO. Lorsque le niveau d'indentation est caché, un texte est indique le nombre d'élément caché.
Par exemple :
| Panel |
|---|
TODO SCREEN |
référez-vous à l'encadré rouge au dessus du formulaire d'édition.
| Panel | ||
|---|---|---|
| ||
| Panel | ||
|---|---|---|
| ||
Lorsqu'une clé est en erreur, c'est tout le bloque de configuration qui apparait en rouge.
Bulle d'information
Localiser les erreurs
Voir les erreurs
Cliquer sur les messages d'erreur ou sur l'icône en fin de message pour que le formulaire défile automatique pour afficher l'élément JSON qui pose problème. Les éléments en erreur sont affichés en rouge.
