Carnet Plugins

Albums v2 DEV

Albums v2 DEV

M.A.J. du 14/07/2014

Malgré le titre de cette page, la branche 2.x est considérée comme stable, et cette page lui fait office de documentation.
Il n’y aura pas d’ajout sur cette branche, seul des corrections de bugs lorsqu’ils seront signalés (cf. plus bas).

L’effort de guerre est reporté sur la branche 3.0, publiée sous peu, et qui va être accompagnée d’un article en bonne et dûe forme.
Pour reporter les bugs de la branche 2, n’hésitez pas à utiliser le forum du nouvel article (en précisant bien quelle version est concernée), qui sera consultable à cette adresse : http://contrib.spip.net/Albums-3.
Vous pouvez également utiliser la liste de discussion spip-zone, ou au pire spip-users.

Téléchargement : http://files.spip.org/spip-zone/alb...

Des albums ?

Les albums sont des objets éditoriaux que l’ont peut lier à n’importe quel autre objet, et auxquels on peut lier des documents.
Concrètement, ils servent à accueillir vos documents, que vous pouvez sélectionner, grouper et arranger comme bon vous semble. On peut ensuite les insérer au fil du texte, dans vos articles ou tout autre objet, ou les appeler dans vos squelettes indépendamment du contexte.

Un portfolio… des albums !

Mise en route rapide

Une fois le plugin téléchargé et installé, rendez-vous dans la page de configuration pour définir sur quels objets associer les albums. Veillez également à vérifier que l’ajout de documents sur les albums est activé (page ’contenu du site’), ce qui doit normalement être le cas par défaut.

On peut créer un nouvel album soit par la barre d’ajout rapide, ou en se rendant directement sur un objet sur lequel l’ajout d’album est activé.
On peut y créer un nouvel album (sans quitter la page), ou bien choisir un album existant.

ajouter un album sur un objet
Ajouter un album : onglets créer et associer
On peut créer un nouvel album ou en associer un existant sans quitter la page de l’objet

Dans le cas d’une création, une fois l’album enregistré, il ne reste plus qu’à lui ajouter des documents.

Après création d’un album, ajouter des documents
Un album qui vient d’être créé dans la page d’un objet est ’déplié, il reste à ajouter des documents.

Les albums sont ’dépliables’, un clic sur le bloc permet de voir et éditer les documents.

Un bloc dépliable
Un clic sur le bloc permet de le déplier et de gérer ses documents

Enfin, on peut inclure n’importe quel album (qu’il soit déjà lié à l’objet ou non) dans le texte au moyen de la balise

ou

Album inséré dans le texte
Même album inséré 2 fois dans le texte, en mode ’aperçu’ et en mode ’liste’

Il y a pour l’instant 2 type de vues : vue en mode ’aperçu’ ou en mode ’liste’.

Des modèles

Chaque plugin proposant une interaction avec les documents peut proposer son propre modèle album. Le plugin nivoslider dispose d’une ébauche de modèle <albumXX|nivoslider>.

Par la suite, on peut également imaginer des playlists pour fichiers audio ou vidéos : <albumXX|dewplayer>.

Des boucles

On dispose d’une boucle...
<BOUCLE_albums(ALBUMS){id_album=xx}{orphelin?}{...}>
...et des balises suivantes :
#TITRE, #DESCRIPTIF, #ID_ALBUM

La boucle ALBUMS accepte un critère {orphelin} qui sélectionne les albums sans lien vers un autre objet éditorial.

  1. #SET{selection,#ARRAY}
  2. #SET{media, file|audio}
  3. <BOUCLE_id_contenus(spip_documents_liens spip_documents albums){media == image|audio}{objet = album}{tout}>
  4. [(#GET{selection}|find{#ID_OBJET}|non) #SET{selection,#GET{selection}|push{#ID_OBJET}} ]
  5. </BOUCLE_id_contenus>

Télécharger

Questions / Expression des besoins

Valéry (14/05/2013) : ne manque-t-il pas la notion de tri ? Le plugin Mosaïque la propose pour les portfoglio d’article mais uniquement en glisser / déposer (pas accessible). Une interface à base de flèches (monter / descendre) n’est-elle pas envisageable ?

François (18/08/2013) : <albumX|par num titre> permet de trier, mais si on veut que le doc D soit dans l’album X et dans l’album Y classé par num titre, pas d’autres solutions que de dupliquer le doc D ! en D1 et D2 avec num titre différent pour X et Y, ce qui est tout à fait gérable ! ;-)

François (02/12/2013) : pourrait-on lier un album à un album ? pour un sous album en quelque sorte.

Inconnu : J’arrive à éditer ce texte ! est- ce normal ?

Valéry (31/03/2014) : oui cette page est un wiki.

François (07/01 -> 12/07/2014) (dommage que cette page soit pas simplement publiée sur contrib, c’est déjà suffisant comme doc !)
Pourquoi varchar(255) et non pas text pour le type du champ titre de la table _albums ? (cf mon message sur le plugin Fulltext. J’ai modifié, "titre" => "text DEFAULT ’’ NOT NULL", /*"(au lieu de varchar(255) DEFAULT ’’ NOT NULL",*/ avec pour seul effet de rendre efficient la recherche dans l’espace privé sur les albums.
De même pour "statut", pourquoi 255 ? "varchar(10) DEFAULT ’0’ NOT NULL", au lieu de "varchar(255) DEFAULT ’’ NOT NULL", ?

Valéry (31/03/2014) : l’insertion de l’album dans l’article de désactive pas l’affichage des documents dans le portfoglio (critère {vu = non} ne semble pas pris en compte)

Éric (28/05/2014 : Pourrait-on ajouter une légende, titre, copyright et proposer des hyperliens, bien pratique par exemple pour des logos en bas d’article.
François (12/07/2014) : oui on peut, il suffit de modifier ou créer nouveau modèle. (à moins que ce que vous vouliez soit de créer de nouveaux champs, en plus de "titre" et"descriptif", mais là perso je ne verrai pas l’intérêt)

Tcharlss (14/07/2014)
Quel dommage que les forums ne soient pas activés pour les articles wiki, du coup je n’avais pas vu les questions, n’étant pas notifié des mise à jour de cet article.
Pour information, la version 3.0 va être dispo dans pas trop longtemps, et un « vrai » article sera publié en même temps.
Quelques réponses :
@François :
-  Pour le champ titre, je n’étais pas au courant qu’un varchar pouvait poser problème avec la recherche sur fulltext. Pas de problème pour le passer en "text", du coup. Quant au varchar(255) du statut, une erreur de jeunesse ! Merci d’avoir relevé.
-  Techniquement, on pourrait lier un album à un album, mais c’est volontairement désactivé car ça apporterait beaucoup de confusion. Si c’est vraiment nécessaire, tu peux surcharger le squelette du formulaire « configurer_album » et retirer « spip_albums » du paramètre « exclus », L35.
@Valéry :
-  Le tri manuel des documents d’un album, ce serait pas mal et c’est plus ou moins prévu. C’est une demande qui revient régulièrement pour SPIP d’une façon générale, d’un point de vue technique, dès qu’un consensus aura été trouvé, on embrayera le pas.
-  Je ne saisis pas trop la question du 31/03, les albums n’ont pas d’effet sur les documents du portfolio.
@ Eric : Pour des champs supplémentaires, il faut utiliser les champs extras.