statoolinfos/CONCEPT.md
2020-09-13 01:28:27 +02:00

47 lines
1.7 KiB
Markdown

# Concepts de StatoolInfos
## Principe générale
StatoolInfos s'appuie sur StatoolInfos qui utilise des fichiers publics disponibles via des liens web :
- 1 fichier web public pour décrire la fédération ;
- 1 fichier web public par organisation membre de la fédération ;
- 1 fichier web public par service d'organisation.
Chaque fichier web public étant acessible via un lien web, chaque fichier public peut se trouver sur un site web différent.
Chaque fichier web public contient des informations descriptives et potentiellement des métriques d'activité.
Il suffit de récupérer tous les fichiers web publics afin de pouvoir générer des pages web, des statistiques, des graphiques…
## Format des fichiers web publics
Dans StatoolInfos, ce sont des fichiers « properties », c'est à dire ne contenant que des lignes de texte au format « clé/valeur ». La clé consiste en un chemin de mots séparés par des points. Le premier mot est appelé la section.
Donc chaque fichier web public est une liste de sections.
Les lignes vides et les lignes commençant par un « # » sont ignorées.
Exemple :
'''
# [Organisation]
organization.name=Chapril
organization.description=Chapril est le chaton de l\'April.
organization.website=https://www.chapril.org/
organization.logo.url=
organization.owner.name=April
organization.owner.website=https://www.april.org/
organization.owner.logo=
organization.geography=
organization.contact.url=https://www.chapril.org/contact.xhtml
organization.contact.email=contact@chapril.org
organization.legal.url=
organization.technical.url=
organization.startDate=
organization.endDate=
'''
La liste des chemins est normalisée dans une ontologie.