Plugin Chants

Langage et développement
XML, PHP
Bases de données
Frameworks
Environnement de développement
Industrialisation
SVN
Poste(s)
Statut

| par Teddy Payet

La documentation officielle de ce plugin est publié sur le site SPIP-Contrib.net. Pour toutes informations ou SAD, merci d’utiliser le forum sur la documentation officielle.

Présentation

Le plugin Chants a été créé sur la même structure de chants du logiciel open source, OpenSong. Il permet de référencer des chants pour une présentation en live par exemple. Ou tout simplement les référencer sur votre site internet.

Installation

Il s’installe comme tous les plugins http://www.spip.net/fr_article3396.html
Le plugin nécessite :
- Saisies ;
- Zippeur.

Il utilise aussi Zpip et Compositions. Mais ces derniers ne sont pas obligatoires pour la bonne utilisation de Chants.

Les balises

Voici la liste des balises offertes par ce plugin :
- #TITRE
- #ALIAS : il arrive parfois qu’on connaisse un chant sous un autre nom, un alias.
- #COPYRIGHT
- #ID_CHANT
- #ID_RUBRIQUE
- #ID_SECTEUR
- #DATE_ANNEE : année de sortie du chant ;
- #DATE : date de publication du chant ;
- #NUMERO : le numéro du chant ;
- #PAROLES : les paroles du chant ;
- #PRESENTATION : l’ordre des couplets du chant. Exemple : [V1] [V2] [C] [V1] [R] ;
- #LIGNE_PRINCIPALE
- #CCLI : le numéro du chant au répertoire de CCLI
- #CAPO : un capo (ou capodastre) est un chiffre de 1 à 5 déterminant la position du capo sur le manche de la guitare ;
- #TONALITE
- #TEMPO
- #SIGNATURE
- #STATUT : en cours de rédaction, proposé, publié, refusé, à la poubelle ;
- #LANG
- #ID_TRAD

Les objets liés

Vous pouvez ajouter des mots-clés à un chant mais aussi associer un auteur. L’auteur associé au chant sera ajouté en tant qu’authors lors de l’exportation du fichier xml (cf. ci-dessous).
Si nécessaire, vous pouvez joindre un logo au chant (facultatif).

Les squelettes disponibles

Le plugin fournit un squelette par défaut pour le public. Il affichera toutes les balises du chant.

Intégration rapide sur votre site

Si vous utilisez le plugin Z et Compositions, il existe une composition pour une rubrique dédiée aux chants. Il vous suffit de sélectionner cette composition pour la rubrique désirée.

Exporter en xml

Vous pouvez exporter chaque chant au format xml compatible OpenSong depuis l’espace privé, sur la page du chant.
Mais vous pouvez l’intégrer depuis les pages publiques grâce à cet appel, dans une boucle CHANTS :

[(#SET{filename, [(#CCLI|replace{' ',''})_][(#TITRE|textebrut|replace{\W})]})]
[(#URL_PAGE{chant_export.xml}|parametre_url{'id_chant',#ID_CHANT}|parametre_url{'filename',#GET{filename}})]

Le paramètre filename : c’est le nom du fichier qui sera enregistré sur votre bureau. Si vous ne renseignez pas ce paramètre, le nom par défaut sera "chant_export" et vous donnera de ce fait un fichier chant_export.xml.

Les modèles

Vous pouvez exporter une rubrique contenant les fichiers xml compatible OpenSong.
Pour cela, utilisez l’appel au modèle suivant dans une boucle renseignant l’identifiant de la rubrique :

[(#MODELE{repertoire_zip}{id_rubrique})]

Ce modèle utilise le plugin Zippeur cité en début d’article. De ce fait, vous aurez un fichier zip sous la forme "rubrique_XX.zip" où XX est le numéro de la rubrique.
Le fichier sera enregistré dans un sous-répertoire de "local/". Il sera recréé si vous mettez à jour un chant dans ladite rubrique.
Ce fichier, décompressé, pourra être placé dans votre répertoire "Songs" du logiciel OpenSong (se référer à la documentation de ce logiciel pour plus d’informations).