Variables du fichier addonini : Différence entre versions
De OviWiki
| (9 révisions intermédiaires par 2 utilisateurs non affichées) | |||
| Ligne 15 : | Ligne 15 : | ||
|- | |- | ||
|| description.fr="" || La description peut être internationalisée en ajoutant la langue en suffixe : description.en, description.fr ... || 6.8.0 | || description.fr="" || La description peut être internationalisée en ajoutant la langue en suffixe : description.en, description.fr ... || 6.8.0 | ||
| + | |- | ||
| + | || long_description="README.md" || Fichier markdown contenant une description exhaustive || 8.4.96 | ||
| + | |- | ||
| + | || long_description.fr="" || La description longue peut être internationalisée en ajoutant la langue en suffixe : description.en, description.fr ... || 8.4.96 | ||
|- | |- | ||
|| author="Nom Prénom ( mail@exemple.com )" || Nom de l'auteur et éventuellement son adresse mail || 4.0.0 | || author="Nom Prénom ( mail@exemple.com )" || Nom de l'auteur et éventuellement son adresse mail || 4.0.0 | ||
| Ligne 102 : | Ligne 106 : | ||
|| memory_limit="32M" || Tester la mémoire allouée à php || 7.4.0 | || memory_limit="32M" || Tester la mémoire allouée à php || 7.4.0 | ||
|- | |- | ||
| − | || tags || | + | || tags || Un ou plusieurs tags séparés par des virgules || 8.2.0 |
|- | |- | ||
|} | |} | ||
| Ligne 109 : | Ligne 113 : | ||
==== Exemple ==== | ==== Exemple ==== | ||
| − | <source lang=" | + | <source lang="ini"> |
| − | ; <?php | + | ;<?php /* |
| − | + | ||
[general] | [general] | ||
| − | name=" | + | name ="absences" |
| − | version=1. | + | version ="1.2.1" |
| − | + | addon_type ="EXTENSION" | |
| − | description | + | encoding ="UTF-8" |
| − | description. | + | description ="vacations, absences" |
| − | delete=1 | + | description.fr ="Module de gestion des congés" |
| − | + | delete =1 | |
| − | ov_version=" | + | ov_version ="8.2.0" |
| − | php_version="5.1.0" | + | php_version ="5.1.0" |
| − | + | addon_access_control ="0" | |
| − | author="Cantico" | + | author ="Cantico" |
| − | mysql_character_set_database="latin1,utf8" | + | mysql_character_set_database ="latin1,utf8" |
| − | icon=" | + | icon ="icon.png" |
| − | + | ||
| − | + | ||
| + | [addons] | ||
| + | LibTranslate =">=1.12.0rc3.01" | ||
| + | ;*/ | ||
</source> | </source> | ||
| + | ==== Tags Spécifiques ==== | ||
| + | |||
| + | |||
| + | Tags spécifiques à utiliser dans la configuration des modules | ||
| + | |||
| + | |||
| + | |||
| + | {|class="prettytable sortable" | ||
| + | |- | ||
| + | || '''Nom''' || '''Description''' | ||
| + | |- | ||
| + | || theme_application || Permet de préciser que le thème est destiné aux applications | ||
| + | |- | ||
| + | || theme_internet || Permet de préciser que le thème est destiné à un site internet | ||
| + | |- | ||
| + | || sitemap_bottom_menu || Permet de préciser que le thème fait appel à un nœud d'ID "bottom_menu" qui doit être géré par le plan du site | ||
| + | |- | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | === Définition des pré-requis === | ||
| + | |||
| + | |||
| + | les pré-requis avec les autres modules d'ovidentia doivent être listés dans la section addons. | ||
| + | |||
| + | Les modules packagés dans la distribution d'ovidentia doivent avoir des pré-requis inférieurs ou égal à ceux définis dans le fichier version.inc du noyau d'ovidentia. | ||
| + | Lors de la modification du code d'un application, il faut penser a modifier les pré-requis si une nouvelle fonction est ajoutée nécéssitant une version plus récente de php, d'un module ou du noyau. | ||
| − | + | Lors de la modification du code d'une librairie, il faut prendre garde a ne pas mettre des pré-requis sur des versions trop récentes qui ne serons pas disponibles sur les serveurs car les librairies peuvent être utilisées par un grand nombre d'applications et de sites. | |
Version actuelle en date du 9 septembre 2016 à 17:33
Ces variables peuvent êtres mises dans la section "general" ou dans la section "recommendations"
| Nom de la variable | Description | Depuis la version |
| name="addonname" | Nom du module | 5.0.0 |
| version="1.0" | Version du module | 4.0.0 |
| description="" | Description qui s'affiche dans la liste des modules sur la page réservée à l'administrateur | 5.0.0 |
| description.fr="" | La description peut être internationalisée en ajoutant la langue en suffixe : description.en, description.fr ... | 6.8.0 |
| long_description="README.md" | Fichier markdown contenant une description exhaustive | 8.4.96 |
| long_description.fr="" | La description longue peut être internationalisée en ajoutant la langue en suffixe : description.en, description.fr ... | 8.4.96 |
| author="Nom Prénom ( mail@exemple.com )" | Nom de l'auteur et éventuellement son adresse mail | 4.0.0 |
| db_prefix="gds_" | préfixe utilisé pour le nom des tables dans la base mysql d'Ovidentia (le préfixe sera utilisé lors de la suppression du module) | 5.0.0 |
| delete="1" | 1|0 autoriser la suppression du module (défaut 0) | 5.0.0 |
| addon_access_control="1" | 1|0 activer ou désactiver le contrôle d'accès par l'administrateur sur le module (défaut 1) | 6.6.90 |
| addon_type="EXTENSION" | Type de module, la valeur peut être "EXTENSION", "THEME" ou "LIBRARY". | 7.0.90 |
| package_collection="folder1, folder2, folder3" | Dans le cas ou le fichier ini existe pour décrire une archive ou un répertoire contenant plusieurs modules, la clef package_collection permet de donner la liste des éléments à installer, l'ordre sera respecté lors de l'installation |
7.0.91 |
| package_creation="addon1, addon2, addon3" | Lors de la création d'un package avec dépendances, ovidentia utilisera la liste des modules fournie dans ce champ pour créer l'archive, si le champ n'est pas indiqué toutes les dépendances serons ajoutées dans l'archive | 7.6.0 |
| image="mini.png" | image représentant le module en 200x150px jpg, png ou gif, le chemin de l'image est relatif au répertoire "images" du module | 6.7.91 |
| icon="icon.png" | icône représentant le module en 48x48px jpg, png ou gif, le chemin de l'image est relatif au répertoire "images" du module | 6.7.91 |
| register_globals="Off" | Tester la valeur de la variable register_globals de php | 5.8.7 |
| ov_version="6.6.0" | Version minimale d'ovidentia pour que le module fonctionne | 5.8.1 |
| php_version="5.0" | Version minimale de php pour que le module fonctionne | 5.8.1 |
| mysql_version="5.0" | Version minimale de mysql pour que le module fonctionne | 5.8.7 |
| encoding="UTF-8" | code de caractères du fichier addonini.php et du fichier history.txt | 6.7.92 |
| mysql_character_set_database="latin1" | Vérifier le code de caractère par défaut de mysql au niveau de la base, depuis ovidentia 7.0.0 plusieurs codes de caractères peuvent êtres supportés, on peut les séparer par des virgules | 6.6.0 |
| mysql_collation_database="latin1_swedish_ci" | Vérifier la collation par défaut de mysql au niveau de la base | 6.6.0 |
| mysql_max_allowed_packet=15M | Vérifier la valeur minimale de la variable max_allowed_packet de mysql | 6.6.0 |
| mysql_sql_mode="Undefined" | Vérifier la variable sql_mode n'est pas définie | 6.6.0 |
| mysql_granted_privileges="LOCK TABLES, DROP" | Tester les privilèges disponibles sur mysql (plusieurs valeurs séparées par des virgules) | 7.4.0 |
| upload_directory="Available" | Tester si il existe un répertoire d'upload correctement configuré | 5.8.7 |
| upload_max_file_size=30M | Vérifier la taille maximale d'un fichier téléchargé vers le serveur | 5.8.7 |
| lang_directory="Available" | Vérifier que le répertoire lang à la racine du site est accessible en écriture | 5.8.7 |
| images_directory="Available" | Vérifier que le répertoire images à la racine du site est accessible en écriture | 5.8.7 |
| mod_expect="Available" | Tester la présence du module expect de php | 6.6.90 |
| mod_mysql="Available" | Tester la présence du module mysql de php | 5.8.7 |
| mod_zlib="Available" | Tester la présence du module zlib de php | 5.8.7 |
| mod_xml="Available" | Tester la présence du module xml de php | 5.8.7 |
| mod_calendar="Available" | Tester la présence du module calendar de php | 5.8.7 |
| mod_ldap="Available" | Tester la présence du module ldap de php | 5.8.7 |
| mod_imap="Available" | Tester la présence du module imap de php | 5.8.7 |
| mod_gd2="Available" | Tester la présence du module gd de php en version 2 minimum | 5.8.7 |
| mod_mcrypt="Available" | Tester la présence du module mcrypt de php | 5.8.7 |
| mod_gettext="Available" | Tester la présence du module gettext de php | 5.8.7 |
| mod_pdf="Available" | Tester la présence du module pdf de php | 5.8.7 |
| mod_ftp="Available" | Tester la présence du module ftp de php | 5.8.7 |
| mod_curl="Available" | Tester la présence du module curl de php | 5.8.7 |
| mod_dom="Available" | Tester la présence du module dom de php | 7.3.0 |
| mod_iconv="Available" | Tester la présence du module iconv de php | 7.3.0 |
| mod_mbstring="Available" | Tester la présence du module mbstring de php | 6.7.91 |
| preinstall_script="preinstall.php" | Ajouter des prérequis personnalisés avant l'installation du module | 6.7.0 |
| configuration_page="admin" | Indiquer une page de paramétrage accessible à l'administrateur depuis la liste des modules | 7.1.91 |
| site_sitemap_node="Custom" | Vérifier la présence d'un nœud dans le plan du site configuré au niveau du site, il est possible d'indiquer plusieurs nœuds séparés par des virgules | 8.0.99 |
| memory_limit="32M" | Tester la mémoire allouée à php | 7.4.0 |
| tags | Un ou plusieurs tags séparés par des virgules | 8.2.0 |
Exemple
<source lang="ini">
- <?php /*
[general] name ="absences" version ="1.2.1" addon_type ="EXTENSION" encoding ="UTF-8" description ="vacations, absences" description.fr ="Module de gestion des congés" delete =1 ov_version ="8.2.0" php_version ="5.1.0" addon_access_control ="0" author ="Cantico" mysql_character_set_database ="latin1,utf8" icon ="icon.png"
[addons]
LibTranslate =">=1.12.0rc3.01"
- /
</source>
Tags Spécifiques
Tags spécifiques à utiliser dans la configuration des modules
| Nom | Description |
| theme_application | Permet de préciser que le thème est destiné aux applications |
| theme_internet | Permet de préciser que le thème est destiné à un site internet |
| sitemap_bottom_menu | Permet de préciser que le thème fait appel à un nœud d'ID "bottom_menu" qui doit être géré par le plan du site |
Définition des pré-requis
les pré-requis avec les autres modules d'ovidentia doivent être listés dans la section addons.
Les modules packagés dans la distribution d'ovidentia doivent avoir des pré-requis inférieurs ou égal à ceux définis dans le fichier version.inc du noyau d'ovidentia.
Lors de la modification du code d'un application, il faut penser a modifier les pré-requis si une nouvelle fonction est ajoutée nécéssitant une version plus récente de php, d'un module ou du noyau.
Lors de la modification du code d'une librairie, il faut prendre garde a ne pas mettre des pré-requis sur des versions trop récentes qui ne serons pas disponibles sur les serveurs car les librairies peuvent être utilisées par un grand nombre d'applications et de sites.
