NSINFO – Framework des modules NSINFO

NSINFO – Framework des modules NSINFO

Documentation du module · version 23.7.0 · éditeur NSINFO

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

2.2 Installation

1. Dans Dolibarr, menu Configuration > Modules/Applications, onglet Déployer/Installer un module externe.
2. Glisser l'archive module_nsinfo-X.Y.Z.zip et cliquer sur Envoyer fichier.
3. Activer le module NSINFO (dans la liste des modules).
4. Installer et activer ensuite les autres modules 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.

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.

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, enregistrés en un clic ;
• champs texte, listes, sélecteurs de couleur, avec un 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

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).

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).