source: spip-zone/_plugins_/infographies/trunk/README.md @ 80102

Last change on this file since 80102 was 80102, checked in by kent1@…, 7 years ago

Un peu de doc

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