Carnet Wiki

Proposition de fonctionnement alternatif pour l’insertion des documents

Version 5 — September 2010 Joseph

Le fonctionnement des modèles pour l’insertion des documents soulève régulièrement des questions, notamment parce <doc13>, <img13> ou encore <emb13> ne produisent pas le même résultat et que ce résultat, pour les images, dépend du fait d’être dans le portfolio ou non.
.
Comme l’écrit Romy,

<blockquote class="spip">

Qui sait expliquer clairement la différence entre les « images » et les « documents » de SPIP ? Quand faut-il utiliser le raccourci d’insertion <img314>, celui <doc314> ou encore <emb314> ? et quelles sont précisément leurs différences ? Pourquoi est-ce si difficile à retenir ?

</blockquote>

(Source : http://romy.tetue.net/mais-ou-est-p...)

Sur la liste SPIP-Zone, Cédric expliquait :

<blockquote class="spip">

Le sujet est un serpent de mer, contraint par la compatibilté ascendante. Pour le moment on a fait le choix de ne pas la casser, ce qui a des limites.

</blockquote>

(Source : http://permalink.gmane.org/gmane.co...)

Avant de poursuivre la discussion, on pourra lire la documentation officielle à cette adresse http://www.spip.net/fr_article3715.html.

Objectif

La présente proposition vise à définir un comportement unifié des différents modèles d’incrustation. Ce comportement unifié pourra ensuite être implémenté dans un premier temps dans un plugin dédié avant d’envisager son intégration éventuelle au core.

Ce plugin fournira également une aide en ligne actualisée ainsi qu’une aide à l’insertion des modèles (au travers du plugin inserer_modeles en cours de développement).

Les modèles existants (doc, emb, img, image, audio, video, text, application) ne seront pas modifiés afin d’assurer la rétrocompatibilité.

Côté utilisateur

Proposition

Toutes les insertions se font au travers d’un unique modèle <media>&lt;/code> avec plusieurs variantes . >. Volontairement, afin de distinguer le nouveau système du système actuel, on n'a pas repris <code><doc>.

Les deux usages principaux sont <code></code code><mediaXX|ico></code > et <mediaXX|emb>.

Un modèle par type de fichier ?Afficher le logo du document

<mediaXX>&lt;/code <code><mediaXX|ico>&lt;/code >, sans paramètre additionnel, quelque le soit le type et le mode du document, affichera systématiquement le  logo  la  vignette  du document (vignette personnalisée si existante,  sinon miniature  de  l'image  si  l'option  miniature  automatique  est  activée ,  sinon  icône) avec un lien pointant sur le document et la légende (titre, descriptif et crédits[[disponible avec la médiathèque]]).


Si l'on souhaite forcer l'affichage de l'icône, même en présence d'une vignette, on pourra utiliser la variante <code><mediaXX|ico>

.

De même, si on souhaite, pour les images, forcer l’affichage d’une vignette, même si on n’a pas activé les vignettes automatiques, on pourra utiliser la variante <mediaXX|vignette>.

On pourra préciser l’alignement de la manière usuelle Si < code></code > est appelé sans paramètre , cela sera équivalent à <code><mediaXX|right code><mediaXX|ico></code >.

Incruster le document

On aura recours à un raccourci unique <mediaXX|emb>, le modèle se chargeant d’incruster correctement le document en fonction de son type (voir aspects techniques).

Lorsqu’on incruste le document avec <mediaXX|emb> sans paramètre additionnel, la légende n’est pas affichée. On peut demander l’affichage de la légende avec <mediaXX|emb|legende>.

Il est également possible de passer un titre et un descriptif au modèle pour la légende qui viendront remplacer les valeurs par défaut du document avec <mediaXX|titre=mon titre|descriptif=mon descriptif>. Ceci est particulièrement utile dans le cas d’un site multilingue pour traduire les titres et descriptif.

Les paramètres hauteur et largeur pourront être utilisés quelque soit le type de document incrusté. On pourra utiliser de manière alternative |width= et |height=.

Un paramètre |taille= acceptant trois valeurs petit, moyen et grand peut être utilisé de manière alternative à hauteur et largeur pour définir trois tailles standards (paramétrables dans l’interface privée, par défaut 100 px, 250px, 500px [1]).

Pour les images, le paramètre lien est maintenu. Il permet de spécifier un lien sur lequel pointe l’image. Avec <mediaXX|emb|lien>, l’image pointera sur elle-même (utile quand on incruste une image en réduisant sa taille pour voir l’image dans sa taille réelle). Avec <mediaXX|emb|lien=http://monlien.net> ou <mediaXX|emb|lien=rub34> on peut spécifier un autre lien.

L’alignement (left, right ou center) sera toujours précisé de la même manière. Par exemple : <mediaXX|emb|left>

Côté technique

Une variante par groupe MIME

Reprenant le fonctionnement actuel de <emb>, le modèle media_emb.html sous-traitera le travail à plusieurs modèles en fonction du type MIME du document : media_image.html, media_audio.html, media_video.html, media_text.html et media_application.html.

Dès lors, il sera possible d’utiliser également des variantes appels de la forme <mediaXX|image>, <mediaXX|audio>, <mediaXX|video>, <mediaXX|text> et <mediaXX|application>.

<mediaXX|emb> et <mediaXX|image> produiront exactement le même résultat [2]

Permettre une variante par extension

Au final, un seul raccourci <media> sera nécessaire avec deux appels principaux : <mediaXX|ico> et <mediaXX|emb>.

Interaction avec le Lecteur Multimédia

Si le lecteur multimédia est activé, il serait bon que <mediaXX|emb> fonctionne directement avec ce dernier sans avoir besoin de préciser |player. On peut donc envisager que le Lecteur Multimédia puisse surcharger directement modeles/media_audio.html et modeles/media_video.html.

Il est possible de définir une variante par extension sous la forme modeles/media_groupeMIME_extension.html. Doit-envisager la possibilité d’avoir la possibilité de faire un modèle d’inclusion spécifique par type de fichier ? Lors de l’incrustation d’un fichier , on vérifiera Cela signifierait que l’on regarde d’abord l’existence d’un modèle spécifique pour cette extension modeles/media_groupeMIME_extension.html, qu’on utilise s’il existe , et sinon on utilisera utilise le modèle générique du groupe MIME modeles/media_groupeMIME.html.

Cela permettrait de faire évoluer le système assez simplement en surchargeant le fonctionnement que pour certaines extensions (le lecture multimedia ne gère que certains types de fichiers par exemple).

Pour les images, on pourrait ainsi avoir un modèle générique modeles/media_image.html et un modèle spécifique pour le SVG : modeles/media_image_svg.html.

Ainsi, avec le lecteur multimedia, pour la prise en charge des mp3, le plugin pourrait proposer un modèle media_audio_mp3.html qui appelle le player fourni par le plugin. Dans mon article, je mets juste <media123|emb> qui saura tout seul trouver le bon modèle. Maintenant, je désactive le lecteur multimedia, <media123|emb> sera toujours pris en charge par le modèle générique modeles/media_audio.html qui incrustera le MP3 dans une balise <object>. Ce qui est mieux qu’une simple icone dans le cas présent. [3]