11 Nouvelle feature : ajouter des services
paidge edited this page 2 weeks ago

Nouvelle feature : ajouter des services

La branche dev/ajouter_services_auto permet d'activer des services TarteAuCitron directement depuis le back-office. Cette page décrit le fonctionnement retenu.

Phase de développement et de mise à jour du plugin

Lors de la mise à jour de la librairie TarteAuCitron au sein du plugin, le développeur doit lancer le script ?action=tarteaucitron_referencer_services qui va mettre à jour le fichier json/services.json ainsi que les modèles situés dans /modeles.

Exemple de contenu du fichier json/services.json :

{
    "sharpspring":{
        "hasModele": false,
        "params": ["ptac_ID","ptac_ACCOUNT"],
        "type": "analytic",
        "JS": "tarteaucitron.user.ssId = 'ptac_ID';\ntarteaucitron.user.ssAccount = 'ptac_ACCOUNT';\n(tarteaucitron.job = tarteaucitron.job || []).push('sharpspring');"
    },
    "helloasso":{
        "hasModele": true,
        "type": "api",
        "params_modele": ["url","width","height"],
        "JS": "(tarteaucitron.job = tarteaucitron.job || []).push('helloasso');"
    },
    "disqus":{
        "hasModele": true,
        "type": "comment",
        "params": ["ptac_disqus_shortname"],
        "JS": "tarteaucitron.user.disqusShortname = 'ptac_disqus_shortname';\n(tarteaucitron.job = tarteaucitron.job || []).push('disqus');"
}

Installation et paramétrage du plugin

Installation

Le plugin s'installe comme n'importe quel plugin SPIP. Il dépend du plugin SAISIES.

Paramétrage du plugin

Le plugin propose différents paramètres liés à la librairie TarteAuCitron via la page ecrire/?exec=configurer_affichage

Ajouter des services

  1. Le webmestre peut ajouter des services dans une des pages de configuration du plugin ecrire/?exec=configurer_services Pour cela, un input de recherche permet de retrouver le service de son choix (avec les noms utilisés dans TarteAuCitron) et de l'activer.

  1. Une fois le service activé, il est possible qu'il nécessite certains paramètres (APIkey, URLpage, CompteID, etc.). Pour cela, il suffit de le vérifier dans la liste des services activés :

  1. Si le service activé nécessite l'insertion d'un modèle, le plugin préviendra le webmestre :

Insérer du contenu dans des articles

Certains services (notamment les services de type video), permettent d'intégrer du contenu dans les articles via les modèles. Le plugin propose alors une nouvelle entrée dans le porte-plume :

Si vous voulez ajouter une entrée dans ce sous-menu pour un des modèles, il suffit alors de créer une image carrée de 17px de côté dans squelettes/icones_barre/{modele}.png avec {modele}= nom du fichier .html sans le prefixe tac_

Traiter du contenu ancien

Le plugin possède un script ?action=tarteaucitron_nettoyer_iframes issu du plugin oEmbed et à adapter selon vos besoins. Celui-ci permet de remplacer les iframes des anciens articles par les modèles. Il peut être lancé directemen via l'onglet technique du plugin (ecrire/?exec=configurer_technique):