
NSINFO – Framework des modules NSINFO
Documentation du module · version 23.9.10 · éditeur NSINFO
Sommaire
- Présentation
- Prérequis et installation
- Configuration
- Droits d’accès
- Ce que NSINFO apporte aux modules
- Pages de réglages
- Onglets ChangeLog et À propos
- Bibliothèque de médias
- Badges de statut
- Menu de gauche réduit et menus déroulants
- Zone de dépôt de fichiers
- Bouton « notre support »
- Calendrier de plage entre deux dates
- Choix d’une heure
- Onglets et sous-onglets d’administration
- Valeurs par défaut des réglages
- Sauvegarde des paramètres d’un module
- Traduction automatique
- Import de code HTML
- Notes pour les développeurs de modules
- Limites connues et FAQ
1. Présentation
NSINFO est le framework commun à tous les modules Dolibarr développés par NSINFO : une bibliothèque de fonctions, de styles et de composants partagés.
- Il est obligatoire : les modules NSINFO ne s’activent pas, ou leurs réglages ne fonctionnent pas, sans lui.
- Il n’ajoute ni menu, ni permission, ni document : il travaille en arrière-plan pour les autres modules.
- Il donne aux modules NSINFO une présentation commune : même page de réglages, mêmes onglets ChangeLog et À propos, mêmes composants.
- Il ne modifie pas le Core de Dolibarr.
- Il est traduit en français, anglais, allemand, italien et espagnol.
2. Prérequis et installation
2.1 Prérequis
| Élément | Version |
|---|---|
| Dolibarr | 11.0 ou supérieur (compatibilité annoncée jusqu’à 24.0) |
| PHP | 7.4 à 8.3 |
2.2 Installation
- Dans Dolibarr, menu Configuration > Modules/Applications, onglet Déployer/Installer un module externe.
- Glisser l’archive
module_nsinfo-X.Y.Z.zipet cliquer sur Envoyer fichier. - Activer le module NSINFO (dans la liste des modules).
- Installer et activer ensuite les autres modules NSINFO.
Installez et activez toujours NSINFO avant les autres modules NSINFO : un module qui exige le framework refuse de s’activer en expliquant qu’il manque le module « NSINFO ».
2.3 Mise à jour
- Déposer la nouvelle archive de la même façon : elle remplace l’ancienne version.
- Chaque module NSINFO indique dans sa documentation la version minimale de NSINFO dont il a besoin : mettez NSINFO à jour en premier lorsque vous mettez à jour un module.
- Les réglages sont conservés.
- Après une mise à jour, désactivez puis réactivez NSINFO pour charger ses nouveaux scripts (par exemple ceux du menu réduit).
3. Configuration
Page de réglages : Configuration > Modules, roue crantée du module NSINFO (onglets Paramètres, ChangeLog et À propos). Réservée aux administrateurs.
| Option | Description | Défaut |
|---|---|---|
| Afficher la version du module visible (si possible) | Affiche la version de NSINFO dans l’onglet À propos des modules NSINFO, et la transmet avec les demandes de support. | Activée |
| Désactiver la recherche de la version des modules | Activée, Dolibarr ne va plus chercher sur Internet la dernière version des modules externes à chaque affichage de la liste des modules : la page s’affiche plus vite. | Désactivée |
| Forcer le CSS pour les status des objects | Affiche les statuts des objets (brouillon, validé, payé…) sous forme de badges colorés homogènes dans les listes et les fiches. | Désactivée |
| Menu réduit : afficher les entrées des menus déroulants | Quand le menu de gauche est réduit à ses icônes, affiche aussi les icônes des entrées rangées dans les menus déroulants. Désactivée, seules les entrées principales restent affichées. Actualisez la page (Ctrl+F5) après un changement. | Désactivée |
Les options sont des interrupteurs oui / non, enregistrés immédiatement. Rechargez la page (Ctrl+F5) pour voir l’effet de l’option sur les statuts.
4. Droits d’accès
NSINFO ne déclare aucune permission. Sa page de réglages, comme celles des autres modules NSINFO, est réservée aux administrateurs Dolibarr.
Jetons de sécurité : les actions qui modifient un réglage (activer ou désactiver une option, la remettre à sa valeur par défaut…) exigent le jeton de sécurité de Dolibarr. Les interrupteurs des pages de réglages portent ce jeton. Un lien sans jeton n’est accepté que s’il vient d’une page du même site (cas des modules qui ne portent pas encore de jeton) ; l’ajout d’un élément par le bouton + reste accepté.
5. Ce que NSINFO apporte aux modules
5.1 Pages de réglages
Toutes les pages de réglages des modules NSINFO sont construites par le framework et se présentent de la même façon :
- options regroupées en blocs titrés ;
- interrupteurs oui / non, et une coche verte au bout de l’option modifiée une fois enregistrée ;
- enregistrement automatique : chaque modification est enregistrée dès qu’elle est faite (au changement du champ, à la touche Entrée ou au clic sur Mettre à jour), sans recharger la page. Une coche verte confirme l’enregistrement pendant une seconde ; une croix rouge signale un échec ;
- champs texte, nombres, dates, zones de texte et listes ; un champ texte affiche sa valeur par défaut tant que rien n’a été enregistré ;
- sélecteur de couleur moderne du navigateur, enregistré dès le choix de la couleur ;
- liste de sélection avec un bouton + pour créer l’élément qui manque (entrepôt, catégorie…) : après la création, la page de réglages revient avec le nouvel élément sélectionné et enregistré ;
- bouton Valeur par défaut lorsque l’option en a une ;
- interrupteur pour tout activer ou tout désactiver un groupe d’options, avec le libellé choisi par chaque module (sur « oui » quand toutes les options du groupe sont activées).
5.2 Onglets ChangeLog et À propos
| Onglet | Contenu |
|---|---|
| ChangeLog | Historique des versions du module : nouveautés et corrections, version par version. |
| À propos | Présentation de NSINFO, liens vers la documentation et vers les modules NSINFO sur Dolistore, bouton d’accès au support. |
5.3 Bibliothèque de médias
Les modules NSINFO qui gèrent des photos utilisent la bibliothèque de médias du framework :
- ajout d’une photo depuis l’ordinateur ou la galerie de l’appareil (téléphone, tablette) ;
- ajout d’une photo déjà présente dans la bibliothèque de médias ;
- recherche d’un fichier, détachement d’un média, suppression de fichiers (avec confirmation) ;
- message d’erreur si le fichier est trop volumineux ou existe déjà.
Le framework fournit aussi les fenêtres et les indicateurs de chargement utilisés par les modules NSINFO.
5.4 Badges de statut
Avec l’option « Forcer le CSS pour les status des objects », les statuts des objets Dolibarr (propositions, commandes, factures, objets des modules…) s’affichent sous forme de badges colorés de même forme, avec ou sans libellé, dans les listes et en tête des fiches.
5.5 Menu de gauche réduit et menus déroulants
Les modules NSINFO peuvent utiliser deux présentations du menu de gauche fournies par le framework :
- Réduire le menu : une entrée Réduire le menu ramène le menu de gauche à ses seules icônes, pour laisser plus de place aux pages ; l’entrée Agrandir le menu le rétablit. Les icônes sont alignées et centrées ; les sous-menus et les séparateurs sont masqués et les blocs resserrés. Le choix est mémorisé par le navigateur.
- Menus déroulants : les entrées d’un même groupe, avec leurs sous-menus, sont rangées sous une entrée parente munie d’une flèche pour les déplier ou les replier. Le choix est mémorisé par le navigateur, et le groupe s’ouvre de lui-même quand vous êtes sur l’une de ses pages.
En menu réduit, les menus déroulants sont masqués et seules les entrées principales restent, sauf si l’option « Menu réduit : afficher les entrées des menus déroulants » est activée.
5.6 Zone de dépôt de fichiers
Les modules NSINFO qui reçoivent des fichiers peuvent proposer une zone de dépôt : glissez-y vos fichiers, ou cliquez dessus pour les choisir. L’envoi démarre immédiatement, avec le message Envoi en cours….
5.7 Bouton « notre support »
Onglet À propos d’un module NSINFO, bouton notre support : ouvre le support NSINFO dans un nouvel onglet, avec les informations utiles déjà remplies (module et version, version de NSINFO si l’option « Afficher la version du module visible » est activée, version de Dolibarr et de PHP).
5.8 Calendrier de plage entre deux dates
Pour une période (du… au…), les modules NSINFO proposent un calendrier de plage qui affiche deux mois côte à côte. Deux façons de choisir :
- à la souris ou au doigt, un glisser d’un jour à l’autre (la plage donne les dates de début et de fin) ;
- un clic sur le premier jour, puis un clic sur le dernier.
Les jours non travaillés sont grisés et le nombre de jours de la période s’affiche. Sur mobile, le calendrier s’ouvre en feuille en bas d’écran. Les champs qui ne demandent qu’une seule date utilisent le même calendrier, limité à un jour : un clic suffit. Aucune bibliothèque externe n’est nécessaire.
5.9 Choix d’une heure
Les champs d’heure ouvrent une horloge à la manière d’Android : on choisit d’abord l’heure sur le cadran (anneau extérieur pour 1 à 12, anneau intérieur pour 13 à 00), puis les minutes. On clique, ou l’on appuie et l’on glisse, à la souris comme au doigt. Les boutons Maintenant, Effacer, Annuler et OK complètent le choix. Sur mobile, l’horloge s’affiche en feuille en bas d’écran.
5.10 Onglets et sous-onglets d’administration
Tous les modules NSINFO présentent leurs onglets d’administration de la même façon, y compris l’onglet ChangeLog : onglets au coin arrondi, fond doux au survol, onglet actif en gras avec un contour gris et un trait de couleur sous lui. Les modules peuvent regrouper leurs pages sous des sous-onglets qui ont la même présentation.
Pour les développeurs : le conteneur des sous-onglets porte la classe nsinfo-subtabs, chaque sous-onglet la classe nsinfo-subtab, et l’onglet affiché reçoit en plus la classe active.
5.11 Valeurs par défaut des réglages
Chaque réglage d’un module NSINFO peut avoir une valeur par défaut :
- un picto ↺ « remettre par défaut » apparaît devant le réglage dont la valeur diffère de l’origine, et disparaît dès qu’elle y revient, sans recharger la page ;
- un réglage texte, nombre, couleur ou liste sans valeur enregistrée est à sa valeur par défaut : il n’est pas signalé ;
- en haut de la page, un avertissement donne le nombre de réglages modifiés avec un lien « Tout remettre par défaut » ;
- quand la page est en sous-onglets verticaux (liste à gauche, contenu à droite), le picto ↺ du sous-onglet signale que des réglages ne sont plus à leur valeur par défaut, et un clic les remet tous par défaut pour ce sous-onglet ;
- un bouton « Remettre par défaut », avec confirmation, remet à l’origine un groupe de réglages choisi par le module.
5.12 Sauvegarde des paramètres d’un module
Chaque module NSINFO propose un onglet « Sauvegarde des paramètres », placé juste avant « ChangeLog » :
- Export : les paramètres du module sont enregistrés dans un fichier JSON nommé d’après le module, la société et la date. Les mots de passe, clés et jetons sont exclus, sauf si vous cochez la case prévue.
- Import : glissez le fichier (ou collez son texte) sur la page d’un autre Dolibarr. Seuls les paramètres du module concerné sont acceptés, un fichier d’un autre module est refusé.
- À l’import, les paramètres absents du fichier sont remis à zéro : le module reprend sa valeur par défaut. Les mots de passe, clés et jetons sont conservés si le fichier a été fait sans eux.
- Le détail des paramètres n’est affiché que si vous cochez « Afficher le détail » ; sinon la page donne un résumé.
5.13 Traduction automatique
Les modules NSINFO peuvent proposer un picto de traduction à côté des champs que vous avez choisis. Il n’apparaît que si un service de traduction est configuré.
- Services pris en charge : DeepL (gratuit ou Pro), Google Cloud Translation, Microsoft Azure Translator, LibreTranslate, MyMemory et Lingva Translate. La liste des langues proposées vient du service choisi.
- Réglages : onglet « Traduction » du module, avec un sous-onglet « API de traduction » (choix du service, clés, test) et un sous-onglet « Champs traduits » (les champs qui reçoivent le picto). La couleur et la position du picto sont réglables.
- Portée : réglages communs à tous les modules, ou propres à chaque module ; un module peut imposer l’une ou l’autre.
- Un texte mis en forme (gras, listes, liens, couleurs) garde sa mise en forme à la traduction, même avec les services qui ne traduisent que du texte simple.
- Si le module « Traduction à la demande » est activé, seuls les utilisateurs qui ont son droit peuvent traduire.
5.14 Import de code HTML
Sur un champ de texte enrichi, une zone de dépôt permet de glisser un fichier HTML : son contenu remplace celui du champ, après confirmation. Les modules peuvent aussi proposer un bouton et une fenêtre de dépôt d’un fichier.
5.15 Notes pour les développeurs de modules
- Réglages : fonction
nsinfoSetup(). Typescolor(sélecteur moderne),sellistavec les optionsaddurletaddtitle(bouton +),textavecdefaultpréaffiché. - Calendrier de plage :
nsinfoRangePickerLoad()puisnsinfoRangePicker(); optionsingle: truepour un seul jour. - Choix d’une heure :
nsinfoTimePickerLoad()puisnsinfoTimePicker(). - Actions :
nsinfoAction()exige le jeton de sécurité pour les actions GET qui modifient une constante. - Droits d’un utilisateur :
nsinfoRightsState()donne l’état des droits dont un module a besoin,nsinfoGiveRights()ajoute ceux qui manquent à un utilisateur existant. - Traduction automatique :
nsinfoTradTranslate(); le module déclare ses champs avec<module>TradFields(). - Onglets verticaux :
nsinfoVerticalTabsStart()etnsinfoVerticalTabsEnd(). - Menu de gauche :
nsinfoMenuMinimize(); groupes de menus déroulants avecnsinfoMenuGroupParent()etnsinfoMenuGroupChild(), à ajouter au « prefix » des entrées. - Dolibarr 20 et après : un module construit avec le ModuleBuilder de Dolibarr 23 peut utiliser le backport du framework :
getDolDefaultContextPage(),dolBuildUrl()etgetCallerInfoString()sont alors fournies lorsque Dolibarr est antérieur à la version 23.
6. Limites connues et FAQ
- Un module NSINFO refuse de s’activer : vérifiez que le module NSINFO est installé, activé et à la version demandée par ce module.
- Désactiver NSINFO rend inutilisables les pages de réglages des autres modules NSINFO : désactivez d’abord ces modules si vous voulez retirer le framework.
- La version n’apparaît pas dans l’onglet À propos : activez l’option « Afficher la version du module visible ».
- Les badges de statut ne changent pas après avoir activé l’option : rechargez la page sans le cache du navigateur (Ctrl+F5).
- L’entrée « Réduire le menu » ou les flèches des menus déroulants sont sans effet après une mise à jour : désactivez puis réactivez NSINFO, puis rechargez la page (Ctrl+F5).
- Une croix rouge apparaît à côté d’un réglage : l’enregistrement automatique a échoué. Validez de nouveau la valeur ; si la croix reste, rechargez la page (Ctrl+F5).