Updated Network (markdown) authored by Tom's avatar Tom
## Présentation
Un network est une carte exploitant la base de donnée de Communecter. Il permet d'afficher tous les points correspondant à un tag (par exemple : #AMAP, #Culture, #Energie, ...) sur un périmètre défini (par exemple : plusieurs régions ou une seule ville).
Voici quelques exemples de network : [Tiers-Lieux des Hauts de France](http://hauts.tiers-lieux.org/mel/), [Assemblée des Communs de Lille](http://lille.lescommuns.org/cartographier-les-communs/), [Restaurants vegan de la Réunion](https://restovegan.re/), [Zéro Déchet Île de France](paris.zerowastefrance.org/la-carte), [Bretagne Telecom](https://www.communecter.org/?network=BretagneTelecom).
......@@ -6,7 +7,7 @@ Voici quelques exemples de network : [Tiers-Lieux des Hauts de France](http://ha
> Voir le canal de discussion : [marque blanche](https://chat.lescommuns.org/channel/marqueblanche) si vous avez besoin d'un coup de main.
### Introduction
## Introduction
> Ce tuto existe aussi en vidéo : https://youtu.be/OOnEnxjhr-I
L’adresse d’une carte commence par `https://www.communecter.org/communecter?network=` suivi d'un lien vers un fichier JSON contenant les différents paramètres de la carte (nom, filtres, limites géographiques, etc.). Ce JSON peut être hébergé sur votre site ou sur un site tierce (pour ce tuto nous utiliserons [Gist](https://gist.github.com/)).
......@@ -17,16 +18,16 @@ Exemple de lien complet : `https://www.communecter.org/communecter?network=https
Pour commencer, le plus simple est de copier une configuration existante puis de modifier les paramètres un à un pour éviter les erreurs.
### Créer une carte personnalisée
## Créer une carte personnalisée
1. Copiez le code ci-dessous dans un nouveau Gist : http://gist.github.com/
1. Cliquez sur Raw (en haut à droite de votre code)
1. Ouvrez un nouvel onglet pour ouvrir l'URL suivante : `https://www.communecter.org/communecter?network=LienDuRAW.
1. Ouvrez un nouvel onglet pour ouvrir l'URL suivante : `https://www.communecter.org/communecter?network=LienDuRAW`
***
### Exemple de code
### Exemple de configuration
```json
{
......@@ -168,38 +169,259 @@ Pour commencer, le plus simple est de copier une configuration existante puis de
"searchLocalityREGION": [
"Nord-Pas-de-Calais-Picardie"
],
"mainTag" : ["commun"]
}
}
```
***
### Header
`"name" : "BretagneTelecomIlletVilaine",` : titre affiché dans la bannière du haut
## Paramétrage
Vous cherchez une info sur un tag ? Utilisez le moteur de recherche de votre navigateur : Ctrl + F.
### `"name"`
Titre affiché dans la bannière du haut.
### `"mode"`
?
### `"skin"`
Paramètres pour afficher des fonctionnalités sur la carte.
#### `"logo"`
Affiche un logo affiché dans la bannière. Valeurs possibles : `false` ou lien vers un fichier `jpeg` ou `png`.
#### `"title"`
Titre affiché dans la bannière.
#### `"shortDescription"`
Description.
#### `"displayScope"`
#### `"docs"`
#### `"displayCommunexion"`
#### `"displayNotifications"`
#### `"profilBar"`
#### `"breadcrum"`
#### `"displayButtonGridList"`
#### `"class"`
`"mainContainer"`
#### `"iconeAdd"`
#### `"iconeSearchPlus"`
#### `"loginTitle"`
#### `"front"`
`"organization"`
`"project"`
`"event"`
`"community"`
`"dda"`
`"live"`
`"search"`
`"need"`
`"poi"`
#### `"menu"`
`"aroundMe"`
`"connectLink" : false,`
`"add" : true,`
`"detail" : true,`
`"filter" : true,`
`"news" : true,`
`"directory" : true,`
`"gallery" : true`
### `"filter"`
#### `"types"`
#### `"linksTag"`
Ici vous créer vos propres filtres.
```json
"Type de tiers-lieu" : {
"tagParent" : "Type",
"background-color" : "#f5f5f5",
"image" : "Travail.png",
"tags" : {
"Télétravail" : "Télétravail",
"Coworking" : "Coworking",
"Médiation Numérique" : "Médiation numérique",
"FabLab" : "Fablab",
"Accompagnement de projets" : "Accompagnement de projets",
"Atelier" : "Atelier",
"Salle de réunion" : "Salle de réunion",
"Communauté Catalyst" : "Catalyst",
"Espace à louer" : "Espace à louer"
}
},
```
### `"add"`
#### `"organization"`
#### `"person"`
### `"result"`
#### `"displayImage"`
#### `"displayType"`
#### `"fullLocality"`
#### `"datesEvent" `
#### `"displayShortDescription"`
### `"request"`
#### `"sourcekey"`
Clé fournit par Communecter pour accéder aux données (MANDATORY).
Requête transmise à Communecter pour afficher des résultats lors de l'ouverture de la carte.
#### `"pagination"`
Nombre de points remonté par requête.
#### `"searchType"`
Type de recherche dans la base de donnée communecter (MANDATORY).
Liste des valeurs possibles :
```json
"searchType" : [ "organizations", "person", "poi", "projects", "events" ]
```
#### `"searchTag"`
Permet de filtrer la liste des points selon un ou plusieurs tags.
Exemple de valeurs :
```json
"searchTag" : [ "communs", "commun", "Commun", "Communs" ]
```
`"mode" : "server",` : ?
#### `"mainTag"`
Tag principal des points remontés ou créés via la carte auront le tag mentionné.
`"logo" : "http://monsite.ext/mel.png",` : logo affiché dans la bannière
#### `"searchLocalityREGION"`
Limite la liste des points remontés à une ou plusieurs régions :
Liste des valeurs acceptées :
```
"Île-de-France"
"NOUVELLE-CALEDONIE"
"POLYNESIE"
"Bourgogne-Franche-Comté"
"Aquitaine-Limousin-Poitou-Charentes"
"Alsace-Champagne-Ardenne-Lorraine"
"Normandie"
"Mayotte"
"Nord-Pas-de-Calais-Picardie"
"Languedoc-Roussillon-Midi-Pyrénées"
"Provence-Alpes-Côte d'Azur"
"Pays de la Loire"
"Auvergne-Rhône-Alpes"
"Guadeloupe"
"Martinique"
"Bretagne"
"Centre-Val de Loire"
"Corse"
"Guyane"
"La Réunion"
```
### Paramètres pour afficher des fonctionnalités sur la carte
```json
"skin" : {
"logo" : false,
"title" : false,
"displayScope" : false,
"displayCommunexion" : false,
"profilBar" : false,
"displayButtonGridList" : false,
"class" : {
"mainContainer" : false
},
"iconeAdd" : false,
"iconeSearchPlus" : false,
"loginTitle":""
},
#### `"searchLocalityDEPARTEMENT"`
Limite la liste des points remontés à un ou plusieurs département :
Liste des valeurs acceptées :
```
"ESSONNE"
"YONNE"
"TERRITOIRE DE BELFORT"
"HAUTE-VIENNE"
"VOSGES"
"VAL-D'OISE"
"SEINE-MARITIME"
"MAYOTTE"
"SEINE-ET-MARNE"
"YVELINES"
"DEUX-SEVRES"
"SOMME"
"TARN"
"TARN-ET-GARONNE"
"VAR"
"VAUCLUSE"
"VENDEE"
"VIENNE"
"PAS-DE-CALAIS"
"PUY-DE-DOME"
"PYRENEES-ATLANTIQUES"
"HAUTES-PYRENEES"
"PYRENEES-ORIENTALES"
"BAS-RHIN"
"HAUT-RHIN"
"RHONE"
"HAUTE-SAONE"
"SAONE-ET-LOIRE"
"SARTHE"
"SAVOIE"
"ISERE"
"HAUTE-SAVOIE"
"PARIS"
"GUADELOUPE"
"MARTINIQUE"
"LOT-ET-GARONNE"
"LOZERE"
"ARDECHE"
"MAINE-ET-LOIRE"
"LOIRE-ATLANTIQUE"
"MANCHE"
"MARNE"
"HAUTE-MARNE"
"MAYENNE"
"MEURTHE-ET-MOSELLE"
"MEUSE"
"MORBIHAN"
"MOSELLE"
"NIEVRE"
"NORD"
"OISE"
"ORNE"
"COTES-D'ARMOR"
"CREUSE"
"DORDOGNE"
"DOUBS"
"DROME"
"EURE"
"EURE-ET-LOIR"
"FINISTERE"
"GARD"
"HAUTE-GARONNE"
"GERS"
"GIRONDE"
"HERAULT"
"ILLE-ET-VILAINE"
"INDRE"
"INDRE-ET-LOIRE"
"JURA"
"LANDES"
"LOIR-ET-CHER"
"LOIRE"
"ALLIER"
"HAUTE-LOIRE"
"CANTAL"
"LOIRET"
"LOT"
"AIN"
"AISNE"
"ALPES-DE-HAUTE-PROVENCE"
"HAUTES-ALPES"
"ALPES-MARITIMES"
"ARDENNES"
"ARIEGE"
"AUBE"
"AUDE"
"AVEYRON"
"BOUCHES-DU-RHONE"
"CALVADOS"
"CHARENTE"
"CHARENTE-MARITIME"
"CHER"
"CORREZE"
"CORSE-DU-SUD"
"HAUTE-CORSE"
"COTE-D'OR"
"HAUTS-DE-SEINE"
"SEINE-SAINT-DENIS"
"VAL-DE-MARNE"
"GUYANE"
"REUNION"
```
#### `"searchLocalityNAME"`
Limite la liste des points remontés à une ou plusieurs ville.
Valeurs autorisées : ...
### Filtrage dans la carte
```
......@@ -228,149 +450,3 @@ paramsFiltre : { conditionBlock : "and" | "or" , conditionTagsInBlock : "and" |
"magasin de producteurs" : "MagasinDeProducteurs",
"Groupement d'achat" : "GroupementDAchat",
```
\ No newline at end of file
`"Nord" : ["Nord","MEL"],` : assigner plusieurs tags pour un filtre
`"request" : {` : requête transmise à Communecter pour afficher des résultats lors de l'ouverture de la carte
`"sourcekey" : "BretagneTelecom",` : clé fournit par Communecter pour accéder aux données (MANDATORY)
`"pagination" : 1000,` : nombre de points remonté par requête
`"searchType" : ["organizations", "projects", "events"],` : type de recherche dans la DB communecter (MANDATORY)
`"mainTag" : ["TiersLieux" ]` : tag principal des points remontés ou créés via la carte auront le tag mentionné
`"searchTag" : ["Nord","MEL"],` : filtrer par tags
`"searchLocalityDEPARTEMENT" : ["ISERE"],` : filtrer par département
`"searchLocalityREGION" : ["POLYNESIE"],` : filtrer par région
`searchLocalityNAME" : ["LYON"],` : filtrer par Ville
### Liste des régions à utiliser
- "Île-de-France"
- "NOUVELLE-CALEDONIE"
- "POLYNESIE"
- "Bourgogne-Franche-Comté"
- "Aquitaine-Limousin-Poitou-Charentes"
- "Alsace-Champagne-Ardenne-Lorraine"
- "Normandie"
- "Mayotte"
- "Nord-Pas-de-Calais-Picardie"
- "Languedoc-Roussillon-Midi-Pyrénées"
- "Provence-Alpes-Côte d'Azur"
- "Pays de la Loire"
- "Auvergne-Rhône-Alpes"
- "Guadeloupe"
- "Martinique"
- "Bretagne"
- "Centre-Val de Loire"
- "Corse"
- "Guyane"
- "La Réunion"
### Liste des Département à utiliser
- "ESSONNE"
- "YONNE"
- "TERRITOIRE DE BELFORT"
- "HAUTE-VIENNE"
- "VOSGES"
- "VAL-D'OISE"
- "SEINE-MARITIME"
- "MAYOTTE"
- "SEINE-ET-MARNE"
- "YVELINES"
- "DEUX-SEVRES"
- "SOMME"
- "TARN"
- "TARN-ET-GARONNE"
- "VAR"
- "VAUCLUSE"
- "VENDEE"
- "VIENNE"
- "PAS-DE-CALAIS"
- "PUY-DE-DOME"
- "PYRENEES-ATLANTIQUES"
- "HAUTES-PYRENEES"
- "PYRENEES-ORIENTALES"
- "BAS-RHIN"
- "HAUT-RHIN"
- "RHONE"
- "HAUTE-SAONE"
- "SAONE-ET-LOIRE"
- "SARTHE"
- "SAVOIE"
- "ISERE"
- "HAUTE-SAVOIE"
- "PARIS"
- "GUADELOUPE"
- "MARTINIQUE"
- "LOT-ET-GARONNE"
- "LOZERE"
- "ARDECHE"
- "MAINE-ET-LOIRE"
- "LOIRE-ATLANTIQUE"
- "MANCHE"
- "MARNE"
- "HAUTE-MARNE"
- "MAYENNE"
- "MEURTHE-ET-MOSELLE"
- "MEUSE"
- "MORBIHAN"
- "MOSELLE"
- "NIEVRE"
- "NORD"
- "OISE"
- "ORNE"
- "COTES-D'ARMOR"
- "CREUSE"
- "DORDOGNE"
- "DOUBS"
- "DROME"
- "EURE"
- "EURE-ET-LOIR"
- "FINISTERE"
- "GARD"
- "HAUTE-GARONNE"
- "GERS"
- "GIRONDE"
- "HERAULT"
- "ILLE-ET-VILAINE"
- "INDRE"
- "INDRE-ET-LOIRE"
- "JURA"
- "LANDES"
- "LOIR-ET-CHER"
- "LOIRE"
- "ALLIER"
- "HAUTE-LOIRE"
- "CANTAL"
- "LOIRET"
- "LOT"
- "AIN"
- "AISNE"
- "ALPES-DE-HAUTE-PROVENCE"
- "HAUTES-ALPES"
- "ALPES-MARITIMES"
- "ARDENNES"
- "ARIEGE"
- "AUBE"
- "AUDE"
- "AVEYRON"
- "BOUCHES-DU-RHONE"
- "CALVADOS"
- "CHARENTE"
- "CHARENTE-MARITIME"
- "CHER"
- "CORREZE"
- "CORSE-DU-SUD"
- "HAUTE-CORSE"
- "COTE-D'OR"
- "HAUTS-DE-SEINE"
- "SEINE-SAINT-DENIS"
- "VAL-DE-MARNE"
- "GUYANE"
- "REUNION"