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( affiché -> 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 n'ont pas besoin de 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
Edition de la configuration en JSON
La configuration de la vue météo des services doit être écrite au format JSON. Ce format se présente sous le format de clé/valeur qui peuvent être imbriquée les une au autres comme ceci :
| Panel | ||
|---|---|---|
| ||
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
Initialiser le JSON
Dans la configuration de la météo, le format JSON DOIT toujours commencé par une accolade ouvrante "{" et se terminer par une accolade fermante "}". Ce principe s'appelle un objet en JSON.
Objet JSON
Les objets sont constitués d'autres propriétés et permettent ainsi de définir des bloques de configurations. Les objets peuvent écrit de deux façons différentes :
| Panel | ||
|---|---|---|
| ||
| Info |
|---|
Cette manière d'écrire un objet n'est utilisée que lorsqu'on se trouve dans une liste ( ici "grid_elements" est une liste de propriétés) ou bien au départ du JSON |
| Panel | ||
|---|---|---|
| ||
Au sein de la configuration de la météo des services plusieurs bloques ou propriétés utilisé des objets par exemple :
- Chaque widget
- Les liens externes
- etc ...
Les listes
Certaines propriétés de la configuration de la météo nécessite de faire une liste d'élément. Pour créer un liste il faut mettre un crochet ouvrant "[" puis à la fin de la liste mettre un crochet fermant "]".
Pour la météo des services, les listes sont utilisées par exemple :
- Par la propriété "grid_elements" qui va liste toutes les configurations des widgets qui apparaitront dans la grille
- Par la propriété "links" qui va liste toutes les configurations des liens externes
- Etc..
| 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
Actions possibles dans la zone d'édition
Comportement du copier coller
Expliquer qu'on peut faire le ctrl+c et ctrl+v
Barre de défilement
Expliquer qu'il peut y avoir un barre de défilement
Affichages des erreurs de Syntaxe du JSON
Colorisations syntaxique
Couleur rouge 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 |
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.
| Panel |
|---|
