[spip-dev] Réflexion sur les syntaxes de rédaction

Dev
1

Hello

J'avais animé un atelier de réflexion sur les interfaces de rédaction, lors de la dernière rencontre SPIP, à Brest fin 2013, au cours duquel les participant·e·s ont étudié les syntaxes existantes puis en ont élaboré une idéale. J'attends de reconduire l'atelier une dernière fois, avec un dernier panel d'utilisateur·ice·s, avant d'en publier un compte-rendu global.

En attendant, puisque certain·e·s le demandaient, voici quelques articles qui partagent la réflexion préalable sur les interfaces de rédaction :

Mieux qu’une barre d’édition : des raccourcis
http://romy.tetue.net/1035

What you see is what you… ?
http://romy.tetue.net/1057

Pour rédiger : les syntaxes légères
http://romy.tetue.net/1055

Comparaison des syntaxes SPIP et Markdown
http://romy.tetue.net/1056

À bientôt pour la suite !

-- tetue

2

Bonjour,

Comparaison des syntaxes SPIP et Markdown
http://romy.tetue.net/1056

Extraits de ce texte fort exhaustif :

Dans SPIP, il n’existe qu’un seul niveau de titre par défaut, dit « intertitre », ce qui, il faut bien le reconnaître, est souvent tout à fait suffisant, mais qui a le défaut d’être de niveau 3 (au lieu de 2 — le titre de niveau précédent étant le premier, traditionnellement réservé au titre de la page). Markdown propose des titres de niveau 1 à 6, avec des variantes syntaxiques plus naturelles.
Les listes SPIP ont le défaut de ne permettre qu’une ligne de texte par item, ce qui est très limité par rapport à Markdown, qui accepte plusieurs paragraphes et autres blocs de code, citation, etc.

Étant amené à fréquemment rédiger des pages de documentation technique, je partage cette opinion sur les principales lacunes du langage Spip : les titres et les items de listes à plusieurs paragraphes.

Quelques remarques complémentaires :

- je trouve la syntaxe des titres Markdown à base de '###' moins lisible et moins intuitive que les '===' des langages Wiki. Quitte à vouloir améliorer les choses, ça me paraît une piste plus intéressante;

- dans le monde informatique, on trouve souvent le symbole '#' sémantiquement associé à deux notions, les commentaires de code (assembleur, shell...) et les numérotations (cf. les listes numérotées Spip -#). Il me paraîtrait intéressant de lui conserver ce second rôle en l'étendant aux titres. Ainsi, '===#' symboliserait un titre numéroté de niveau 3. Vaste sujet qui mérite une discussion plus approfondie...

- d'un point de vue franco-français (ou plutôt Azertyuio-Azerty), les caractères '{}#\' nécessitent l'usage de la touche 'Alt-Gr', beaucoup moins pratique que le classique "Shift" tant par sa disposition au centre-droit du clavier, près de la barre d'espace, que par son unicité. C'est un inconvénient car ça ralentit la frappe. Bien sûr, on ne peut pas pas l'éviter complètement mais autant limiter son usage autant que possible. Pour la même raison, les syntaxes **gras** ou _italiques_ sont très appréciables.

Il y a une discussion quelque part sur ce sujet ?

Christian Marget

3

Salut,

4

Yo !

Bonjour,

Comparaison des syntaxes SPIP et Markdown
http://romy.tetue.net/1056

Extraits de ce texte fort exhaustif :

Dans SPIP, il n’existe qu’un seul niveau de titre par défaut, dit « intertitre », ce qui, il faut bien le reconnaître, est souvent tout à fait suffisant, mais qui a le défaut d’être de niveau 3 (au lieu de 2 — le titre de niveau précédent étant le premier, traditionnellement réservé au titre de la page). Markdown propose des titres de niveau 1 à 6, avec des variantes syntaxiques plus naturelles.
Les listes SPIP ont le défaut de ne permettre qu’une ligne de texte par item, ce qui est très limité par rapport à Markdown, qui accepte plusieurs paragraphes et autres blocs de code, citation, etc.

Étant amené à fréquemment rédiger des pages de documentation technique, je partage cette opinion sur les principales lacunes du langage Spip : les titres et les items de listes à plusieurs paragraphes.

Quelques remarques complémentaires :

- je trouve la syntaxe des titres Markdown à base de '###' moins lisible et moins intuitive que les '===' des langages Wiki. Quitte à vouloir améliorer les choses, ça me paraît une piste plus intéressante;

Tu n'es pas le seul à faire cette même remarque !

D'expérience — je rédige toute ma correspondance, y compris pro et/ou néophytes, en syntaxe légère depuis qq années, ce qui me donne un retour UX sur la lisibilité — je plussoie : les titres signalés par des « == » sont intuitivement compris comme tels, alors que les « ## » posent parfois question.

- dans le monde informatique, on trouve souvent le symbole '#' sémantiquement associé à deux notions, les commentaires de code (assembleur, shell...) et les numérotations (cf. les listes numérotées Spip -#). Il me paraîtrait intéressant de lui conserver ce second rôle en l'étendant aux titres. Ainsi, '===#' symboliserait un titre numéroté de niveau 3. Vaste sujet qui mérite une discussion plus approfondie...

Oui, c'est une piste à creuser, expérimenter.

- d'un point de vue franco-français (ou plutôt Azertyuio-Azerty), les caractères '{}#\' nécessitent l'usage de la touche 'Alt-Gr', beaucoup moins pratique que le classique "Shift" tant par sa disposition au centre-droit du clavier, près de la barre d'espace, que par son unicité. C'est un inconvénient car ça ralentit la frappe. Bien sûr, on ne peut pas pas l'éviter complètement mais autant limiter son usage autant que possible. Pour la même raison, les syntaxes **gras** ou _italiques_ sont très appréciables.

Il y a une discussion quelque part sur ce sujet ?

Les commentaires sous l'article sont là pour ça…
(tu peux y reproduire ton message, pour partager la réflexion)

Merci pour tes retours !

-- tetue

5

Bof…

6

Bonjour Christian,

Pas facile a retrouver dans la doc, mais une solution existe déjà :
voir: Un sommaire pour vos articles - SPIP-Contrib
cdlt
YannX

Bonjour,

Comparaison des syntaxes SPIP et Markdown
http://romy.tetue.net/1056

Extraits de ce texte fort exhaustif :

Dans SPIP, il n’existe qu’un seul niveau de titre par défaut, dit « intertitre », ce qui, il faut bien le reconnaître, est souvent tout à fait suffisant, mais qui a le défaut d’être de niveau 3 (au lieu de 2 — le titre de niveau précédent étant le premier, traditionnellement réservé au titre de la page). Markdown propose des titres de niveau 1 à 6, avec des variantes syntaxiques plus naturelles.
Les listes SPIP ont le défaut de ne permettre qu’une ligne de texte par item, ce qui est très limité par rapport à Markdown, qui accepte plusieurs paragraphes et autres blocs de code, citation, etc.

Étant amené à fréquemment rédiger des pages de documentation technique, je partage cette opinion sur les principales lacunes du langage Spip : les titres et les items de listes à plusieurs paragraphes.

C'est difficile a retrouver dans la documentation, mais savez-vous que le CS (</no_troll> :wink:
permet plusieurs niveaux d'intertitre (d'après la syntaxe de Mortimer :
Un sommaire pour vos articles - SPIP-Contrib {{{**....