Skip to content

Commit

Permalink
Typo in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Yann GARRAS committed Feb 8, 2016
1 parent 4493da8 commit 770517a
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 47 deletions.
4 changes: 2 additions & 2 deletions doc/fr_FR/partie_1.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Voici comment ça se décompose, tout d’abord un dossier du nom de votre plugi
* js : dossier contenant tous les fichiers de type javascript
* php : dossier contenant tous les fichiers de type php qui font de l’affichage
* css : il n’y en pas ici mais si besoin tous les fichiers css du plugin vont dedans
* modal : fichier contenant le code des modals du plugin
* modal : dossier contenant le code des modals du plugin
- plugin_info : contient les fichiers permettant à Jeedom de qualifier le plugin, de faire son installation et sa configuration
* info.xml : fichier contenant les informations de base du plugin (il est obligatoire sinon Jeedom ne verra pas le plugin), il contient entre autre l’identifiant du module, la description, les instructions d’installation...
* install.php : fichier contenant (si besoin) les méthodes d’installation et de désinstallation du plugin
* configuration.php : fichier contenant les paramètres à configurer du plugin indépendants des équipements de celui-ci (exemple pour le module Zwave l’ip du Raspberry Pi ayant la carte Razberry)
- doc : doit contenir la doc du plugin au format asciidoc, la racine et le fichier index.asciidoc. Toute les images sont dans doc/images. La doc elle meme est dans un dossier en fonction de la langue (ex en francais : doc/fr_FR)
- doc : doit contenir la doc du plugin au format asciidoc, la racine et le fichier index.asciidoc. Toutes les images sont dans doc/images. La doc elle meme est dans un dossier en fonction de la langue (ex en francais : doc/fr_FR)
Pour ce qui est de la convention de nommage des fichiers voici les impératifs :

Expand Down
12 changes: 6 additions & 6 deletions doc/fr_FR/partie_2.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ Il est composé des balises (une * indique que cette balise est obligatoire) :
- *name : nom du plugin (ça sera le nom affiché sur l'interface)
- description : description du plugin
- icon : classe css utilisée dans la balise <i> pour afficher l'icône du plugin. Doit obligatoirement commencer par "fa" suivi de l'icône voulu, la liste est disponible link:http://fortawesome.github.io/Font-Awesome/[là] licence : Licence sous laquelle est publiée le plugin
author : Auteur du plugin
- author : Auteur du plugin
- installation : notice d'installation du plugin si nécessaire
- *require : version minimale de Jeedom requise pour installation du plugin
- *version : version du plugin
- category : sert à catégoriser les plugins pour trouver celui qu'on veut plus rapidement
- include : balise un peu particulière, permet de spécifier à Jeedom s'il faut utiliser un fichier d'inclusion particulier (pour rappel il doit se trouver dans #PLUGIN_ID#/core/php), ici par exemple j'indique qu'il faut utiliser le fichier : "sms/core/php/sms.inc.php". Si cette balise n'est pas là Jeedom inclura par défaut le fichier contenant la classe du plugin (ici ça aurait été /sms/core/class/sms.class.php. Pour rappel le fichier de classe du plugin est nommé en fonction de l'ID du plugin)
- display : permet de spécifier le nom du fichier php (qui doit se trouver dans le dossier desktop/php) devant être appeler pour afficher le panel (lien dans le sous-menu accueil)
- mobile : permet de spécifier le nom du fichier html (qui doit se trouver dans le dossier mobile/html) devant etre appeler pour afficher la version mobile du panel
- display : permet de spécifier le nom du fichier php (qui doit se trouver dans le dossier desktop/php) devant c pour afficher le panel (lien dans le sous-menu accueil)
- mobile : permet de spécifier le nom du fichier html (qui doit se trouver dans le dossier mobile/html) devant devant être appelé pour afficher la version mobile du panel
Exemple :
Expand Down Expand Up @@ -48,13 +48,13 @@ La première partie commentée contient la licence (c'est mieux :) celle utilis
Ensuite vient l'inclusion du core de Jeedom (ça permet d’accéder au fonction interne)
Et après viennent les 2 fonctions :
- install_pluginid() : méthode permettant d'installer le plugin
- install_pluginid() : méthode permettant d'installer le plugin.
Ici l'installation ajoute une tâche cron à Jeedom
- update_pluginid() : méthode permettant d'installer le plugin
- update_pluginid() : méthode permettant d'installer le plugin.
Utilisé ici pour redémarrer la tache cron
- remove_pluginid() : méthode permettant de supprimer le plugin
- remove_pluginid() : méthode permettant de supprimer le plugin.
Ici la fonction supprime la tâche cron de Jeedom lors de la désinstallation
Exemple :
Expand Down
12 changes: 6 additions & 6 deletions doc/fr_FR/partie_3.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
===== PHP
Ce dossier contient la vue à proprement parler dedans on retrouve obligatoire la page de configuration du plugin (celle qui apparaîtra quand l'utilisateur fera plugin => catégorie => votre plugin), il est conseillé de nommer celle-ci avec l'id de votre plugin. Il peut aussi contenir le panel (page que l'utilisateur trouvera dans accueil -> nom de votre plugin).
Ce dossier contient la vue à proprement parler, dedans on retrouve obligatoire la page de configuration du plugin (celle qui apparaîtra quand l'utilisateur fera plugin => catégorie => votre plugin), il est conseillé de nommer celle-ci avec l'id de votre plugin. Il peut aussi contenir le panel (page que l'utilisateur trouvera dans accueil -> nom de votre plugin).

Tous les fichiers dans ce dossier doivent finir par .php et doit obligatoirement commencer par :

Expand Down Expand Up @@ -43,12 +43,12 @@ Pour la liste des propriétés des équipements c'est ici et des commandes c'est
Dernier point important sur la page de configuration celle-ci peut contenir autant d'équipements et de commandes que nécessaire. Cependant il y a quelques règles à respecter :

Tous les éléments ayant la classe eqLogicAttr doivent être dans un élément ayant la classe css eqLogic
Idem pour les éléments de classe css cmdAttr qui doivent être dans un élément de classe cmd
Idem pour les éléments de classe css cmdAttr qui doivent être dans un élément de classe cmd.
Toutes les commandes d'un équipement doivent se trouver dans l'élément ayant la classe eqLogic correspondant

===== JS

Tous les fichiers JS doivent se trouver dans le dossier JS (facile !!!). Il est conseillé de le nommer du même ID que votre plugin (pour la partie configuration, pour le panel vous faîtes comme vous voulez). Ce fichier JS (celui de la configuration du plugin) doit au minimum contenir une méthode addCmdToTable qui prend en paramètre l'objet commande à jouter. Voici un exemple simple :
Tous les fichiers JS doivent se trouver dans le dossier JS (facile !!!). Il est conseillé de le nommer du même ID que votre plugin (pour la partie configuration, pour le panel vous faîtes comme vous voulez). Ce fichier JS (celui de la configuration du plugin) doit au minimum contenir une méthode addCmdToTable qui prend en paramètre l'objet commande à ajouter. Voici un exemple simple :


----
Expand All @@ -71,7 +71,7 @@ function addCmdToTable(_cmd) {
}
----

Vous remarquerez qu'il y a une ligne par commande et que celle-ci a bien la classe css cmd. Vous pouvez aussi voir les éléments qui on la classe cmdAttr.
Vous remarquerez qu'il y a une ligne par commande et que celle-ci a bien la classe css cmd. Vous pouvez aussi voir les éléments qui ont la classe cmdAttr.


Plusieurs points importants :
Expand Down Expand Up @@ -168,7 +168,7 @@ Ce dossier contient vos fichiers CSS (il ne devrait pas être trop utilisé) , v
Le premier argument donne le dossier dans lequel le trouver (attention c'est le dossier père du dossier CSS), le deuxième le nom de votre fichier css, le troisième indique à Jeedom que c'est un fichier CSS et le dernier dans quel plugin il se trouve.

===== MODAL
Le dossier modal vous permet de stocker vos fichiers php destiner à afficher des modals. Voici comment les appeler à partir de votre page principale (ce code se met dans un fichier javascript) :
Le dossier modal vous permet de stocker vos fichiers php destinés à afficher des modals. Voici comment les appeler à partir de votre page principale (ce code se met dans un fichier javascript) :

On peut voir :

Expand Down Expand Up @@ -201,4 +201,4 @@ $('body').delegate('.helpSelectCron','click',function(){
});
----

Quand on clique sur le bouton d'assistant, ça récupère l'input dans lequel écrire puis appels l'assistant. Une fois la configuration finis dans l’assistant, le résultat est récuperé puis écris dans l'input précedement selectionné
Quand on clique sur le bouton d'assistant, ça récupère l'input dans lequel écrire puis appelle l'assistant. Une fois la configuration finie dans l’assistant, le résultat est récuperé puis écrit dans l'input précédemment selectionné
Loading

0 comments on commit 770517a

Please sign in to comment.