Journal Du XML, du HTML et du SVG dans les RFC

Posté par (page perso) . Licence CC by-sa.
Tags :
19
10
oct.
2019

L'IETF a pour très longue tradition de fournir ses RFC en mode texte (du pur ASCII 7-bit).
Mais bon, les technologies évoluent, et IETF touche maintenant bien plus que des octets simplement ordonnés, il touche de nos jours autant à la crypto qu'aux formats de compression audio et vidéo. Et du coup, ça pourrait être sympa de présenter les principes mathématiques sous-jacents et autres en autre chose que de l'ASCII.
En 2016 l'IETF a sorti une RFC "HTML Format for RFCs" et autres RFC autour de "rfc2html", qui utilisent XML comme format d'entrée pour pouvoir diffuser en texte (toujours :) ), HTML ou PDF. Mais ensuite il faut adapter les outils tout ça… Autant les outils pour créer le XML en entrée que les outils pour faire les nouveaux formats de sortie.

Et quitte à tenter de sortir une RFC, si on tentait au passage de sortir nos brouillons de RFC avec ces nouvelles possibilités? L'IETF a fait sa part en adaptant son tracker, essayons donc de voir ce qu'on peut faire avec nos maths.

Par exemple :
HTML
a plus de classe et est plus compréhensible (enfin… Pour les amateurs de maths) que :
ASCII

Bon, je préviens, ça n'a pas été facile : quelques bugs à contourner pour le moment sur le tracker IETF, des conversions à mettre en place (notre source à nous n'est pas du XML, mais du Markdown), gérer le "fallback" en ASCII… Mais un super collègue friand de scripts et de bidouilles a fait un super travail d'adaptation. Du coup notre Markdown et un peu moche car il y a des hacks pour sortir un XML qui fera de jolies choses quand ensuite transformé en texte ou HTML ou PDF, mais comme notre cible est l'IETF c'est pour nous acceptable.

Et voila! on a un draft RFC dans un format moderne! Avec des sortie HTML (avec un sommaire sur la droite par défaut), texte et PDF.
Si vous êtes intéressés par tenter de reproduire, voila les scripts qu'on a utilisé pour créer le fichier XML à donner au tracker IETF, et vous pouvez tester votre XML avec xml2rfc en web.

  • # one_s tate

    Posté par . Évalué à 7 (+5/-0). Dernière modification le 10/10/19 à 19:58.

    Où l’on voit que la syntax à la "LaTeX" doit être rigoureusement vérifiée :

    zero_state

    est rendu différemment de

    one_state

    Tu partagerais le code pour voir où ça a loupé ?

    (je passe outre mon dégoût personnel pour le rendu des mots balancés non protégés dans un environnement mathématique et qui apparaissent par défaut en italique)

    • [^] # Re: one_s tate

      Posté par (page perso) . Évalué à 3 (+3/-2). Dernière modification le 10/10/19 à 21:24.

      Je ne te remercie pas ;-), j'ai la honte maintenant avec mon exemple. Et impressionnant pour moi-même comment quand on a la tête dans le guidon, notre cerveau zappe ce genre d'erreur, car je faisais ma capture d'écran tranquille…
      La capture d'écran vient de la section Range binary values (GitHub trafiquant l'affichage du Markdown, vaut mieux passer en affichage "raw" mais du coup plus de lien sur la section), je vois un oubli de double échappement (ouais, super les doubles échappements…) du underscore, "zero\\_state\_" vs "one\_state\_" (fun : j'ai dû tripler l’échappement pour afficher la chose sur LinuxFr…).
      Si tu es motivé sur un PR de ça et/ou plein de fix que tu trouves à faire, on prend :).

Envoyer un commentaire

Suivre le flux des commentaires

Note : les commentaires appartiennent à ceux qui les ont postés. Nous n'en sommes pas responsables.