Différences entre versions de « Exporter l'agenda au format iCalendar (iCal) »
(9 versions intermédiaires par 3 utilisateurs non affichées) | |||
Ligne 1 : | Ligne 1 : | ||
Bokeh vous permet d'exporter des événements au format iCalendar (iCal), voir la [https://tools.ietf.org/html/rfc5545 spécification]. | Bokeh vous permet d'exporter des événements au format iCalendar (iCal), voir la [https://tools.ietf.org/html/rfc5545 spécification]. | ||
+ | |||
+ | == Démonstration en vidéo == | ||
+ | {{#ev:youtube|https://youtu.be/Swy7ZjK-tho}} | ||
+ | |||
+ | |||
+ | == Accès aux évènements au format iCal == | ||
+ | |||
+ | === Via la boîte calendrier === | ||
+ | |||
+ | Le paramétrage de la boîte calendrier vous permet d'afficher un lien de téléchargement du flux iCal des événements affichés par le calendrier. | ||
+ | |||
+ | [[Fichier:Admin agenda ical.png|center]] | ||
+ | |||
+ | |||
+ | Lorsque activé, l'agenda affiche l'icône [[Fichier:ical_button.png]] qui permet à l'usager de télécharger l'export iCal. | ||
+ | |||
+ | === Via un article / événement === | ||
+ | |||
+ | Un article de type événement affiche automatiquement le bouton [[Fichier:ical_button.png]] pour exporter cet événement. | ||
+ | |||
+ | === Via une URL === | ||
Les flux iCal sont disponibles à l'adresse [url de Bokeh]/cms/ical[/id_profil/YYY][/id_module/XXX]. | Les flux iCal sont disponibles à l'adresse [url de Bokeh]/cms/ical[/id_profil/YYY][/id_module/XXX]. | ||
Ligne 7 : | Ligne 28 : | ||
* http://bibliotheque.ville.fr/cms/ical/id_profil/14 exporte l'agenda des événements du profil 14 avec les préférences par défaut. | * http://bibliotheque.ville.fr/cms/ical/id_profil/14 exporte l'agenda des événements du profil 14 avec les préférences par défaut. | ||
* http://bibliotheque.ville.fr/cms/ical/id_profil/14/id_module/5 exporte l'agenda des événements du profil 14 avec les préférences de la boite 5 de ce profil. | * http://bibliotheque.ville.fr/cms/ical/id_profil/14/id_module/5 exporte l'agenda des événements du profil 14 avec les préférences de la boite 5 de ce profil. | ||
+ | |||
+ | |||
+ | Si vous souhaitez diffuser le lien pour que vos usagers s'abonnent au flux, il est préférable de diffuser le lien complet. | ||
+ | |||
+ | Par exemple : | ||
+ | * http://bibliotheque.ville.fr/cms/ical/icalendar.ics | ||
+ | * http://bibliotheque.ville.fr/cms/ical/id_profil/14/id_module/5/icalendar.ics | ||
+ | |||
+ | A noter que le format OpenAgenda est egalement disponible via les url suivantes : | ||
+ | * http://bibliotheque.ville.fr/cms/openagenda | ||
+ | * http://bibliotheque.ville.fr/cms/openagenda/id_profil/14/id_module/5 | ||
+ | |||
+ | Voir ici pour le format OpenAgenda : [[https://openagenda.zendesk.com/hc/fr/articles/203034982-L-export-Json-d-un-agenda]] | ||
== Quels événements sont exportés ? == | == Quels événements sont exportés ? == | ||
Ligne 66 : | Ligne 100 : | ||
* X-BOKEH-TAGS:liste des tags séparés par des ; | * X-BOKEH-TAGS:liste des tags séparés par des ; | ||
Cette propriété n'est pas répétable. | Cette propriété n'est pas répétable. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
[[Catégorie:Interface_publique]] | [[Catégorie:Interface_publique]] |
Version actuelle datée du 13 août 2020 à 16:31
Bokeh vous permet d'exporter des événements au format iCalendar (iCal), voir la spécification.
Démonstration en vidéo[ ]
Accès aux évènements au format iCal[ ]
Via la boîte calendrier[ ]
Le paramétrage de la boîte calendrier vous permet d'afficher un lien de téléchargement du flux iCal des événements affichés par le calendrier.
Lorsque activé, l'agenda affiche l'icône qui permet à l'usager de télécharger l'export iCal.
Via un article / événement[ ]
Un article de type événement affiche automatiquement le bouton pour exporter cet événement.
Via une URL[ ]
Les flux iCal sont disponibles à l'adresse [url de Bokeh]/cms/ical[/id_profil/YYY][/id_module/XXX].
Par exemple:
- http://bibliotheque.ville.fr/cms/ical exporte l'agenda des événements du profil par défaut avec les préférences par défaut.
- http://bibliotheque.ville.fr/cms/ical/id_profil/14 exporte l'agenda des événements du profil 14 avec les préférences par défaut.
- http://bibliotheque.ville.fr/cms/ical/id_profil/14/id_module/5 exporte l'agenda des événements du profil 14 avec les préférences de la boite 5 de ce profil.
Si vous souhaitez diffuser le lien pour que vos usagers s'abonnent au flux, il est préférable de diffuser le lien complet.
Par exemple :
- http://bibliotheque.ville.fr/cms/ical/icalendar.ics
- http://bibliotheque.ville.fr/cms/ical/id_profil/14/id_module/5/icalendar.ics
A noter que le format OpenAgenda est egalement disponible via les url suivantes :
- http://bibliotheque.ville.fr/cms/openagenda
- http://bibliotheque.ville.fr/cms/openagenda/id_profil/14/id_module/5
Voir ici pour le format OpenAgenda : [[1]]
Quels événements sont exportés ?[ ]
Si vous précisez un d'identifiant de boîte calendrier dans le paramètre id_module, le critère de sélection des articles s'appliquera sinon la recherche s'effectuera sur tous les articles.
À partir des articles possibles, les filtres suivants sont appliqués:
- l'article doit avoir des dates d'agenda
- la date de fin d'agenda doit être future
- l'article doit être publié
Les événements sont triés par date de début d'événement.
Correspondance des données Article dans le format iCal[ ]
iCal | Article Bokeh | Notes |
---|---|---|
UID | Identifiant interne Bokeh | |
DTSTART | Agenda du | |
DTEND | Agenda au | |
SUMMARY | Titre | |
CATEGORIES | Catégorie | Sous forme hiérarchique, ex: Agenda/Ateliers créatifs |
LOCATION | Libellé du lieu | |
GEO | Géolocalisation du lieu | Si le lieu dispose d'une longitute et d'une latitude |
DESCRIPTION | Contenu de l'article | Version texte seul, sans le balisage de mise en forme HTML |
X-ALT-DESC | Contenu de l'article | Version HTML |
ATTACH | Première image du contenu de l'article | |
URL | Url d'accès direct à l'article | |
RRULE | Tous les | Bokeh génère une règle de récurrence hebdomadaire pour les jours sélectionnés jusqu'à la date de fin d'agenda. Si l'évènement ne dure pas toute la journée, l'heure de fin est celle de la date de fin. Par exemple pour un évènement se répétant tous les mardis de 15h à 16h, la date de début peut être 01/01/2017 15:00 et celle de fin 01/01/2018 16:00. |
Extensions propres à Bokeh[ ]
Bokeh exporte deux propriétés spécifiques:
Pour les champs personnalisés:
- X-BOKEH-CUSTOMFIELD;NAME="nom du champ":"valeur du champ"
Cette propriété peut donc être répétable, par exemple:
X-BOKEH-CUSTOMFIELD;NAME="Public":"Adulte" X-BOKEH-CUSTOMFIELD;NAME="Accès":"Sur inscription"
Pour les tags:
- X-BOKEH-TAGS:liste des tags séparés par des ;
Cette propriété n'est pas répétable.