| Scroll Ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
Qu'est ce que le format JSON
Le format JSON est un format qui permet de stocker des données de façon organisées et lisibles 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ées soit dans un objet, soit dans un tableau.
- Un objet commence par "{" et finie par "}".
- Un tableau 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êmes types de blocs est possible, par exemple :
- un objet dans un objet
- ou un tableau dans un tableau.
Valeurs possibles :
- les propriétés :
- un nombre( 1, 2, ... ),
- un booléen( true, false ) ,
- une chaine de caractères ( "default", "mon nom de widget" ),
- les tableaux ( [ ... ] ),
- les objets ( { ... } ).
Pour la modification du JSON, il est conseillé :
- d'utiliser un éditeur de texte spécialisé ( Cela permettra d'avoir la détection d’erreur du langage JSON,voir la page JSON d'exemple pour commencer - Édition JSON - Météo ),
- de faire les modifications sur celui-ci,
- puis de copier-coller l'intégralité du JSON dans la fenêtre d'édition de la météo.
Repérer un élément dans la configuration JSON
Lorsque l'éditeur JSON de la configuration de la météo est ouvert, le clic sur le bouton 
d'un widget permet se déplacer plus facilement sur le bloc JSON définissant le widget.
| Panel |
|---|
|
Affichage des définitions d'éléments dans l'éditeur
Dans le formulaire de configuration de la météo des services, la coloration syntaxique est la suivante :
- le nom des propriétés est affiché en : bleu,
- Les valeurs apparaissent :
- en blanc quand l'utilisateur a édité une valeur,
- en violet quand c'est la valeur par défaut.
| Panel | ||
|---|---|---|
| ||
|
Edition de la configuration en JSON
Rappel de la syntaxe 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..
| title | Dans cet exemple, la propriété "links" possède deux liens |
|---|
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
blocs, cette indentation est visualisée à l'aide de trait vertical 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
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.
Copier / Coller
- Il est possible de copier toute la configuration de la météo, en cliquant sur le bouton qui apparait à l'aide de la souris, en survolant le formulaire JSON.
- Il est possible de copier une partie en sélectionnant une partie du texte et en utilisant le raccourci clavier Ctrl + C.
| Panel |
|---|
|
- Il est possible aussi de coller tout ou une partie du JSON, à l'aide du raccourci clavier Ctrl +V.
- Après avoir collé une configuration ( éditée depuis un éditeur externe par exemple ), le texte apparaitra sans la coloration syntaxique et sans indentation.
- Pour retrouver un affichage correspondant au nouveau contenu du JSON copier, il faudra cliquer sur le bouton
.
| Panel |
|---|
|
Affichages des problèmes de configuration
Coloration syntaxique
Une clé ou une valeur avec une couleur de fond rouge indique que la clé ou la valeur est en "problème".
- Pour connaitre la nature du problème, il faut se référer à l'encadré rouge au-dessus du formulaire d'édition.
| Panel | ||
|---|---|---|
| ||
|
| Panel | ||
|---|---|---|
| ||
|
| Info |
|---|
Lorsqu'une clé est à un problème, c'est toute la partie concernant cette clé qui apparaitra en rouge. |
Bulle d'information
Lorsque la clé ou valeur est en problème, une bulle d'information est affichée au survol de la zone pour indiquer quelle est la nature du problème.
| Panel |
|---|
|
Localiser les problèmes
Lorsqu'un problème est présent dans la configuration de la météo, cliquer sur le texte JSON fera défiler le JSON jusqu'à l'endroit où le problème se situe, permettant ainsi de facilement localiser la propriété.
| Panel |
|---|
|
