CPLcommun - Installation

Téléchargez le paquet d'installation à partir de http://guppy.christianlautier.fr/download.php?lng=fr.

Le paquet contient 6 répertoires <admin, data, documentation, inc, perso, plugins>.

Le dossier documentation contient l'ensemble des articles de ce site concaténés au format PDF. Ce document est copié sur votre site par la procédure qui suit, mais il n'y a rien pour le lire. Pour ce faire, il vous faut l'extraire du fichier zip.

Vous installez le zip avec la fonction "installer" de GuppY de votre site. La bibliothèque est opérationnelle pour les autres plugins.

Une fois installé, l'icône  apparaît dans l'admin du site, dans la partie "Administration des plugins".

Il n'y a rien à faire pour administrer la bibliothèque de fonctions, mais on profite de ce module pour positionner quelques paramètres communs à tous les plugins ou à l'installation. En cliquant sur le l'icône CPLcommun vous affichez un écran intermédiaire qui a 2 fonctions :

1. la première partie de l'écran affiche des informations sur la version du plugin installée et sa compatibilité avec les versions de GuppY. Vous y trouvez aussi l'état des forks et, éventuellement, un lien pour les installer ou les désinstaller suivant leur statut. Consultez la documentation des forks pour savoir si vous devez les installer dans votre contexte.
2. la deuxième partie vous permet d'atteindre le formulaire de configuration.

A l'annonce d'une nouvelle version de GuppY, consultez mon site, pour connaître les nouvelles compatibilités et la nécessité ou non de télécharger une nouvelle version des plugins. Après l'installation, revenez sur cette page pour consulter l'état des forks.

Vous voyez sur la copie de cet écran les 4 lignes du bas qu'on retrouve sur tous les écrans d'administration de mes plugins. Outre les informations de version et de copyright, il y a un lien vers mon site où on peut trouver les manuels d'utilisation et un autre lien vers le forum de discussion pour demander de l'aide. Dans les autres copies d'écran, cette partie sera supprimée, pour ne pas polluer la documentation.

Fonctions à noter

Depuis la version 6.00.09, j'ai introduit des fonctions qui sont à disposition des autres plugins et qu'il faut signaler car aussi à disposition de l'administrateur.

fonction remplaceVariables

Dans une chaine de caractères, elle remplace toutes les variables sous la forme §§...§§ par quelque chose. Des variables prédéfinies sont traitées par la fonction. Voir plus loin la liste. Ce qui est plus intéressant, c'est qu'il est possible de définir dans le fichier  /perso/plugins/CPL_commun/CPL-fonctions-perso.inc (à créer) une fonction nommée convertVariable qui va pouvoir traiter vos propres variables. Dans le paquet de distribution, un fichier CPL-fonctions-perso-exemple.inc est fourni. Il donne en exemple l'affichage de 2 variables §§horloge§§ (copie de horlogenumerique) et §§logofoot§§; vous pouvez vous inspirer de ce fichier pour définir vos propres variables.

Pour être utile, cette fonction doit être appelée par d'autres programmes. C'est le cas d'editoPlus pour l'affichage du corps d'une affichette et de formulaire dans les champs haut et bas de page (cela permet de compenser la petite dimension du champ et d'afficher un gros bloc en quelques caractères).

Les variables existant à ce jour, sont :

• pseudo : affiche le pseudo de l'utilisateur connecté ou "Visiteur".
• horlogenumerique : affiche une horloge depuis la date jusqu'aux secondes, en l'incrémentant chaque seconde.
• horlogeanalogique : affiche une horloge à aiguille.

Vous pouvez voir la mise en oeuvre sur ce site et la tester sur le site de test.

Fonctions javascript LibereLigneMenu et gereLigneMenu

Si vous avez fait ce choix dans les paramètres de configuration, lorsque vous faites monter la page, la barre de menu reste bloquée en haut de l'écran. 9 fois sur 10 c'est pertinent. Parfois, pour diverses raisons, ça vous énerve, en particulier si vous avez une barre large. Cette fonction permet de libérer provisoirement la barre de menu et de l'autoriser à garder sa place "normale" sur la page.

Vous avez un exemple d'utilisation sur ce site avec le cadenas que j'ai inclus dans la barre de menu. En cliquant sur le cadenas, vous libérez la barre de menu, mais à la prochaine page, elle est à nouveau bloquée. Si vous voulez la bloquer pour une longue période, il faut faire un double clic. Un nouveau double clic la rebloque.

Si vous voulez mettre en oeuvre cette fonction sur votre site, vous pouvez copier le code suivant dans une boite libre que vous positionnerez à droite ou à gauche de la boite menu, dans config boîtes.

<div
onclick="javascript:LibereLigneMenu();"
ondblclick="javascript:gereLigneMenu();"
    <img alt="cadenas bloqué" border="0" id="cpl_cadenasoff" 
    src="http://votresite/plugins/CPL_commun/img/cadenas_off.png"
    style="display:inline; margin-top:0px;
    width: 32px;" title="Libérer la ligne de menu" /> 
    <img alt="Cadenas libre" border="0" id="cpl_cadenason" 
    src="http://votresite/plugins/CPL_commun/img/cadenas_on.png" 
    style="display:none; margin-top:0px; 
    width:32px;" title=" Bloquer la ligne de menu" />
</div>