source: plugins_spip/terraeco_infographie/trunk/README.md @ 7963

Last change on this file since 7963 was 7963, checked in by kent1, 7 years ago

Mise à jour de la doc

File size: 5.2 KB
Line 
1# Terraeco Infographies
2
3Le site de texte est [terraeco.arscenic.org](http://terraeco.arscenic.org)
4
5## Description technique
6
7### Tables sql
8
9Quatre tables SQL sont créées en utilisant les pipelines de l'API de création d'objets de SPIP. Elles peuvent donc êtres modifiées facilement.
10
11* **spip_infographies**
12
13  Cette table définit les différentes infographies (du coup on peut en avoir plusieurs différentes).
14 
15  Cette table est définie comme éditable dans l'API, on peut donc accéder aux pages :
16  * *ecrire/?exec=infographies* listant toutes les infographies
17  * *ecrire/?exec=infographie_edit&new=oui* permettant de créer une nouvelle infographie
18  * *ecrire/?exec=infographie&id_infographie=1* affichant le contenu d'une infographie dans l'espace privé.
19 
20  Ses informations sont définies sous la forme :
21  * *id_infographie* : l'identifiant numérique de l'infographie
22  * *titre* : le titre de l'infographie
23  * *texte* : le texte de l'infographie
24  * *credits* : les crédits de l'infographie
25  * *date* : la date de l'infographie
26  * *statut* : le statut de l'infographie (statuts similaires aux articles)
27  * *maj* : la date de mise à jour
28 
29* **spip_infographies_datas**
30
31  Table définissant les jeux de données liés à une infographie ou plusieurs infographies (On utilise la table spip_infographies_datas_liens pour faire les liens entre jeux de données et infographies).
32
33  Cette table est définie comme éditable dans l'API, on peut donc accéder aux pages :
34  * *ecrire/?exec=infographies_datas* listant tous les jeux de données
35  * *ecrire/?exec=infographies_data_edit&new=oui* permettant de créer un nouveau jeu de données
36  * *ecrire/?exec=infographies_data&id_infographies_data=1* affichant le contenu d'un jeu de données dans l'espace privé.
37 
38  Ses informations sont définies sous la forme :
39  * *id_infographies_data* : l'identifiant numérique du jeu de donnée
40  * *titre* : le titre du jeu de donnée
41  * *texte* : le texte du jeu de donnée
42  * *axe_x* : le label de l'axe horizontal de l'infographie
43  * *axe_y* : le label de l'axe vertical de l'infographie
44  * *credits* : les crédits du jeu de donnée
45  * *type* : le type du jeu de donnée
46  * *url* : URL distante du jeu de donnée si externe
47  * *date* : la date du jeu de donnée
48  * *maj* : la date de mise à jour
49 
50
51* **spip_infographies_donnees**
52
53  Table définissant les données en base liées à un jeu de donnée.
54 
55  Cette table est indiquée dans l'API comme non éditable, elle ne dispose donc pas de page d'édition spécifique.
56  Les données s'éditent depuis la page de l'infographie.
57 
58  Chaque ligne se présente sous la forme :
59  * *id_infographies_donnee* : l'identifiant numérique de la donnée
60  * *id_infographies_data* : à quelle infographie est liée cette donnée
61  * *rang* : la place de la donnée dans le jeu
62  * *axe_x* : valeur de cette donnée sur l'axe X
63  * *axe_y* : valeur de cette donnée sur l'axe Y
64  * *commentaire* : un commentaire qui peut être utilisé ensuite dans l'infographie
65  * *date* : date de la donnée
66  * *maj* : date de mise à jour de la donnée
67
68
69* **spip_infographies_datas_liens**
70
71  Table de jointures pour les jeux de données.
72  Les jeux de données pouvant être liés à plusieurs infographies différentes par exemple.
73 
74  Elle est composée des champs suivants :
75  * *id_infographies_data* : l'identifiant numérique du jeu de données lié
76  * *id_objet* : l'identifiant numérique de l'objet lié
77  * *objet* : le type d'objet lié
78
79
80### Formulaires
81
82#### Formulaire d'édition d'infographie
83
84Le formulaire d'édition d'infographie permet de modifier son titre, son texte et les crédits associés.
85
86On l'appelle comme ceci :
87
88        [(#FORMULAIRE_EDITER_INFOGRAPHIE{#ID_INFOGRAPHIE,#ENV{redirect}})]
89
90
91### Javascript
92
93Le plugin utilise la librairie [d3.js](http://d3js.org/) pour les représentations graphiques.
94
95### ModÚles
96 
97## Utilisation
98
99### Étape 1 : création de l'infographie
100
101En primier lieu, on crée une infographie en lui donnant les informations nécessaires.
102
103### Étape 2 : créer un ou plusieurs jeu de données
104
105On crée ensuite un jeu de données que l'on associe à l'infographie créée. L'association se fait sur la page de l'infographie puisqu'un même jeu de données pourrait être utilisé par plusieurs infographies différentes.
106
107### Étape 3 : remplir le ou les jeux de données
108
109On ajoute des données au jeu de données.
110
111Les données sont ajoutées directement sur la page du jeu de données.
112
113Cet ajout peut être fait via téléchargement d'un fichier CSV (pour l'instant seul ce format est utilisable).
114
115**Formatage du fichier CSV**
116
117Le fichier CSV doit avoir des données sur deux ou trois colonnes.
118
119* La premiÚre colonne est considérée comme valeurs de l'axe horizontal;
120* La seconde colonne est consdidérée comme valeurs de l'axe vertical;
121* La troisiÚme, quant à elle est facultative, elle correspond aux commentaires potentiels de chaque valeur;
122
123Lors de l'insertion depuis un fichier CSV, on vérifie :
124
125* si la premiÚre ligne est exclusivement composée de valeurs non numériques, cette ligne est considérée comme légende, on utilise ces valeurs pour remplir ou remplacer les valeurs *axe_x* et *axe_y* du jeu de donnée lié;
126
127
128
Note: See TracBrowser for help on using the repository browser.