Souhait
Nous souhaitons afficher tous les événements (publiés) du site sous forme calendaire, en proposant d’abord un affichage par mois, avec possibilité de basculer en affichage par semaine ou par jour.
Pré-requis
- SPIP 3.2.x, en ayant conservé l’organiseur dans plugins-dist.
- Plugin Agenda 3.6.11 minimum.
- Compréhension de la mécanique des squelettes de SPIP.
- Quelques évènements à afficher.
Vous n’avez pas besoin d’installer la librairire FullCalendar : elle est livrée avec SPIP.
Principe de base
Pour afficher notre agenda nous allons :
- créer un squelette agenda.html, avec un
div
dont l’attributid
estagenda
. - appeler dans le squelette le script
fullcalendar
et ses feuilles de styles. - utiliser ce script pour afficher l’agenda dans dans la
div#agenda
. - créer un squelette
agenda.json.html
fournissant au script les données à afficher dans l’agenda.
Fichiers manipulés
Dans cet article nous manipulons deux fichiers squelettes :
-
agenda.html
(qui contient le code nécessaire à l’affichage du calendrier). -
agenda.json.html
(qui nous permet de générer une liste d’événements compatible avec le script fullcalendar).
Si l’un de ces squelette existe déjà, je vous invite à utiliser le mécanisme de surcharge de SPIP.
Création du squelette
Il nous faut créer un squelette agenda.html
complet (à savoir une page SPIP classique avec les balises <head><body>
etc), dans lequel nous mettons un div
dont l’attribut id
est agenda
à l’endroit où nous souhaitons que l’agenda s’affiche.
Au dessus de ce div, nous allons appeler :
- plusieurs scripts javascript, dans leurs versions compressées :
moment-with-locales
, nécessaire au fonctionnement defullcalendar
[1] ;fullcalendar
, qui gère l’affichage proprement dit du calendrierlocale-all
, qui contient les traductions des informations de calendriers pourfullcalendar
;
- les styles CSS associés à
fullcalendar
.
Pour ce faire, nous utilisons la balise #CHEMIN
:
<link rel='stylesheet' type='text/css' href='#CHEMIN{lib/fullcalendar/fullcalendar.min.css}' />
<script type='text/javascript' src='#CHEMIN{lib/moment/moment-with-locales.min.js}'></script>
<script type='text/javascript' src='#CHEMIN{lib/fullcalendar/fullcalendar.min.js}'></script>
<script type='text/javascript' src='#CHEMIN{lib/fullcalendar/locale-all.js}'></script>
<div id="agenda">
</div>
Appel à l’agenda
Nous allons maintenant ajouter les fonctions javascript qui permettent d’afficher l’agenda. Pour ce faire, nous allons mettre au dessus du div (cela pourrait être dedans ou en dessous, cela importe peu) le code suivant, que je vais commenter :
<script type="text/javascript">/*<![CDATA[*/
jQuery(function($) {
$('#agenda').fullCalendar({
locale : '[(#LANG|strtolower)]',
editable: false,
navLinks: true,
eventLimit: true,
events: "[(#URL_PAGE{agenda.json})]",
header: {
left: [(#LANG_DIR|=={ltr}|?{"'prevYear,prev,next,nextYear,today'","'listMonth,month,agendaWeek,agendaDay'"})],
center: 'title',
right: [(#LANG_DIR|=={ltr}|?{"'agendaDay,agendaWeek,month,listMonth'","'today nextYear,next,prev,prevYear'"})]
},
fixedWeekCount: false,
allDayHtml:'<:organiseur:cal_jour_entier|textebrut:>',
loading: function(bool) {
if (bool) $('#calendrier-loading').show();
else $('#calendrier-loading').hide();
},
})
});
/*]]>*/</script>
- l. 2
jQuery(function($)
signifie que le navigateur va exécuter la fonction dans les accolades qui suivent. - l. 3
$('#agenda').fullCalendar
signifie que nous allons demander à javascript de modifier lediv
dont l’id est égale àagenda
pour y mettre à la place… l’agenda. - Le code entre parenthèse puis accolade correspond aux options passées à l’agenda (l. 4-21) :
- l. 4 : on passe le nom de la langue courante comme paramètre de langue à
fullcalendar
, ceci permet notamment d’avoir les bons noms de jours et de mois, et de déterminer automatiquement le premier jour de la semaine [2]. - l. 5 : on ne peut pas éditer les évènements depuis l’agenda.
- l. 6 : rend cliquable les numéros de jours / les noms de jours pour basculer sur une vue par jour.
- l. 7 : limite le nombre d’évènements affichés par jour à la hauteur de la cellule. Les évènements supplémentaires seront affichables via un clique supplémentaire.
- l. 8 : on récuperera la liste des évènements via un squelette
agenda.json.html
, nous détaillerons ce squelette dans la partie suivante - l. 9-13 : qu’affiche-t-on dans l’entête de l’agenda ? :
- l. 10 : à gauche, on met les boutons de navigation par mois/semaines/jours (selon le type de calendrier) et par années (dans tout les cas).
- l. 11 : au centre, on affiche le titre de l’agenda, correspondant à la période affichée (par ex. « Août 2012 »).
- l. 12 : à droite, on affiche la bascule vers l’agenda en mode mois, semaine ou jour.
- À noter l. 10 et l. 12 le test sur la direction de la langue, qui permet d’inverser les boutons de gauche et de droite si l’on est dans écriture de droite à gauche.
- l. 14 : afficher 4, 5 ou 6 semaines par mois en fonction du mois, et non pas systématiquement 6.
- l. 15 : changer la chaîne de langue pour « toute la journée », chaîne de langue définie par SPIP.
- l. 16-19 : pendant le temps du chargement, afficher l’élément HTML dont l’id est
calendrier-loading
. Nous reviendrons dessus plus bas.
- l. 4 : on passe le nom de la langue courante comme paramètre de langue à
D’autres options sont bien sûr possibles : on se reportera à la documentation de FullCalendar, malheureusement en anglais uniquement.
Sélection des évènements à afficher
Pour pouvoir afficher les évènements, il va falloir nous fabriquer un squelette agenda.json.html
(cf. l. 7) qui retournera les évènements qui nous intéreressent sous forme de données JSON.
La page spip.php?page=agenda.json
sera automatiquement appelée par FullCalendar, qui lui passera deux arguments, variant selon la période demandée :
-
start
, correspondant à l’ISO-8601 de la date de début. -
end
, correspondant à ISO-8601 de la date de fin [3].
Dans le squelette agenda.json.html
correspondant à cette page, nous pourrons récuperer ces informations via : #ENV{start}
et #ENV{end}
(voir mon article sur la balise #ENV
). On pourrait éventuellement passer d’autres arguments, en appliquant le filtre |parametre_url
sur #URL_PAGE{agenda.json}
.
Voilà un squelette agenda.json.html
basique :
#HTTP_HEADER{Content-Type: application/json; charset=#CHARSET}
#SET{start,#ENV{start}|strtotime}
#SET{end,#ENV{end}|strtotime}
[<BOUCLE_evenements(EVENEMENTS){', '}{par date_debut}
{!evenement_passe #ENV{start}}{!evenement_a_venir #ENV{end}}
>
[(#ARRAY{
id,#ID_EVENEMENT,
title,[(#TITRE|html2unicode|unicode2charset)],
allDay,[(#HORAIRE|=={non}|?{#EVAL{true},#EVAL{false}})],
start,#DATE_DEBUT,
end,#DATE_FIN,
url,#URL_ARTICLE,
description,[(#DESCRIPTIF|html2unicode|unicode2charset)]
}|json_encode)]
</BOUCLE_evenements>]
Je commente rapidement ce squelette :
- l. 1. On demande à SPIP de :
- Ne pas insérer de boutons d’administration.
- Dire au navigateur que la page retournée est du json, et fournir le charset.
- l. 2-3 : nous convertissons les dates de début et de fin de l’ISO-8601 au timestamp, et nous stockons dans les variables
start
etend
, homonymes aux variables d’environnement reçues. - l. 4 et l .18, les crochets servent à indiquer que nous retournons plusieurs objets JSON, chacun correspondant à un évènements.
- l. 4 nous bouclons sur les évènements. Entre chaque élément de la boucle, nous affichons une virgule (
{", "}
). Nous trions par date de début : ceci servira plus loin lors de l’affichage des données sans Javascript. - l. 5-7 pour sélectionner les évènements, nous utilisons les critères
evenement_passe
etevenement_a_venir
. Les options de ces critère nous permette de sélectionner tous les évènements à cheval sur la période considérée :-
{!evenement_passe #ENV{start}}
: pour sélectionner les événements en cours ou pas encore commencés à la date#ENV{start}
. -
{!evenement_a_venir #ENV{end}}
: pour sélectionner les événements finis ou en cours à la date #ENVend. - la combinaison de ces 2 critères va sélectionner les évènements entre les 2 dates [4]
-
- l. 9-17 : nous remplissons un tableau SPIP via
#ARRAY
, puis nous le transformons en objet JSON, via le filtre|json_encode
. Ce tableau comprend les entrées suivantes :-
id
: identifiant unique pour FullCalendar. Ca tombe bien, SPIP attribut un identifiant à chaque évenement :#ID_EVENEMENT
-
title
: le titre. On transforme les entité HTML en caractère unicode (|html2unicode
) puis on s’assure de proposer des données avec le bon charset (|unicode2charset
). -
allDay
: on précise si l’évènement dure toute la journée. Utiliséepour l’affichage par jour. Pour préciser cela, on s’appuie sur le champ#HORAIRE
qui contient justement cette information. On utilise#EVAL
pour indiquer qu’on insére une valeur booléenne et non pas textuelle. -
start
: date de début. On garde le format SQL. -
end
: date de fin. On garde le format SQL. -
url
: lien. Pour le coup, on renvoie vers l’article. -
description
: description de l’évènement. Là encore, on converti en Unicode, puis dans le charset correct.
-
À noter que l’on pourrait définir d’autres données pour chaque évènement : on se référera à la documentation de l’objet Event de FullCalendar. Par exemple, on pourrait indiquer des classes HTML en fonction de la rubrique.
Il vous faut également créer un fichier agenda.json_fonctions.php
contenant les lignes suivantes :
<?php
include_spip('inc/json');
?>
Ceci assurera que le filtre json_encode
est bien chargé [5].
Et pour les personnes sans Javascript ?
Et oui, tout le monde n’a pas de Javascript. Comment on fait alors ? La solution consiste à afficher un calendrier sous forme de liste dans un div
dont l’id est calendrier-loading
. Si Javascript est activé, FullCalendar va masquer ce div
.
Comme on a déjà fabriqué une boucle dans le squelette agenda.json.html
, nous allons nous en resservir, afin d’éviter de dupliquer les critères. Pour ce faire, nous allons utiliser la boucle DATA de SPIP 3.
Nous mettons donc dans le squelette agenda.html
:
<B_agenda>
<div id="calendrier-loading">
<p class="pagination">#PAGINATION</p>
<BOUCLE_agenda(DATA){source json, #PRODUIRE{fond=agenda.json, start=0,end=2147483647,_=#REM|time}|url_absolue}{pagination 15}>
<dl>
[<dt><:agenda:evenement_titre:></dt>
<dd><a href="#VALEUR{url}">(#VALEUR{title})</a></dd>]
[<dt><:agenda:evenement_date:></dt>
<dd>(#VALEUR{start}|Agenda_affdate_debut_fin{#VALEUR{end},#VALEUR{allDay}|=={true}|?{non,oui}})</dd>]
[<dt><:agenda:evenement_descriptif:></dt>
<dd>(#VALEUR{description})</dd>]
</dl>
</BOUCLE_agenda>
<p class="pagination">#PAGINATION</p>
</div>
</B_agenda>
- l. 1-3 : partie optionnelle avant de la boucle, avec la pagination éventuelle.
- l. 4 : code de la boucle. Nous bouclons sur des données (
(DATA)
) au format json ({source json
) extrait du fichier produit (#PRODUIRE
) par le squeletteagenda.json.html
avec la valeur destart
égale à 0, c’est à dire au 1 janvier 1970 à minuit, et la valeurend
égale à 2147483647, c’est à dire à la date maximale gérée par les ordinateurs actuel, le 19 janvier 2038, 3h14m7s [6]. Ainsi, nous sommes sûr de récuperer tout les évènements de l’agenda. L’option_=#REM|time
permet de s’assurer de ne pas avoir de cache, puisque nous passons comme argument le moment d’appel (|time
). Nous passons au chemin du fichier produit le filtre|url_absolue
pour obtenir l’url du fichier [7]. Nous paginons de 15 en 15. - l. 5-14 : nous affichons les données pour chaque évènement, via
#VALEUR{donnée}
. Ces données sont tirées du JSON. - l. 16 et suivante : partie optionelle arrière de la boucle.
On obtient alors un agenda, certes sommaire, mais au moins existant sans Javascript :
Conclusion
Vous voilà maintenant prêt à avoir un agenda avec FullCalendar. Bien sûr, il y aurait beaucoup de chose à améliorer, cependant cet article aborde déjà beaucoup de notions :
- produire du JSON avec SPIP.
- le formatage de FullCalendar.
- les boucles DATA.
Discussions par date d’activité
15 discussions
Bonjour
Impossible de faire marcher l’affichage du calendrier.
J’ai dupliqué la page article.html du dossier squelette-dist que j’ai renommé agenda.html, j’ai supprimé la boucle principale .
Pour le consulter mon agenda, je déduis qu’il faut aller sur monsite.com/spip.php ?page=agenda
Puis ajouté dans le head :
puis dans mon body
J’ai mis les 2 fichiers suivants dans mon dossier squelettes :
agenda.json.html
agenda.json_fonctions.php
que j’ai remplit selon les indications
Et l’agenda n’apparait pas sur ma page
monsite.com/spip.php ?page=agenda
Si je met le code pour non javascript, j’ai bien la liste des mes événements qui apparait, et si j’installe le plugin fullcalendar_facile le calendrier s’affiche avec mes événements, mais j’ai besoin des fonctions du plugin couleur_objet
Ça serait possible d’avoir un lien vers un jeu de fichiers
agenda.html
agenda.json.html
agenda.json_fonctions.php
qui marchent ?
Les miens sont téléchargeables ici :
https://www.chrisgaillard.com/agenda.zip
Merci de votre aide
- A priori le code m’a l’air correct. Il faudrait que je puisse voir en prod pour regarder le debugeur js et comprendre le problème
- full_calendar facile gère les couleurs d’objet
- c’est un example qui marche, donc tu peux regarder son code.
Merci pour votre réponse :
Page agenda.html vide
https://bit.ly/2QmEMLx
Page avec le plug Agenda Fullcalendar Facile
https://bit.ly/2N3U05X
Celui-ci est vide, bien que l’article 14 contienne un agenda avec des événements.
Home page avec le mini-calendar
https://bit.ly/2N85bKQ
Il n’y a que le mini-calendrier qui affiche les événements associés à plusieurs articles.
bon, deja tu n’appelle pas la librairie jquery moment.
Je recopie le code qu’il faut mettre (pour du 3.2)
c’est pour ca je pense que fullcalendaer ne peut pas se lancer.
Merci, j’ai mis le code, ça va un peu mieux, mais c’est pas encore tout à fait ça.
https://new-intranet.osug.fr/spip.php?page=agenda&var_mode=calcul
Vous dites que « full_calendar facile » gère les couleurs d’objet mais chez moi full_calendar facile n’affiche déjà pas les événements, c’est pour ça que je me tournais vers la version « difficile ».
Mais si c’est plus simple de de me dire pourquoi mes événements ne s’affichent pas je suis preneur. Je tente une copie de l’ensemble, chez un autre hébergeur au cas ou.
Disons que si fullcalendar facile ne marche pas, ca veut dire qu’il y a un bizn au niveau du javascript, donc la version « difficile » ne peut pas plus marcher....
est-ce qur vous avez d’autres plugins activé qui pourraient rentrer en conflit ?
Les plugs actifs :
Le Couteau Suisse 1.10.9
SkelEditor 2.7.11
Couleur d’Objet 0.4.2
Agenda 3.19.6
Agenda Fullcalendar Facile 2.3.1
Mini Calendrier 2.4.1
Ph 7.0.30
bon deja on va essayer de résoudre le problème avec full calendar facile.
Mais le lien que tu donne fournit une page 404.
https://new-intranet.osug.fr/spip.php?article14
Marche pas ça chez toi ?
maintenant si...
pour le reste l’agenda s’affiche, à quelle date as tu un evenement ?
aujourd’hui demain, tous les lundis du mois d’octobre
c’est bizarre, le json n’a rien. Il me faudrait un accès admin pour comprendre le problème.
OK log pass envoyé par message twitter
Je copie tout chez OVH ça fait pareil
http://www.gaillard.in/osugtest/spip.php?page=agenda
http://www.gaillard.in/osugtest/spip.php?article13
Pareil tu as un compte admin, et je peux même te passer un FTP sur cet hébergement si besoin.
je comprend pas, cela marche nickel en local chez moi avec ta base.
Un accès ftp serait apprécié (voir même ssh)...
Lien du fichier qui n’est pas bon
http://www.gaillard.in/osugtest/spip.php?page=agenda.json&couleur=article&start=2018-08-27&end=2018-10-01&_=1538230849463
J’ai envoyé le ftp par twitter.
Ça veut dire que c’est agenda.json.html qui n’est pas bon ?
Hum, il faut lire l’article.
Dans le fichier
agenda.json.html
les premières lignes ne sont pas les mêmes selon qu’on est en SPIP 3.2 ou en SPIP 3.1... et tu avais un code pour la 3.1...
Je pense que c’est la même chose pour le code que tu dois mettre dans le squelette... c’est d’ailleur pour cela qu’il y a un article pour 3.2 et un pour 3.1....
en l’occurence effectovement le code que tu as à l’aire plus proche de 3.1
Répondre à ce message
Bonjour,
La solution qui consiste à afficher un calendrier sous forme de liste dans un div dont l’id est « calendrier-loading » lorsque le Javascript est désactivé, fonctionne.
Est-ce que ça signifie que la boucle dans le squelette « agenda.json.html », utilisée par la boucle DATA de SPIP 3, fonctionne ?
Pourquoi les événements ne s’affichent pas lorsque le Javascript est activé ???
Le code du « agenda.json.html »
#HTTP_HEADERContent-Type : application/json ; charset=#CHARSET
#SETstart,#ENVstart|strtotime
#SETend,#ENVend|strtotime
[
[(#ARRAYid,#ID_EVENEMENT,title,[(#TITRE|html2unicode|unicode2charset)],allDay,[(#HORAIRE|==non| ?#EVALtrue,#EVALfalse)],start,#DATE_DEBUT,end,#DATE_FIN,url,#URL_ARTICLE,description,[(#DESCRIPTIF|html2unicode|unicode2charset)]|json_encode)]
]
Répondre à ce message
Bonjour,
Dans quel répertoire le fichier « agenda.json_fonctions.php » doit-il être disposé ?
Comme tous squelette, dans votre dossiers « squelettes »
C’est bien le cas. Mais comme rien ne s’affiche j’avais un petit doute...
Il y a 3 erreurs jsquery...
jquery est normalement chargé par SPIP dans l’entete (head) du html.
Si vous avez modifié vos squelettes sur ce point, c’est possible qu’il ne soit pas chargé.
Les fichiers agenda.html et agenda.json.html ont été vérifié mais il y a encore un défaut jquery.
La fonction est pourtant bien appelée dans l’entête du fichier agenda.html. Voir ci-dessous.
<script type='text/javascript'>/*<![CDATA[*/(function(H){H.className=H.className.replace(/\bno-js\b/,'js')})(document.documentElement);/*]]>*/</script>
[#NOM_SITE_SPIP]<script type='text/javascript' src='#CHEMIN{lib/moment/moment-with-locales.min.js}'></script>
<script type='text/javascript' src='#CHEMIN{lib/fullcalendar/fullcalendar.min.js}'></script>
<script type='text/javascript' src='#CHEMIN{lib/fullcalendar/locale-all.js}'></script>
url : http://www.ffmc73.org/spip.php?page=agenda
Bonjour,
Est-ce qu’il y aurait une piste pour expliquer un agenda qui ne ’affiche pas ??? Je sèche.
Cordialement.
Bonjour,
Est-ce que des événements et les articles liés à ces « événements » existent dans le site et sont « publiés » ?
Bonjour,
Oui, il y a plusieurs événements enregistrés.
L’appel des 3 scripts javascript dédiés à fullcalendar a été déplacé des balises « head » à juste au-dessus de la div « id=agenda » et la boucle « B_agenda » a été ajoutée sous la div « id=agenda »... Et l’agenda s’affiche... Mais reste vide :-(
Que manque t’il ???
En complément.
Il y a 4e bouton « Mon planning » qui s’affiche à droite des boutons « Jour/Semaine/Mois ».
Comment ceci est-il paramétré ?
4e bouton « Mon planning » qui s’affiche à droite des boutons « Jour/Semaine/Mois ».
Eurêka !
Dans le paramétrage du "header right" il fallait supprimer "listMonth" qui était après "month" "’agendaDay,agendaWeek,month"
Le 2e paramètre, ’today nextYear,next,prev,prevYear’ est-il correct ?
Répondre à ce message
Bonjour,
J’ai un souci avec des événements sur plusieurs jours.
Si sur un mois, j’ai plusieurs événements qui durent tous le mois, alors sur les jours avec un nombre d’événement important, un texte « +x éléments » apparaît, et en cliquant dessus, un « popover » apparaît avec la liste des événements de la journée, sauf que les événéments du mois sont répétés 4 ou 5 fois.
Comment corriger ce souci ?
il doit s’agit d’un bug de fullcalendar... je n’ai aucune idée de la manière de le corriger.
Il faudrait demander de l’aide sur les forums de fullcalendar....
Bonjour,
Avez-vous un lien pour constater ?
Avec les « Événement sur plusieurs jours » je n’ai pas de soucis, ni dans l’affichage d’un agenda, ni dans l’affichage d’une liste des événements dans une noisette.
exemple : https://www.lettonie-francija.fr/spip.php?page=agenda&lang=fr
Cordialement
Bonjour,
Je constate exactement le même problème sur votre agenda au mois de juin.
https://www.lettonie-francija.fr/spip.php?page=agenda&lang=fr
Si vous cliquez sur « +2 en plus » du 15 juin, vous pourrez visualiser le souci évoqué.
Bonjour,
Y aurait-il une différence d’affichage de l’ AGENDA selon le navigateur utilisé ?
Sur firefox écran bureau, au 15 juin l’image qui s’affiche est celle-ci, sans « +2 » .... ?
Il faut réduire la hauteur du navigateur pour que cela s’affiche de la sorte.
Exact, l’adaptabilité d’affichage de l’Agenda créé ce soucis d’une liste pop-up avec de multiples événements répétés, lorsque les événements existent sur plusieurs jours ...
Sous squelette ESCAL-V4, on a bien cherché, mais en affichant « AGENDA PLEINE PAGE » , la solution n’est pas encore apparue.
Par contre en affichant l’AGENDA dans une noisette latérale en accueil, nous avons trouvé comment afficher autrement les « événements sur plusieurs jours », pour éviter les répétitions identiques. En juillet je n’ai pas d’exemple concret à afficher ... il faudrait aller regarder d’autres website sous Escal V4 avec la noisette « Evènements à venir »
Exemple : http://www.eglisealareunion.org/
Merci pour le retour.
Je cherche quand même une solution au problème d’agenda pleine page.
Répondre à ce message
c’est interessant. je pense que tout site qui se respecte devrait avoir besoin de ce type de fonctionalite. de nos jours tout est google, mais une version spip c’est tres pratique quand meme.
Il y a des tas de site qui n’ont absolument besoin d’aucun agenda et reste pour autant respectable...
Répondre à ce message
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 : |