Carnet Wiki

Proposition de fonctionnement alternatif pour l’insertion des documents

Version 1 — 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 de la présente proposition

La présente proposition vise à définir un comportement unifié des différents modèles d’incrustation en supprimant la contrainte de rétrocompatibilité. Ce comportement unifié pourra ensuite être implémenté dans un plugin dédié annonçant clairement la perte de rétrocompatibilité. Ainsi, chacun sera libre ou non d’adopter ce nouveau comportement des modèles en toute connaissance de cause.

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).

Proposition

<doc123>, sans paramètre additionnel, quelque le soit le type et le mode du document, affichera systématiquement la vignette du document (vignette personnalisée si existante sinon icône) avec un lien pointant sur le document et la légende (titre, descriptif et crédits [1]).

<doc123|embed> sera équivalent à <emb123>.

L’incrustation des documents les modèles dédiés (<image>, <audio>, <video>, <text> et <application>) sera également possible.

Si le document 123 est une vidéo, alors <doc123|embed>, <emb123> et <video123> seront équivalents.

Par souci de compatibilité, <img> sera maintenu mais équivalent à <image>. Autrement dit, si 45 est une image, <img45>, <image45>, <emb45> et <doc45|embed> seront équivalents.

Pour compatibilité avec le lecteur multimedia, <doc123|player> sera équivalent à <doc123|emb> ou <emb123> ou . Ce sont les modèles <video> et audio qui se chargeront d’intégrer ou non le player selon le type de fichier.

Quelque soit l’appel utilisé, on pourra systématiquement indiquer |legende=non si on ne souhaite pas afficher la légende (qui sera toujours affichée par défaut) ou bien |legende=mon texte si on souhaite afficher une légende personnalisée.

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 [2]).

Au final, il est possible d’utiliser uniquement le raccourci <doc> si on le souhaite, ou bien d’utiliser les autres raccourcis, sachant que le fonctionnement reste identique quelque soit le raccourci utilisé.