Installation
- Téléchargez l’archive ’.zip’ de cette page vers le dossier de plugins de votre SPIP
- Installez le plugin depuis votre espace privé comme expliqué ici : https://www.spip.net/fr_article3396.html.
Utilisation
Chaque entrée de la liste, selon le type d’élément choisi, présente le titre de l’élément en question, un lien vers sa page ainsi que sa présentation.
Ce widget s’inclut dans vos squelettes en utilisant la balise #JS_SCROLLER :
#JS_SCROLLER{ width , height , type , maximum , coupe, direction , titre }
dont toutes les options sont facultatives (une valeur vide [1] vaudra la valeur par défaut) et correspondent à :
- width et height : les dimensions du bandeau (par défaut 600 x 20 pixels, hauteur de 100 pixels pour les documents),
- type : le type d’éléments SPIP présentés : ’articles’, ’breves’, ’sites’, ’rubriques’ ou ’documents’ (par défaut les articles),
- maximum : le nombre d’entrées affichées (par défaut 50),
- coupe : le nombre de caractères du texte présenté pour chaque entrée (par défaut 40),
- direction : la direction du texte sous forme de code ’ltr’ ou ’rtl’ (par défaut ’ltr’ : de gauche à droite) [2],
- titre : le titre du bandeau.
Concernant le titre du bandeau
La valeur par défaut de l’argument de la balise est ’defaut’, le titre ajouté sera alors construit depuis les chaînes de langues du plugin (chaîne du type « Les 20 derniers articles parus : ») [3]. Si vous voulez un titre vide, indiquez ’non’ pour cet argument [4]. Une valeur vide utilisera le titre par défaut.
Vous pouvez également préciser une chaîne de caractères qui sera utilisée comme titre personnel. Celle-ci sera passée si c’est possible par la fonction de traduction de SPIP : si vous souhaitez utiliser par exemple « <:mon_plugin:ma_chaine :> », indiquez simplement « mon_plugin:ma_chaine ».
Cas des documents
La boucle « documents » du plugin renvoie un bandeau présentant un aperçu des documents images du site (typiquement les documents portant les extensions ’gif’, ’jpg’ et ’png’).
Personnalisation
Styles CSS du bandeau
La balise charge le fichier « js_scroller.css », qui définit les styles CSS du bandeau. Vous pouvez modifier ce fichier selon vos besoins.
Vos propres boucles
Le plugin charge l’un des fichiers XML de son répertoire ’xml/’ [5]. Vous pouvez y ajouter votre propre boucle XML en créant un nouveau fichier dont le nom doit commencer par « scroller_items_ » suivi de l’argument que vous passerez dans l’attribut ’type’ de la balise.
Vos boucles doivent définir un ’item’ par objet comprenant les entrées XML suivantes :
- « titre » : le titre de l’entrée (obligatoire),
- « lien » : l’URL du lien créé sur ce titre (obligatoire),
- « description » : le texte de description ajouté après le titre,
- « url_doc » : l’URL du document (cas des images - doit être relative),
- « width » et « height » : la taille du document (cas des images),
- « typedoc » : le type MIME du document (cas des images - optionnel).
Il est conseillé d’indiquer des URLs relatives.
Par exemple pour lister les logos des brèves de la rubrique 2, créez le fichier « scroller_items_logos_breves.html » dans le répertoire « xml/ » du plugin contenant la boucle :
<BOUCLE_scroller(BREVES) {id_rubrique=2}{par date}{inverse} {pagination #ENV{counter}}>[(#LOGO_BREVE|=={''}|non)
<item>
<titre>[(#TITRE|supprimer_tags|texte_backend)]</titre>
<lien>[(#URL_BREVE|texte_backend)]</lien>
<description>[(#INTRODUCTION|couper{#ENV{couper}}|texte_backend)]</description>
<url_doc>[(#LOGO_BREVE|image_reduire{0,#ENV{height}}|extraire_attribut{src}|texte_backend)]</url_doc>
<width>[(#LOGO_BREVE|image_reduire{0,#ENV{height}}|extraire_attribut{width}|texte_backend)]</width>
<height>[(#LOGO_BREVE|image_reduire{0,#ENV{height}}|extraire_attribut{height}|texte_backend)]</height>
</item>
]</BOUCLE_scroller>
Puis appelez la balise comme ceci [6] :
#JS_SCOLLER{'',100,logos_breves,'','',#LANG_DIR,non}
Tester vos réglages
Vous pouvez tester les différentes options de la balise en éditant le fichier ’contenu/doc_js_scroller.html’ [7] dans le répertoire du plugin. Il s’agit du squelette de la documentation livrée avec le plugin (n’oubliez pas de recalculer la page après avoir modifié des réglages).
Exemples
Pour créer un bandeau présentant vos documents avec un aperçu de 50 pixels de haut, indiquez :
#JS_SCROLLER{'',50,documents}
Résultat :
Pour créer un bandeau présentant les 20 dernières brèves du site, dont les présentations seront coupées à 100 caractères et dont l’affichage dépendra de la direction de la langue courante :
#JS_SCROLLER{'','',breves,20,100,#LANG_DIR}
Résultat :
Pour créer un bandeau classique avec un titre personnel :
#JS_SCROLLER{'','','','','','',Mon titre perso}
// pour utiliser une chaîne de langue :
#JS_SCROLLER{'','','','','','',mon_plugin:ma_chaine}
// pour ne pas avoir de titre du tout :
#JS_SCROLLER{'','','','','','',non}
Résultat :
Aucune discussion
Ajouter un commentaire
Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :
Merci d’avance pour les personnes qui vous aideront !
Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.
Suivre les commentaires : |