Openagenda

Description

Affichez des agendas depuis https://openagenda.com sur votre site.

Usage courant

This WordPress plugin allows you to embed any calendar hosted on https://openagenda.com on your WordPress site.

Upon activation, the plugin creates a new post type named Calendars. Just create a new calendar, provide the UID of the calendar you wish to display in the calendar settings box, and that’s it !

You can leave the content area for this calendar empty, as it will be populated automatically with your events !

Your events are automatically inserted after your content. If you wish to control where your events will be listed, just use the shortcode [openagenda] in your content.

Réglages

General settings can be found under the Calendar > Settings entry in the admin menu.

All data related to your API key or calendars can be found on https://openagenda.com.

Les réglages sont divisés en deux onglets : Général et Intégrations.

Réglages généraux

La page des réglages généraux propose les réglages suivants :

  • Open Agenda API key : Your user API key. Providing your account API key is required for the plugin to work properly. It can be found in your account on https://openagenda.com
  • Allow for embedded content : If your events contain embedded content, tick this box to allow the corresponding HTML tags.
  • Load default stylesheets : The plugin provides very basic styling and depends heavily on your theme’s styles. Disable this to rely 100% on your theme styles.
  • Cache duration : For performance reasons, basic requests to Openagenda are temporarily kept in cache. This settings controls the time to keep them cached, in seconds.
  • Delete all calendar content on uninstall ? : controls whether you want to delete all your content on uninstall.
  • Delete all options on uninstall ? : controls whether you want to delete all your calendar settings on uninstall.

Réglages des intégrations

Les onglets Integrations vous permettent d’affiner les réglages des différents services tiers utilisés par l’extension.

Réglages de l’intégration OpenStreetmap :

  • Default map tiles link : This is the map tile used for the various maps displayed by the plugin.
  • Default map tiles attribution link : this is the default attribution link placed on OpenStreetMaps.

Réglages de l’intégration CloudImage :

  • Clé CloudImage API  : si vous souhaitez utiliser CloudImage pour servir vos images, saisissez ici la clé del’API.

Réglages des permaliens

Dans les réglages de Permaliens, vous pouvez modifier le préfixe des pages de votre calendrier. Vous ne pouvez pas laisser ce champ vide, car vos URL entreront en conflit avec les pages et les articles par défaut de WordPress.

Réglages de personnalisation

Dans l’outil de personnalisation, un nouveau panneu est disponible pour accueillir divers réglages d’affichage. Pour l’instant, seul un réglage de la couleur principale est disponible.

Widget de filtre et codes courts

Pour permettre aux internautes de trouver facilement des évènements pertinents, l’extension fournit également un widget de filtre pratique. Placez le widget dans votre colonne latérale ou dans toute zone dédiée aux widgets, choisissez un filtre puis modifiez les réglages supplémentaires dans l’écran des widgets.

Pour intégrer les filtres directement dans votre contenu plutôt que dans les zones de widgets, l’extension fournit également des codes courts.

Chaque code court listé ici (excepté pour [openagenda] correspond à une option de filtre dans le widget.

De plus, les codes courts et les filtres de widgets ont les mêmes paramètres, et chaque attribut de code court correspond à un paramètre de filtre de widget.

[openagenda]

Affiche le calendrier. Vous n’avez pas besoin d’utiliser ce code court explicitement, car il est automatiquement injecté dans le contenu de vos articles « calendriers ».

Cependant, si vous avez besoin d’insérer du contenu statique après votre liste d’évènements, vous pouvez le faire en insérant ce code court puis votre contenu statique après.

[openagenda_filter_active]

Affiche les filtres actifs. Aucun paramètre.

[openagenda_filter_choice]

Affiche une liste de choix, selon le champ choisi. Les paramètres suivants sont acceptés :

  • field : le slug du champ choisi que vous souhaitez afficher (par exemple : « villes », « mots-clés », « départements », « favoris », etc.).
  • additional_field : tout champ personnalis que vous avez configuré dans votre administration OpenAgenda. Fonctionne uniquement quand « Champ additionnel » est le champ choisi.
  • page_size : nombre d’options à afficher avant le bouton « Plus d’options ».

Vous pouvez trouver la liste des champs additionnels disponibles dans la section Formulaires des réglages de votre agenda sur openagenda.com (ex : https://openagenda.com/[your-agenda]/admin/schema)

[openagenda_filter_calendar]

Affiche un calendrier. Aucun paramètre.

[openagenda_filter_map]

Affiche une carte interactive pour localiser et rechercher les évènements. Les paramètres suivants sont acceptés :

  • map_tiles_link : Map tiles link to use. Defaults to https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
  • map_auto : Whether to automatically update map on scroll.

[openagenda_filter_preview]

Affiche les évènements suivants. Les paramètres suivants sont acceptés :

  • uid : UID of the calendar you wish to preview.
  • size : nombre d’évènements à afficher.
  • filters  : chaîne de requête représentant les filtres à appliquer à la requête.

[openagenda_filter_relative]

Allows to filters past or upcoming events. It takes no parameters.

[openagenda_filter_search]

Displays a search field. It takes the following parameters :

  • placeholder : text field placeholder.

Personnalisation

Templates for the list of events and individual events can be customized in your theme.

Just create a folder named openagenda/ in your theme, then copy and paste the template you wish to override located in the plugin’s templates/ folder.

The plugin provide convenient template tags for you to display event data in the inc/template-tags.php file. Feel free to define your own in your theme.

The plugin also provides many hooks to allow you to customize the html output or other various data. The hooks documentation is in writing for now !

Usage of third party services and copyright information

This plugin displays data hosted and provided by https://openagenda.com. By using this plugin, you accept and agree with OpenAgenda’s terms and conditions and privacy policy. Please make sure to read them before using this plugin. Also, using this plugin does NOT require an account at https://openagenda.com, though it is recommended to have one.

By default, maps displayed by this plugin use data from https://openstreetmap.org/ and uses the leaflet JS library. By using this plugin, you accept and agree with OpenStreeMap’s terms of use, acceptable use policy and privacy policy

L’extension propose l’intégration facultative de CloudImage. L’intégration requiert de créer un compte sur https://cloudimage.io et d’accepter et signer leurs conditions d’utilisations.

Les icônes utilisées dans l’interface proviennent de Genericons, sous licence GPL 2.0.

Captures d’écran

  • A new Calendars menu entry is created, allowing you to manage your calendars and settings.
  • The simple settings page allow you to enter in your API key and tweak various settings.
  • Just create a new calendar post, and provide the Openagenda calendar UID in the Calendar settings metabox.
  • Find your Calendar UID on the openagenda.com site, just under the sidebar.
  • You can use convenient filter widgets to add filtering functionnality to your calendars.
  • In the Customizer, a new panel is available to house various display settings.
  • Enjoy !

FAQ

Where is the settings page ?

The settings page is located under the Calendar main menu entry, just alongside your content. It is not polluting the main Réglages menu entry, or adding any top-level entry.

Where can I find API key and calendar UIDs ?

All data related to your personal account and API keys can be found on your profile page at https://openagenda.com/settings.

All data related to calendars can be found on the calendar itself on https://openagenda.com. Just look for the calendar you wish to display, and find the UID in the sidebar, under the filter widgets.

Can I display any calendar ? Even if it’s not mine ?

Oui ! Aucun problème ! Créez juste un nouvel article Calendrier, fournissez son UID et cela fonctionnera.

Où puis-je trouver la documentation de développement ?

You can find more thorough documentation on https://developers.openagenda.com/extension-wordpress/ (in French) or on the Github repository at https://github.com/OpenAgenda/wordpress

Avis

13 avril 2021
J'utilise régulièrement OpenAgenda pour afficher des Agendas sur les sites de mes clients. J'utilise généralement le systeme des Iframes OpenAgenda mais cela a ses limites. Avec ce plugin trés intuitif et facilement personnalisable, je peux créer des intégrations bien plus poussées très simplement en créant mes propres templates. Parfait pour un intégrateur Wordpress !
10 mars 2021
I find this plugin quite neat indeed. Any wordpress user can easily add dedicated agenda pages powered by the OpenAgenda platform. Little disclosure: I work for OpenAgenda.
Lire les 2 avis

Contributeurs/contributrices & développeurs/développeuses

« Openagenda » est un logiciel libre. Les personnes suivantes ont contribué à cette extension.

Contributeurs

“Openagenda” a été traduit dans 1 locale. Remerciez l’équipe de traduction pour ses contributions.

Traduisez « Openagenda » dans votre langue.

Le développement vous intéresse ?

Parcourir le code, consulter le SVN dépôt, ou s’inscrire au journal de développement par RSS.

Journal

2.4.0

  • Feature : Added setting to exclude past events.
  • Feature : Added pre-filters setting to Preview widget

2.3.0

  • Added support for default filters.

2.2.1

  • Fixed : Wrong current month displayed in timings.

2.2.0

  • Feature : Added support for Districts in filters.

2.1.5

  • Fixed : Fixed tag on single event when using WordPress SEO.
  • Fixed : Fixed image properties.

2.1.4

  • Fixed : Bug with ajax requests when size argument is 0.

2.1.3

  • Added support for multilingual additional fields

2.1.2

  • Minor bug fix

2.1.1

  • Fixed slug sanitization

2.1.0

  • Added Favorite feature.
  • Fixed various handlers for changed reponse keys.
  • Modified [openagenda_filter_tags] shortcode to use [openagenda_filter_choice] instead

2.0.0

  • Major API calls refactor: fetches events using API calls instead of JSON export
  • Major filter widget refactor: uses new React filters

1.1.1

  • Fixed canonical url in tag
  • Added compatibility with Yoast SEO meta tags

1.1.0

  • Added « Integrations » settings tab
  • Added integration with CloudImage
  • Preview widget templates are overridable in the child theme.
  • Bug fix : Passed events can be displayed on single event view.

1.0.1

  • Bug fix on openagenda_get_field() function, when called with ‘image’ and ‘thumbnail’ parameter.

1.0.0

  • Fixed location template.
  • Added event count and active filters on top of the list view.
  • Added online access link display for online events.
  • Fix for viewing single passed event.

0.2

  • Added icons.
  • Minor CSS fixes

0.1

  • Initial release