From d6aad3acc8bc5c0df0885ebf0e76c8d357e673be Mon Sep 17 00:00:00 2001 From: Benjamin Renard Date: Tue, 13 Apr 2021 18:45:47 +0200 Subject: [PATCH] doc: add sections missing IDs --- doc/conf/LSattribute/triggers.docbook | 14 +++++------ doc/conf/LSobject/LSsearch.docbook | 2 +- doc/conf/LSobject/customActions.docbook | 2 +- doc/conf/LSobject/triggers.docbook | 10 ++++---- doc/conf/conf.docbook | 10 ++++---- doc/conf/globale.docbook | 8 +++--- doc/contrib/contrib.docbook | 2 +- doc/install/install.docbook | 2 +- doc/intro/intro.docbook | 33 ++++++++++++------------- doc/upgrade/upgrade.docbook | 28 ++++++++++----------- 10 files changed, 55 insertions(+), 56 deletions(-) diff --git a/doc/conf/LSattribute/triggers.docbook b/doc/conf/LSattribute/triggers.docbook index 06d723dc..a20ca1ef 100644 --- a/doc/conf/LSattribute/triggers.docbook +++ b/doc/conf/LSattribute/triggers.docbook @@ -5,7 +5,7 @@ traitements d'un &LSattribute;, des fonctions que vous pourrez développer vous même. De plus, le résultat de l'exécution de vos fonctions pourra influer sur le déroulement des processus. - + Actuellement, les évènements suivant sont gérés : @@ -57,10 +57,10 @@ l'exécution des actions liées, si une des fonctions retourne false , le processus s'arrêtera. - + Configuration - La configuration des déclencheurs se fait dans la définition des - &LSattributes;. Par exemple, pour définir les fonctions à exécuter après la + La configuration des déclencheurs se fait dans la définition des + &LSattributes;. Par exemple, pour définir les fonctions à exécuter après la modification de la valeur de l'attribut mail du type de &LSobject; LSpeople, c'est à dire lors de leur évenement after_modify, il faut définir la variable suivante : @@ -69,8 +69,8 @@ l'exécution des actions liées, si une des fonctions retourne false nom de la fonction à exécuter, soit un tableau de chaînes de caractères correspondant aux noms des fonctions à exécuter. - - Ecriture d'une fonction + + Écriture d'une fonction Une fonction exécuté par un déclencheur d'un LSattribute se déclare de la manière suivante : -Cette fonction doit prendre pour seul paramètre, le LSobject contenant le +Cette fonction doit prendre pour seul paramètre, le LSobject contenant le LSattribute sur lequel l'évenement survient et doit retourner soit True si tout s'est bien passé, soit False en cas de problème. Dans le cas d'un événement bloquant, si la fonction retourne diff --git a/doc/conf/LSobject/LSsearch.docbook b/doc/conf/LSobject/LSsearch.docbook index 65778c42..c5f761e9 100644 --- a/doc/conf/LSobject/LSsearch.docbook +++ b/doc/conf/LSobject/LSsearch.docbook @@ -503,7 +503,7 @@ contexte dans lequel cette recherche est effectuée. - + Ecriture d'une fonction implémentant une customAction Une fonction implémentant une customAction se déclare de la manière suivante : diff --git a/doc/conf/LSobject/customActions.docbook b/doc/conf/LSobject/customActions.docbook index 38cb354f..3ee33379 100644 --- a/doc/conf/LSobject/customActions.docbook +++ b/doc/conf/LSobject/customActions.docbook @@ -130,7 +130,7 @@ - + Ecriture d'une fonction implémentant une customAction Une fonction implémentant une customAction se déclare de la manière suivante : diff --git a/doc/conf/LSobject/triggers.docbook b/doc/conf/LSobject/triggers.docbook index 4987b9b6..b33ec61f 100644 --- a/doc/conf/LSobject/triggers.docbook +++ b/doc/conf/LSobject/triggers.docbook @@ -5,7 +5,7 @@ traitements d'un &LSobject;, des fonctions que vous pourrez développer vous même. De plus, le résultat de l'exécution de vos fonctions pourra influer sur le déroulement des processus. - + Actuellement, les évenements suivant sont gérés : @@ -65,10 +65,10 @@ l'exécution des actions liées, si une des fonctions retourne false , le processus s'arrêtera. - + Configuration La configuration des déclencheurs se fait dans la définition des types - d'&LSobjects;. Par exemple, pour définir les fonctions à exécuter après la + d'&LSobjects;. Par exemple, pour définir les fonctions à exécuter après la modification des LSobjects de type LSpeople, c'est à dire lors de leur évènement after_modify, il faut définir la variable suivante : @@ -77,7 +77,7 @@ l'exécution des actions liées, si une des fonctions retourne false nom de la fonction à exécuter, soit un tableau de chaînes de caractères correspondant aux noms des fonctions à exécuter. - + Ecriture d'une fonction Une fonction exécuté par un déclencheur d'un LSobject se déclare de la manière suivante : @@ -102,7 +102,7 @@ function maFonction ($object) { Cette fonction doit prendre pour seul paramètre, le LSobject sur lequel l'évènement survient et doit retourner soit True si tout s'est bien passé, soit False en cas de problème. Dans le cas d'un événement -bloquant, si la fonction retourne False, le processus est +bloquant, si la fonction retourne False, le processus est arrêté. diff --git a/doc/conf/conf.docbook b/doc/conf/conf.docbook index ae13519d..38505adc 100644 --- a/doc/conf/conf.docbook +++ b/doc/conf/conf.docbook @@ -1,19 +1,19 @@ - + Configuration - + - La configuration du projet est située principalement dans le dossier 'conf/'. + La configuration du projet est située principalement dans le dossier 'conf/'. Les exceptions seront détaillées par la suite. - + Toute la configuration du projet se fait par l'intermédiaire de fichiers définissant des variables &php; dont les valeurs sont utilisées par le programme. Ceci signifie que la syntaxe de ces fichiers doit être valide avec l'interpréteur &php; utilisé. - + &conf-globale; &conf-LSobject; diff --git a/doc/conf/globale.docbook b/doc/conf/globale.docbook index d5b10914..f79fb0f3 100644 --- a/doc/conf/globale.docbook +++ b/doc/conf/globale.docbook @@ -1,5 +1,5 @@ - + Configuration globale La plus grande partie de la configuration globale se trouve dans le fichier @@ -23,7 +23,7 @@ define('CONST2','val2') ?>]]> - + Variables globales @@ -97,7 +97,7 @@ define('CONST2','val2') - + Préférences globales Les variables globales suivantes ont une action globale, mais @@ -173,7 +173,7 @@ chacun des serveurs LDAP. - + Variables et constantes indépendantes diff --git a/doc/contrib/contrib.docbook b/doc/contrib/contrib.docbook index 6008e824..9ade6cf1 100644 --- a/doc/contrib/contrib.docbook +++ b/doc/contrib/contrib.docbook @@ -1,5 +1,5 @@ - + Contribution diff --git a/doc/install/install.docbook b/doc/install/install.docbook index b8f7c99e..52ed90fc 100644 --- a/doc/install/install.docbook +++ b/doc/install/install.docbook @@ -221,7 +221,7 @@ du dossier d'installation, c'est à dire dans notre exemple local.sh). Il s'agit en particulier dans ce fichier de configurer la connexion à votre annuaire. Vous pouvez vous inspirer du fichier d'exemple fourni et pour plus de détails, reportez-vous à - la section concernée. + la section concernée. Notez qu'il est possible de passer l'application en mode debug ce qui peut être utile par la suite. diff --git a/doc/intro/intro.docbook b/doc/intro/intro.docbook index e85f7614..33ec07a2 100644 --- a/doc/intro/intro.docbook +++ b/doc/intro/intro.docbook @@ -1,26 +1,26 @@ - + Introduction LdapSaisie est une application web d'administration d'annuaire LDAP développée -en PHP/Javascript. Cette application a pour but d'abstraire la complexité d'un +en PHP/Javascript. Cette application a pour but d'abstraire la complexité d'un annuaire par l'intermédiraire d'une interface d'administration simple et intuitive. L'application a été concue avec pour objectif premier une modularité maximum, ce qui permet l'extention ou l'adaptation facile de l'application par l'intermédiaire de modules, d'extentions et de greffons. Cette application peut être utilisée pour -administrer le système d'information basé sur l'annuaire LDAP et également en +administrer le système d'information basé sur l'annuaire LDAP et également en paralèlle pour permettre aux utilisateurs d'avoir accès aux données les concernants et éventuellement de les modifier. - + Fonctionnalités De part sa modularité, &LdapSaisie; est facilement extensible. Cependant, voici une liste non-exhaustive de ses fonctionnalités : Gestion d'annuaire simple et multi-branches Gestion d'un nombre illimité de types d'objets -Gestion d'un nombre illimité de populations se connectant à +Gestion d'un nombre illimité de populations se connectant à l'interface -Gestion fine des droits des utilisateurs, permettant la -maitrise des droits d'accès sur les objets de l'annuaire et leurs atributs, tout +Gestion fine des droits des utilisateurs, permettant la +maitrise des droits d'accès sur les objets de l'annuaire et leurs atributs, tout en permettant la délégation de droits. Gestion d'un grand nombre de types d'attributs : @@ -30,7 +30,7 @@ en permettant la délégation de droits. Date (format paramétrable) Booléen (valeurs paramétrables) Image/Photo - Mot de passe (génération de mot passe avec gestion d'une + Mot de passe (génération de mot passe avec gestion d'une politique fine) Adresse mail Flux RSS @@ -40,20 +40,20 @@ en permettant la délégation de droits. Quota de mails Clef publique SSH Liste déroulante à choix simple ou multiple - Relation à d'autres objets de l'annuaire/ Exemple : membres + Relation à d'autres objets de l'annuaire/ Exemple : membres d'un groupe, parrain d'un utilisateur, ... (valeur clé paramétrable) - + Chaque type d'attribut à des fonctionnalités qui lui sont propres - et qui rendent plus facile et agréable l'utilisation de l'interface (génération - automatique de mot de passe, génération des valeurs d'un champ à partir + et qui rendent plus facile et agréable l'utilisation de l'interface (génération + automatique de mot de passe, génération des valeurs d'un champ à partir d'autres, ...). - + Gestion d'un grand nombre de règles de vérification des valeurs des attributs : - + Alpha-numérique Lettres uniquement @@ -70,10 +70,10 @@ en permettant la délégation de droits. Politique de mot de passe (longueur/caractères autorisés/caractères obligatoires) - + -Gestion simplifiée des relations entre les objets de +Gestion simplifiée des relations entre les objets de l'annuaire Interface facilement personnalisable grâce à l'utilisation d'un système de template. @@ -94,4 +94,3 @@ dépendance. - diff --git a/doc/upgrade/upgrade.docbook b/doc/upgrade/upgrade.docbook index f91ff1d6..9f16007a 100644 --- a/doc/upgrade/upgrade.docbook +++ b/doc/upgrade/upgrade.docbook @@ -1,5 +1,5 @@ - + Mise à jour @@ -7,10 +7,10 @@ et regroupe des informations pratiques et utiles pour des montées de versions spécifiques entrainant par exemple une perte de rétrocompatibilité de la configuration. - + Procédure de mise à jour - + Installation via paquet Debian Lors d’une installation par paquet Debian, la mise à jour est grandement facilité par le packaging: Il vous suffit de mettre à jour le paquet ldapsaisie : @@ -22,7 +22,7 @@ apt install ldapsaisie la section suivante. - + Installation à partir des sources Lors d’une installation par à partir des sources, le script upgradeFromGit.sh permet d’automatiser la mise à jour, à condition que vous ayez suivi la procédure d’installation à ce sujet. @@ -50,7 +50,7 @@ apt install ldapsaisie - + Mise à jour 2.4.1 -> 3.0.0 Cette mise à jour majeure apporte de nombreuses nouveautés auxquelles il est important de prêter attention. @@ -59,7 +59,7 @@ url="&GIT_RAW_ROOT_URL;/debian/ldapsaisie.NEWS">debian/ldapsaisie.NEWS pour cela. Cette section listera en outre les points de vigilances à avoir et les adaptations à apporter sur votre configuration et votre code personnalisé. - + Fichier config.inc.php ajout du paramètre ConsoleTable avec pour valeur par défaut sous @@ -107,7 +107,7 @@ sur votre configuration et votre code personnalisé. - + Fichiers CSS Les fichiers light-*.css ont été retravaillés pour tous hériter du fichier light-blue.css qui défini les couleurs de l'interface au travers @@ -133,7 +133,7 @@ grep -Er 'url\(.*\.(png|gif|jpg)' /etc/ldapsaisie/local/css - + Fichiers PHP LSsession :: redirect() devient LSurl :: redirect(). @@ -217,10 +217,10 @@ grep -Er '(LSsession|LStemplate) *:: *addCssFile\(.*\.\.\/' /etc/ldapsaisie/loca - + Fichiers templates : - + Changement de l’inclusion des templates @@ -308,7 +308,7 @@ défaut): - + Fichiers templates fournis par defaut : Vérifier les modifications des fichiers templates fourni avec l’application et que vous auriez personnalisé. Pour cela, vous pouvez utiliser la commande suivante : recoverpassword.tpl qui ont particulièrement changés. - + Corriger les URL des images : ../../images/default/find.png devient ../image/find @@ -332,7 +332,7 @@ grep -Er '\.(png|gif|jpg)' /etc/ldapsaisie/local/templates - + Le cas de variable de template <literal>{$LSsession_css}</literal> et <literal>{$LSsession_js}</literal> : Ceci est déjà géré si vous étendez bien vos templates du fichier base.tpl (pour les pages non-connectées) ou base_connected.tpl (pour les pages connectées). @@ -352,7 +352,7 @@ grep -Er '\.(png|gif|jpg)' /etc/ldapsaisie/local/templates - + Tous les fichiers : Modification des URLs