Les raccourcis typographiques en standard avec SPIP

Documentation sur les raccourcis typographiques de SPIP, ou la forme est le sens.

Un préalable important : la mise en page d’un texte est au service du sens de celui-ci, pas du goût personnel de celui qui se trouve devant l’écran! Or, les raccourcis typographiques de SPIP portent en eux-mêmes du sens. Il est important d’avoir une correspondance entre le sens typographique et le sens du texte. Par exemple, un titre du point de vu du texte doit aussi l’être du point de vue typographique.

N’oubliez pas non plus que votre site sera lu par des visiteurs pouvant être dans des résolutions d’écran différentes de la vôtre et qu’une «belle» mise en page chez vous pourrait être complètement différente pour le visiteur.

Le texte préexiste à la mise en page

C’est peut-être une évidence, mais pour mettre en page un texte, il faut que le texte existe.

Dans le cas de SPIP, ça veut dire qu’il vaut mieux (au moins dans un premier temps):

  • disposer de tout le texte sans aucun raccourcis typographique,
  • sauter une ligne à chaque changement d’idée (ce qui donne un changement de paragraphe, voire un titre),
  • faire un retour à la ligne avant chaque élément d’une énumération.

Ce n’est qu’ensuite que les raccourcis typographiques de SPIP pourront être appliqués avec discernement.

Distinction entre paragraphes et caractères

Certains attributs typographiques ne peuvent s’appliquer qu’à des paragraphes entiers, d’autres doivent être appliqués à des caractères dans le même paragraphe.

Dans la Barre Typographique de SPIP, les attributs de caractères forment le premier groupe sur la gauche, les attributs typographiques de paragraphes le deuxième.

Paragraphes

Un paragraphe dans SPIP est précédé d’une ligne vide et suivi d’une ligne vide [1].

Une règle générale est de ne mettre qu’un attribut de paragraphe par paragraphe.

Si deux paragraphes de suite ont le même attribut, il faut appliquer deux fois l’attribut, une fois pour chaque paragraphe.

Les attributs de paragraphe ne sont pas disponibles dans les champs de SPIP n’ayant qu’une ligne.

Les attributs de paragraphe sont :

  • les titres {{{Paragraphe du titre}}}.

Certains attributs sont un peu spéciaux :

  • Poésie <poesie>Le texte de la poésie, sur plusieurs lignes, les retour à la ligne simple étant pris en compte</poesie>
Le geai gélatineux gégnait dans le jasmin
Voici mes infins le plus beau vers de la langue française.
  • Cadre <cadre>Texte qui apparaitra dans une zone de formulaire facilitant le copier/coller [2]</cadre>
Ceci est du texte dans un cadre.
      les espaces en début de ligne comptent !
Les retour à la ligne simples aussi !
  • Citation <quote>Texte d’une citation</quote>

C’est en forgeant que l’on devient forgeron.

Caractères

Les attributs de caractères doivent être ouverts et fermés à l’intérieur du même paragraphe (pas question de débuter le gras sur un premier paragraphe et de le terminer sur un deuxième).

Ils peuvent être utilisés dans tous les champs de SPIP.

Mise en forme:

  • gras : {{texte en gras}}; à utiliser pour un élément que l’on souhaite appuyer (sera prononcé plus fort dans un lecteur vocal) : texte en gras
  • italique : {italique}; à utiliser pour une élément sur lequel on veut insister (sera prononcé avec emphase) : italique
  • code : <code>du code (raccourcis typographiques, html...)</code> que l’on ne souhaite pas que SPIP interprète
  • depuis SPIP 4.2, on peut aussi utiliser les backticks (`) pour insérer du code.
  • biffé : <del>texte biffé</del> : pour indiquer qu’on avait pensé à un autre mot et que l’on a changé d’avis : SPIP, c’est bien fantastique!

Comportement spécifique:

  • Lien : [texte du lien->http://www.spip.net/] : lien : texte du lien
    À noter qu’il est possible de faire des liens à l’intérieur du site SPIP à l’aide des numéros des éléments et de leur type (se reporter à l’aide en ligne fournie par SPIP).
  • Lien avec bulle d’aide : [texte du lien|Le site officiel de SPIP->http://www.spip.net/] : texte du lien
  • Lien avec langue des destination (non visible sur Internet Explorer) : [texte du lien|{fr}->http://www.spip.net/] : texte du lien
  • Lien avec bulle d’aide et langue des destination : [texte du lien|Le site officiel de SPIP{fr}->http://www.spip.net/] : texte du lien
  • Lien vers un email [Contacter max->max@domaine.com] Contacter max
  • Lien vers un email avec un sujet pré-rempli [Contacter Max pour le spam->mailto:max@domaine.com?subject=Cadeau pour les robots spammeurs]Contacter Max pour le spam
  • Ancre et retour à l’ancre : [definition_ancre<-] et [retour à l'ancre->#definition_ancre] : retour à l’ancre
  • Définition dans Wikipedia : [?GPL] : appelle l’encyclopédie libre Wikipedia pour obtenir la définition du mot [3] : GPL
    Avec bulle d’aide : [?GPL|Définition sur Wikipédia] : GPL
  • note de bas de page : texte[[note de bas de page]] : crée une note de bas de page avec le texte entre les doubles crochets [4]
  • expression mathématique <math>expression TeX</math>: affichage une formule mathématique selon la syntaxe LaTeX: $\int\limits_1^2 {xdx}$

Listes

Les listes sont à utiliser pour tout ce qui à le sens d’une énumération.

Attention: il faut entourer un bloc de listes à puces d’une ligne vide avant et après.

Listes à puces

-* première ligne
-* deuxième ligne
-** une sous liste à puce
-* de retour dans le niveau initial

Donnera :

  • première ligne
  • deuxième ligne
    • une sous liste à puce
  • de retour dans le niveau initial

Listes numérotées

-# première ligne
-# deuxième ligne
-## une sous liste à puce
-# de retour dans le niveau initial

Donnera :

  1. première ligne
  2. deuxième ligne
    1. une sous liste numérotée
  3. de retour dans le niveau initial

Tableaux

Pour être complètement accessible, un tableau dans SPIP doit avoir un titre et une description.

Ainsi :

||Produits bio et prix|Ce tableau sert d'exemple de mise en forme spip||
| {{Produit}} | {{Prix €}} |
| Beurre Bio | 5€ |
| Lait Bio | 3€ |
| Choux Bio | 4€ |

Donnera :

Produits bio et prix
Ce tableau sert d’exemple de mise en forme spip
Produit Prix €
Beurre Bio 5€
Lait Bio 3€
Choux Bio 4€

Notez les doubles || sur la première ligne du tableau !

Attention: les pièges classiques avec les tableaux sont :

  • ne pas avoir le même nombre de | sur une ligne
  • avoir un espace après le dernier | de la ligne (un moyen simple de vérifier : la touche fin du clavier amène à la fin de la ligne)

Tableaux avec fusion de cellules

||Tableau avec fusion|Ce tableau sert d'exemple de mise en forme spip||
| {{Colonne 1}} | {{Colonne 2}} | {{Colonne 3}} |
| ligne 1 | Cellule fusionnée avec la suivante |<|
| ligne 2 | Celulle fusionnée
_ avec celle du dessous | normale |
| ligne 2 |^| normale aussi |

Donnera :

Tableau avec fusion
Ce tableau sert d’exemple de mise en forme spip
Colonne 1 Colonne 2 Colonne 3
ligne 1 Cellule fusionnée avec la suivante
ligne 2 Celulle fusionnée

avec celle du dessous

normale
ligne 2 normale aussi

Principe :

  • |<| fusionne avec la cellule de gauche
  • |^| fusionne avec la cellule au dessus

Images

Pour les images et documents, reportez-vous à l’aide en ligne de SPIP. Seule contrainte pour l’accessibilité (et donc un meilleur référencement) : donnez un titre à toutes vos images décrivant le [sens/signification] de chacune d’elles.

Caractères spéciaux

  • ~ (espace insécable ou espace dur — correspond au &nbsp; du HTML) placé entre deux mots remplace l’espace en ayant l’avantage d’être insécable, c’est-à-dire, qu’il empêchera les deux mots d’être séparés par un retour à la ligne malvenu. S’utilise en particulier entre le prénom et le nom propre.
  • -- : — (tiret cadratin) à utiliser pour les incises dans un texte

Ligne horizontale

----: 4 signes moins en seuls sur une ligne (précédés d’une ligne vide et suivis d’une ligne vide) donneront un trait de séparation horizontal.


Éléments dangereux

Il y a deux éléments dangereux dans SPIP :

  • le retour à la ligne simple : _ (souligné espace) en début de ligne.
    Usage toléré pour donner adresse et numéro de téléphone/fax.
    Usage toléré : dans une liste à puce pour passer à la ligne sans passer à une nouvelle puce (comme ici).
    Usage interdit: pour mettre plus d’espace vertical entre deux éléments de la page.
  • les fausses listes à puce : - (moins espace) en début de ligne
    L’effet visuel peut être intéressant, mais il n’a pas de sens.
    -  Ceci est une fausse liste à puce
  • le HTML pur : il est possible dans SPIP de mettre du code HTML. Le faire est fortement déconseillé :
    • parce que c’est la porte ouverte à toutes les dérives, ne serait-ce que celle de sortir de la charte graphique du site, ou celle de produire un code HTML non valide (voire non interprétable ailleurs que sur Internet Explorer
    • parce que c’est partir du postulat que votre site ne sera visité qu’en tant que site web ; il pourrait très bien être un jour disponible sous forme de fichier PDF...

Exemples de titraille : Titre principal

{{{Exemples de titraille : Titre principal}}}

Placement des images

<doc22364|left>

I love SPIP - Un badge pour manifester sa reconnaissance à SPIP
I love SPIP
Un badge pour manifester sa reconnaissance à SPIP

<doc22364|center>

I love SPIP - Un badge pour manifester sa reconnaissance à SPIP
I love SPIP
Un badge pour manifester sa reconnaissance à SPIP

<doc22364|right>

I love SPIP - Un badge pour manifester sa reconnaissance à SPIP
I love SPIP
Un badge pour manifester sa reconnaissance à SPIP

Documents et images: indiquer une dimension

Il est possible de forcer la taille d’une image

<docXX|hauteur=nn>
<docXX|largeur=nn>

Documents et images: créer un lien

Pour créer un document cliquable (par exemple sur une image)

<docXX|lien=12> Lien vers l'article 12
<docXX|lien=https://monsite.example.com> Lien vers un site externe

Footnotes

[1Sauf les listes à puce et les tableaux

[2Essentiellement utilisé sur spip-contrib pour donner des exemples de code

[3Si le mot n’existe pas, vous pouvez le créer vous-même!

[4Et la note de bas de page est automatiquement numérotée, rendue clicable, pour la consulter, et pour revenir au texte l’ayant appelée

  • Pour vous former à la syntaxe SPIP ou tester une syntaxe, rendez vous sur le site https://syntaxe.spip.net : il propose de voir le rendu et le code HTML généré à partir de votre texte SPIP.
  • Une extension pour FireFox est très utile pour savoir rapidement si vous avez fait une erreur de raccourcis typographique : HTML VALIDATOR (based on Tidy). Dans la version modifiée de SPIP que j’utilise, cette validité est aussi vérifiable dans l’interface d’administration de SPIP, et pas seulement du côté des visiteurs.

Discussion

20 discussions

  • Lena Cousin

    Bonjour,

    J’ai un p’tit soucis avec mes tableaux : ils ne s’affichent pas sur l’espace public !!
    Pourtant j’ai fait tout comme il faut !
    Je soupçonne que ce soit à cause de la version 3.0 que j’ai installé récemment (car ça marchait sur la version précédente!)
    Si ce n’est pas cela, et si vous savez comment résoudre mon problème, je suis preneuse !

    Merci d’avance,
    Lena

    Reply to this message

  • 5

    SPIP ne gère pas l’espace insécable à l’intérieur de l’incise constituée de tirets cadratins ?

    • elle est bien bonne celle là! hahaha! :)))

    • Peut être avec :
      &mdash;&nbsp;ici l'incise&nbsp;&mdash;

      Ou plus proprement en code spip, essayer :
      --~ici l'incise~--

    • Oui on peut faire ça, mais ce n’est plus un automatisme. Va expliquer à un contributeur comment faire la tilde...

    • une pipeline pre_propre devrait faire l’affaire non ?

    • Il n’est pas possible d’automatiser cela, ces tirets pouvant être seul ou plus de deux. De plus, lorsqu’ils sont utilisés comme des parenthèses, le fermant et l’ouvrant ne sont pas distinguables. Il faut donc spécifier les espaces insécables voulus : --~ici l'incise~--. Ceci dit, ce n’est pas très gênant qu’ils n’y soient pas.

    Reply to this message

  • 7

    Je trouve que les termes “éléments dangereux” et “usage interdit” sont un peu forts. Personne ne risque rien à utiliser ces éléments, le site ne va pas planter, et aucune instance officielle ne va vous faire un procès! Je ne sais pas qui peut se targuer d’établir une liste d’usages tolérés ou interdits des raccourcis typographiques?

    Le fait est que les retours à la ligne simples et les fausses listes à puce ne sont tantôt pas conformes à la typographie française, tantôt aux standards du Web, ou à l’usage sémantique de l’html pour baliser un texte.

    Je suis par contre d’accord avec les remarques concernant l’usage de l’html, parce que les exemples donnés sont concrets.

    Je pense que quelques liens vers des textes sur le Web sémantique, l’accessibilité du Web ou le respect des standards seraient plus efficaces pour sensibiliser que de laisser entendre qu’il y a un risque quelconque à utiliser tel raccourci.

    Exemples de lectures intéressantes sur le site OpenWeb.eu.org:
    -  Respecter la sémantique XHTML
    -  Pourquoi les standards du W3C?
    -  Pourquoi l’accessibilité numérique?

    Aurélie

    • D’ailleurs, pourquoi est-ce que ce retour à la ligne est “interdit”?
      Et comment fait-on alors pour revenir à la ligne?

    • Je rappelle le préambule de cet article : ce qui compte, c’est la mise en sens.

      Corollaire, c’est la mise en forme qui est, fort logiquement, interdite.

      Donc, pousser le texte vers le bas ou vers la droite, c’est interdit.

      Et le HTML, c’est dangereux. Je n’ai pas dit que c’était interdit. Mais jusqu’à présent, je n’ai pas encore vu qui que ce soit utiliser du HTML pour mettre du sens (langue, adresse, RDF...), mais uniquement de la présentation (font, center, target=_blank...).

    • Ce n’est pas le retour à la ligne qui est interdit, c’est plus d’un retour à la ligne consécutif.

      Autrement dit, les retours à la ligne pour pousser le texte vers le bas.

    • Je suis d’accord sur le fond qui est d’ailleurs relevé dans l’aide en ligne Spip:

      En typographie classique, le simple retour à la ligne est très rare (limité essentiellement à la poésie). On le confond souvent avec le changement de paragraphe tel qu’il est affiché sur les documents imprimés (sans espacement vertical entre les paragraphes), alors que, par défaut, les butineurs Web insèrent un espacement entre les paragraphes. Beaucoup d’utilisateurs cherchent à reproduire cette caractéristique de l’imprimé (pas d’espacement vertical) en insérant de simples retours à la ligne entre ce qu’ils considèrent être des paragraphes ; cela est un erreur qui risque de nuire à la facilité de maintenance et d’évolution de leur site.(...)

      Le fait est qu’un paragraphe correspond à une unité de pensée, on en crée un nouveau pour montrer qu’on passe à l’idée suivante. Le retour à la ligne simple n’a pas de sens en français, sauf en poésie où il rythme le texte. Il n’est donc ni interdit, ni dangereux de l’utiliser, simplement son utilisation correspond dans la majorité des cas à l’envie de générer un effet visuel qui ne va rien ajouter au sens du texte.

      Les développements actuels du langage html (xhtml) visent à séparer le contenu de la forme, désormais précisée dans les feuilles de styles. Les balises html devraient, pour suivre cette évolution, se limiter à donner des indications sur le sens du texte et non plus servir à “faire joli”.

      Respecter la sémantique des balises, donc encadrer un contenu avec la balise adéquate, permet tout d’abord de structurer le document correctement, indépendamment de la forme qu’il va prendre. Ceci permet aux programmes qui traiteront l’information contenue dans la page, de l’interpréter correctement, et donc de l’utiliser comme il se doit.

      Vous n’en n’avez peut-être pas conscience, mais les types de ces programmes sont nombreux: les navigateurs classiques bien sûr, mais aussi les robots d’indexation des moteurs de recherche, les lecteurs à synthèse vocale pour les mal-voyants, les plages brailles, etc. [1]

      Des balises comme le <br /> qui indiquent un retour à la ligne apparaissent dans cette perspective plus comme une pollution qu’autre chose, puisque le retour à la ligne n’indique en fait rien du tout. De même que la “fausse” liste ne contenant qu’un seul item. Une liste est censée indiquer une énumération. Mettre une puce devant un élément unique ne sert qu’à faire joli et n’a aucun sens.

      Concernant l’utilisation de l’html, c’est un peu le même problème. La webmestre se casse le cul à faire un site conforme aux standards xhtml et les rédacteurs parsèment leurs textes de balises obsolètes comme <font color="pink"></font>...

      En bref, Spip prévoit assez de raccourcis pour mettre un texte en forme, qui respecte la charte graphique du site, la typographie et les standards du Web: pourquoi se casser la tête à “faire joli” quand ce qui compte avant tout, c’est que le texte soit accessible à tous.

      Mais je persiste à dire que la forme “dangereux” et “interdit” n’est pas très pertinente, en particulier pour toutes les personnes qui ne sont pas encore sensibilisées aux enjeux du web sémantique ou de l’accessibilité.

      “Un interdit est une condamnation visant à exclure.”
      “Un danger est une caractéristique d’une chose (...) qui peut affecter négativement l’intégrité (...) d’un individu ou d’une chose (...) Le danger est le prélude au risque lui même prélude à l’accident.”

      Pourquoi faire peur plutôt que d’expliquer les tenants et aboutissants? Si on comprend pourquoi ces usages ne sont pas recommandés, ou pas conformes, on reste libre de les utiliser ou pas. Qui peut énumérer les situations où un retour à la ligne aide le sens ou la lisibilité du texte? À chacun de trancher. Après tout, si la balise existe et que quelqu’un en a même fait un raccourci Spip, c’est bien qu’il y a des usages possibles.

    • natacham

      Je ne parviens pas à afficher mes sauts de ligne, pouvez vous m’aider ?

    • Bonjour,
      Suite à votre intervention, savez vous justement comment il faut faire si on veut + qu’une retour à la ligne et que les retours par des br ne sont pas conseillés?

      A+Isa

    • Juste pour que la question ne soit plus posé...Par défaut spip utilise la balise P. En effet, lorsque un saut de ligne est appliqué dans un article, la balise p est automatiquement “calculée”. Il suffit donc de modifier les paramètres de p dans votre feuille de style. C’est tout. p est votre amie...

    Reply to this message

  • albidochon

    Bonjour,
    Juste pour dire que l’utilisation de certaines fonctionnalités comme “pousser le texte vers le bas” peut servir pour aérer le texte, c’est à dire permettre une respiration visuelle après un long paragraphe, et rendre moins rébarbatif un texte long.

    Quand à la liste unique, elle peut avoir comme utilité sémantique de pointer du doigt un élément important qu’on a pas envie de mettre en lumière autrement.

    Nous ne sommes pas que des moutons et aimons user aussi d’éléments “inédits” ou “in-usuels” pour exprimer notre écrit.
    Ceci pourrait être longuement développé, mais faisons court....

    Reply to this message

  • 3

    Quelques petites remarques :

    • les documents joints à cet article sont titrés en anglais : c’est pas sympa, surtout pour documenter un CMS qui s’éforce de parler francophone :-(
    • petite erreur en troisième colonne : «-## une sous liste à puce» alors qu’il s’agit d’une sous-liste numérotée;
    • <code> n’est pas nécessairement un élément de type bloc.

    Sinon bravo : c’est un beau récapitulatif, clair, net et complet !

    • merci romy pour ces remarques que j’ai intégré en mettant à jour les documents joints.

      les documents sont aussi maintenant disponibles sur la zone.
      Libre à chacun de les compléter : http://zone.spip.org/trac/spip-zone...

    • Oups, chu désolée parce que je ne m’en rends compte qu’après coup : <del> c’est aussi un raccourci SPIP ???

    • Bon, j’avoue, <del> n’est pas un raccourcis officiel de SPIP : c’est du HTML.

      Mais c’est tellement standard dans les wiki (dotclear par exemple avec lequel Tristant Nitot de standblog.org fait beaucoup de lapsus avec <del>) que j’ai estimé plus simple de le considérer comme un raccourcis de SPIP et de zapper que c’est en fait du HTML.

      Alors, chut !

    Reply to this message

  • natacham

    Lorsque je saute une ligne dans la rédaction sous espace privé, cela n’apparait pas en ligne. Que dois je faire ?

    Reply to this message

  • Bonjour

    Le raccourci lien avec bulle :

    [texte du lien|Le site officiel de SPIP->http://www.spip.net/] 

    ne passe pas avec la 1.8.3.
    Le lien en front donne :

    <a href="http://www.spip.net/" class="spip_out">texte du lien|Le site officiel de SPIP</a>

    Avez vous confirmation de ça ?
    Merci
    Phil

    Reply to this message

  • Merci ! Ca en aidera plus d’un ! C’est particulièrement clair comme présentation ! ;)

    Reply to this message

  • 1

    Est-ce que ces raccourcis fonctionnent avec toutes les versions de SPIP ?

    J’utilise 1.8.3 et je n’arrive pas à faire des cellules fusionnées dans les tableaux, que ce soit avec |<| ou en laissant plus d’espaces | < |.

    Par ailleurs, la première puce dans une cellule de tableau ne prend pas le format normal d’une liste à puces, mais les éléments suivants eux le prenne. Une idée pour harmoniser une liste dans une cellule de tableau ?

    • La fusion de cellules est apparue en 1.9.

      Et pour les listes à puces dans un tableau, il faut faire :

      | 
      -* liste à puce
      -* la suite
      
       |

      Ce qui donne :

      • liste à puce
      • la suite

      Attention : il y a un espace après le 1er | et un autre espace avant le dernier |

    Reply to this message

  • Pierre Stegen

    Bravo pour la clarté des explications ...
    Je place de ce pas un lien vers cette contribution afin d’aider les futurs rédacteurs de mon site ;-)

    Reply to this message

Add a comment

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Who are you?
[Log in]

To show your avatar with your message, register it first on gravatar.com (free et painless) and don’t forget to indicate your Email addresse here.

Enter your comment here

This form accepts SPIP shortcuts {{bold}} {italic} -*list [text->url] <quote> <code> and HTML code <q> <del> <ins>. To create paragraphs, just leave empty lines.

Add a document

Follow the comments: RSS 2.0 | Atom