Nouvelles de Décembre

Alexandre · Décembre 10, 2018, 1:41

Chers développeurs, bonjour,

La documentation des plugins est un élément très important pour la bonne compréhension et l’utilisation de vos créations, et nous avons constaté que de nombreux plugins publiés sur le Market Jeedom ont un lien vers cette documentation, qui ne fonctionne pas.

Nous venons donc de mettre à jour notre propre documentation pour la partie développement de plugin.
Vous saurez tous comment mettre a jour et faire fonctionner votre Documentation pour vos propres plugin

https://jeedom.github.io/documentation/dev/fr_FR/documentation_plugin

Vous pouvez dés maintenant l’exploiter et corriger les éventuels dysfonctionnements.

Notre plateforme https://partenaires.jeedom.com/ est à votre disposition pour échanger sur le sujet.

Nous en profitons pour faire de même de notre côté et contrôler tous nos plugins.

D’ici fin janvier, nous contacterons individuellement chaque auteur pour lequel il reste des anomalies, afin de vous accompagner au mieux dans cette démarche.

Petite nouveauté sur le Market Jeedom, nous avons ajouté une banderole avec les 2 derniers plugins gratuit (officiel et tiers) et les 2 derniers plugins payant (officiel et tiers), afin de les mettre en valeur.

Merci pour votre lecture et votre participation.

L’equipe Jeedom

mika-nt28 · Décembre 11, 2018, 8:13

Le scoring du market n’existe plus?
Comment peut on savoir si toute est correcte?

Loic · Décembre 11, 2018, 5:21

Le scoring du market n’est pas capable de faire une telle analyse…

Mips · Décembre 11, 2018, 7:52

Bonne initiative.
Pour ma part, mes docs sont sur gitlab, le lien sur le market fonctionne (donc info.json correcte) etc par contre la doc n’a jamais été publiée sur https://doc.jeedom.com hors la dernière note de la doc fournie ici semble bien répéter que c’est la seule condition nécessaire (fichier info.json en stable sur le market).

Pour info, j’avais essayé de mettre la doc sur github et de donner les droits à zoic21 et activer l’option « génération de la documentation » mais après plusieurs jours aucun changements donc j’ai tout désactivé/supprimé.

Je suis curieux de comprendre ce que j’ai mal fait, ce qu’il manque, surtout pour la partie publication sur https://doc.jeedom.com.

Loic · Décembre 11, 2018, 7:55

Pour que ça soit sur le site doc.jeedom.com il faut absolument que votre plugin complet soit sur github avec le bon json et ça peut prendre plusieurs jours a apparaître le temps que ça remonte partout.

nebz · Décembre 17, 2018, 7:13

Bonjour Loic,

Sur

github.com

jeedom/documentation/blob/master/dev/fr_FR/structure_info_json.md

**Documentation fichier info.json**

Intégré depuis la version 3.0 de Jeedom, le fichier **info.json** est obligatoire pour le bon fonctionnement des plugins, et leur bon déploiement sur le Market Jeedom.

Le fichier info.json est enregistré dans le dossier /plugin_info/ de votre plugin.

Liste des variables du fichier info.json

Les champs marqués d’un * sont des champs obligatoires.

Champs                   | Valeurs                                                                                                                   |
------------------------ | ------------------------------------------------------------------------------------------------------------------------- |
id *                     | Identifiant unique du plugin sur le Market Jeedom. Doit debuter par une lettre. Sans accents.                             |
name *                   | Nom du plugin.                                                                                                            |
description *            | Description du plugin, tel qu'il s’affichera sur le Market Jeedom Minimum 80 caractères. (`<br/>` pour le retour à la ligne.)                                  |                                                                                     |
usage                    | Informations complémentaires à la documentation sur l’usage du plugin.                                                    |
licence *                | Type de licence.                                                                                                          |
author *                 | Nom de l’auteur du plugin, tel qu’il sera affiché une fois le plugin installé, dans les informations de celui-ci.         |
require *                | Version minimum de Jeedom.                                                                                                |
category *               | Catégorie de classement du plugin sur le Market jeedom. **Respecter impérativement la nomenclature du tableau ci-dessous** |

This file has been truncated. show original

et

github.com

jeedom/plugin-template/blob/master/plugin_info/info.json

{
	"id" : "template",
	"name" : "Template",
	"specialAttributes" : {
		"object" : {
			"toto" : {"name" : {"fr_FR" : "Plop je suis un attribut spécial"},"type" : "input"},
			"toto2" : {"name" : {"fr_FR" : "Plop je suis un attribut spécial number"},"type" : "number"}
		},
		"user" : {
			"toto" : {"name" : {"fr_FR" : "Plop je suis un attribut spécial"},"type" : "select","values" : [{"value" : "1", "name" : "valeur 1"},{"value" : "plop", "name" : "valeur plop"}]}
		}
	},
	"description" : {
		"fr_FR": "Template servant de base à la création de plugins pour Jeedom"
	},
	"licence" : "AGPL",
	"author" : "Jeedom SAS",
	"require" : "3.3.39",
	"category" : "programming",
	"hasDependency" : false,

This file has been truncated. show original

il y a deux infos contradictoires, tellement contradictoires que j’ai toujours les deux dans mon info.json

video_link et forum_link (comme dans la doc) ou bien link.video et link.forum (comme dans le plugin template) ?

Loic · Décembre 17, 2018, 6:18

Salut,

Le bon c’est le deuxième mais après je suis pas sûr qu’on s’en serve.

domotruc · Janvier 6, 2019, 7:44

Bonjour,
J’ai utilisé cette nouvelle documentation pour mettre en place la doc de mon nouveau plugin et je n’ai pas rencontré de problèmes. Merci !
J’ai dû toutefois faire quelques modifications mineurs dans le template de doc afin de rendre possible la génération locale de la doc et pouvoir la vérifier avant de la pousser sur GitHub.
J’ai remonté les modifs faites dans un PR : https://github.com/jeedom/plugin-template/pull/32
Cordialement