si3t.ch> cd /


gmi2xhtml v12 : tag code supporté

EDIT : entourer le code de "''" était une très mauvaise idée. J'ai viré cette fonctionnalité. À l'avenir, je n'ai qu'à écrire une meilleure doc pour éviter les confusions.

Par hasard, j'ai découvert qu'on parlait de ma "doc" à propos d'OpenBSD sur reddit.

Cela m'a redonné l'impulsion pour y consacrer un peu de temps, surtout à la version anglaise qui était très jeune et gagnerait à être encore relue.

Par la même occasion, j'ai réfléchi à la suggestion d'utiliser des blocs de code intégrés au paragraphes : <code></code>.

Ce n'est pas prévu dans le gemtext. En effet, cela se fait par des blocs de code à part entière, l'idée étant de ne considérer que les 3 premiers caractères d'une ligne pour distinguer les différentes formes de texte.

Pour l'instant, j'utilisais des guillemets pour isoler les morceaux de code, par exemple "dmesg".

Ça fonctionne, mais peut effectivement être moins facile à lire.

Puisque ma doc contient beaucoup de code, le reproche a du poids.

J'ai donc décidé d'ajouter un élément de markup à mon convertisseur gmi2xhtml. À ce stade, ce n'est vraiment plus que du gemtext vers xhtml, mais que voulez-vous, awk permet de faire tellement avec beaucoup de facilité.

Désormais, le texte compris entre deux apostrophes sera considéré comme du code : ''echo example''.

À la lecture du gemtext brut, ce n'est pas si différent que lorsque j'utilisais des guillemets :

avant :      "echo example"
maintenant : ''echo example''

J'ai préféré la méthode de dokuwiki à celle du markdown, juste parce que les backticks ''``'' sont trop pénibles à écrire ^^.

En passant, je ne regrette VRAIMENT pas d'écrire du xhtml et non du html. Cela m'a fait gagner un temps fou car il était facile de repérer les éventuelles erreurs dans mon code : xmllint ou tout simplement Firefox l'indiquait aussitôt.

gmi2xhtml.awk.tgz

Une réaction?

Envoyez votre commentaire par mail (anonyme).

Mode d'emploi de la liste de diffusion pour recevoir les réponses.