Ajout des templates de YAML et mise à jour du readme

README.md

@@ -1,2 +1,6 @@
-# ezcheck
-Objets contrôle et anomalie. Construction de dashboards dans l'espace privé
+# Plugin Check Factory
+
+Le plugin Check Factory a pour objectif de fournir des objets et des API génériques de gestion de contrôles et de leurs
+observations et de faciliter la construction de dashboards de suivi au travers d’une interface utilisateur dans l’espace privé.
+
+La documentation est consulatble sur SPIP-Contrib : https://contrib.spip.net/Check-Factory

ezcheck/controles/type_controle.yaml.template

@@ -0,0 +1,101 @@
+# Template de fichier descriptif d'un type de contrôle
+# ----------------------------------------------------
+# - fichier : type_controle.yaml.template
+# - localisation : les fichiers YAML sont stockés dans le dossier relatif ezcheck/controles/
+
+# Description du type de contrôle:
+# --------------------------------
+# Nom littéral du type de contrôle en texte ou item de langue (facultatif,)
+# - facultatif, défaut: identifiant du type de contrôle
+# - texte ou item de langue
+nom: '<:xxxx:type_controle_xxxx_nom:>'
+
+# Description du rôle du type de contrôle
+# - facultatif
+# - texte ou item de langue
+description: '<:xxxx:type_controle_xxxx_desc:>'
+
+# Chemin de l'icone limité à son nom de fichier car recherché dans le thème privé
+# - facultatif, défaut: controle_defaut-24.svg
+icone: 'nomicone-xx.svg'
+
+# Fonction PHP d'exécution du contrôle: objet 'execution'
+# -------------------------------------------------------
+execution:
+  # Indique le chemin relatif du fichier dans le path, sans extension car toujours PHP, dans lequel est incluse la fonction
+  # - facultatif, défaut: vide.
+  #
+  # Si le champ n'est pas fourni c'est que le type de contrôle est sans fonction de contrôle. Trois formats sont autorisés:
+  # - '/nom_fichier' indique que le fichier est dans le répertoire relatif par défaut, soit 'ezcheck/controles/'.
+  # - 'dir_relatif/nom_fichier' indique qu'il faut utiliser le chemin relatif fourni tel que.
+  # - 'nom_fichier' indique que le fichier est à la racine d'un dossier du path (cas particulier du précédent).
+  include: '/nom_include_sans_extension'
+
+  # Indique le nom de la fonction d'exécution du contrôle
+  # - facultatif, défaut: identifiant du type de contrôle et il n'est pas nécessaire de l'indiquer dans le fichier
+  #
+  # L'utilisation de la valeur par défaut est nécessaire pour gérer les observations et recevoir la liste des
+  # arguments standard, à savoir, l'id du type de contrôle, l'auteur et les paramètres fonction du formulaire.
+  fonction: 'nom_fonction_ou_vide_par_defaut'
+
+  # Liste ordonnée des paramètres de la fonction définie sous forme d'une liste de saisies.
+  # - facultatif
+  #
+  # On peut passer des paramètres 'fixes' avec une saisie de type hidden.
+  parametres:
+    - saisie: 'input'
+      options:
+        nom: 'nom_saisie'
+        label: '<:xxxx:xxxx_label:>'
+        defaut: 30
+
+# Anomalies & corrections: objet 'anomalies'
+# ------------------------------------------
+anomalies:
+  # Indique le chemin relatif du fichier dans le path, sans extension car toujours PHP, dans lequel sont incluses
+  # les fonctions de correction automatique des anomalies.
+  # -facultatif, si le champ est vide ou non fourni et que des corrections existent, c'est que l'include coincide
+  #  avec celui de la fonction d'exécution du type de contrôle.
+  #
+  # Le format de configuration est identique à celui de la fonction d'exécution.
+  include: '/nom_include_sans_extension'
+
+  # Liste des identifiants d'anomalies que l'on peut acquitter manuellement.
+  # - facultatif défaut: vide
+  acquitter:
+    - 'rubplug_pfx'
+    - 'rubplug_loc'
+
+  # Liste des identifiants d'anomalies que l'on peut corriger automatiquement via une fonction PHP.
+  # - facultatif défaut: vide
+  corriger:
+    - 'rubplug_loc'
+
+# Affichage complémentaire HTML: objet 'affichage'
+# ------------------------------------------------
+affichage:
+  # Indique le chemin relatif du fichier dans le path, sans extension car toujours HTML.
+  # - facultatif défaut: vide
+  squelette: 'chemin/relatif/squelette'
+
+  # Liste des variables supplémentaires de contexte à passer au squelette
+  # - facultatif défaut: vide
+  #
+  # La liste est au format nom_variable: valeur_variable
+  contexte:
+    var1: 'valeur1'
+    var2: 'valeur2'
+    var_tableau:
+      index1: 'valeur3'
+    var3: '<:xxxx:xxxx_titre:>'
+
+  # Liste des paramètres du squelette définie sous forme d'une liste de saisies.
+  # - facultatif défaut: vide
+  #
+  # Tout comme les variables fixes de contexte, ces paramètres sont insérés dans l'environnement du squelette
+  parametres:
+    - saisie: 'input'
+      options:
+        nom: 'nom_saisie'
+        label: '<:xxxx:xxxx_label:>'
+        defaut: 'oui'

ezcheck/dashboards/dashboard.yaml.template

@@ -0,0 +1,45 @@
+# Template de fichier descriptif d'un dashboard
+# ---------------------------------------------
+# - fichier : dashboard.yaml.template
+# - localisation : les fichiers YAML sont stockés dans le dossier relatif ezcheck/dashboards/
+
+# Titre du dashboard
+# - obligatoire
+# - texte ou item de langue
+nom: '<:xxxx:dashboard_xxxx_nom:>'
+
+# Description du rôle du dashboard
+# - facultatif, vide si absent
+# - texte ou item de langue
+description: '<:xxxx:dashboard_xxxx_desc:>'
+
+# Nom de l'icone représentant le type de contrôle
+# - facultatif, 'page-xx.svg' si absent
+icone: 'nomicone-xx.svg'
+
+# Configuration des groupes de types de contrôle
+# - obligatoire, au moins un groupe est nécessaire
+# - Liste description
+groupes:
+  -
+    # Identifiant unique du groupe dans le dashboard
+    # - obligatoire
+    # - texte de type mot PHP
+    identifiant: 'identifiant_groupe1'
+    # Titre du groupe
+    # - obligatoire
+    # - texte ou item de langue
+    nom: '<:xxxx:groupe_xxxx_nom:>'
+    # Liste des identifiants de types de contrôle
+    # - obligatoire
+    controles:
+      - 'type_controle_1'
+      - 'type_controle_2'
+  -
+    identifiant: 'identifiant_groupe2'
+    nom: '<:xxxx:groupe_xxxx_nom:>'
+    controles:
+      - 'type_controle_3'
+      - 'type_controle_4'
+      - 'type_controle_5'
+      - 'type_controle_6'